Interface Pushable<T>

interface Pushable<T> {
    "[asyncIterator]"(): AsyncGenerator<T, void, unknown>;
    end(err?: Error, options?: AbortOptions & RaceSignalOptions): Promise<void>;
    next(
        ...__namedParameters: [] | [unknown],
    ): Promise<IteratorResult<T, void>>;
    push(value: T, options?: AbortOptions & RaceSignalOptions): Promise<void>;
    return(value: void | PromiseLike<void>): Promise<IteratorResult<T, void>>;
    throw(e: any): Promise<IteratorResult<T, void>>;
}

Type Parameters

T

Hierarchy

AsyncGenerator<T, void, unknown>
- Pushable

Index

Methods

[asyncIterator] end next push return throw

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncGenerator<T, void, unknown>
Returns AsyncGenerator<T, void, unknown>
Inherited from AsyncGenerator.[asyncIterator]
- Defined in node_modules/typescript/lib/lib.es2018.asyncgenerator.d.ts:26

end

end(err?: Error, options?: AbortOptions & RaceSignalOptions): Promise<void>
End the iterable after all values in the buffer (if any) have been yielded. If an error is passed the buffer is cleared immediately and the next iteration will throw the passed error
Parameters
- Optionalerr: Error
- Optionaloptions: AbortOptions & RaceSignalOptions
Returns Promise<void>
- Defined in packages/it-queueless-pushable/src/index.ts:42

next

next(...__namedParameters: [] | [unknown]): Promise<IteratorResult<T, void>>
Parameters
- ...__namedParameters: [] | [unknown]
Returns Promise<IteratorResult<T, void>>
Inherited from AsyncGenerator.next
- Defined in node_modules/typescript/lib/lib.es2018.asyncgenerator.d.ts:23

push

push(value: T, options?: AbortOptions & RaceSignalOptions): Promise<void>
Push a value into the iterable. Values are yielded from the iterable in the order they are pushed. Values not yet consumed from the iterable are buffered.
Parameters
- value: T
- Optionaloptions: AbortOptions & RaceSignalOptions
Returns Promise<void>
- Defined in packages/it-queueless-pushable/src/index.ts:48

return

return(value: void | PromiseLike<void>): Promise<IteratorResult<T, void>>
Parameters
- value: void | PromiseLike<void>
Returns Promise<IteratorResult<T, void>>
Inherited from AsyncGenerator.return
- Defined in node_modules/typescript/lib/lib.es2018.asyncgenerator.d.ts:24

throw

throw(e: any): Promise<IteratorResult<T, void>>
Parameters
- e: any
Returns Promise<IteratorResult<T, void>>
Inherited from AsyncGenerator.throw
- Defined in node_modules/typescript/lib/lib.es2018.asyncgenerator.d.ts:25