Interface Pushable<T, R, N>

An iterable that you can push values into.

Type Parameters

T
R = void
N = unknown

Hierarchy

AsyncGenerator<T, R, N>
BasePushable<T>
- Pushable

Index

Properties

Methods

[asyncIterator] end next onEmpty push return throw

Properties

readableLength

readableLength: number

This property contains the number of bytes (or objects) in the queue ready to be read.

If objectMode is true, this is the number of objects in the queue, if false it's the total number of bytes in the queue.

Methods

[asyncIterator]

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

end

end(err?): Pushable<T, R, N>
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
- Optional err: Error
Returns Pushable<T, R, N>
Inherited from BasePushable.end
- Defined in src/index.ts:74

next

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

onEmpty

onEmpty(options?): Promise<void>
Returns a promise that resolves when the underlying queue becomes empty (e.g. this.readableLength === 0).

If an AbortSignal is passed as an option and that signal aborts, it only causes the returned promise to reject - it does not end the pushable.
Parameters
- Optional options: AbortOptions
Returns Promise<void>
Inherited from BasePushable.onEmpty
- Defined in src/index.ts:89

push

push(value): Pushable<T, R, N>
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
Returns Pushable<T, R, N>
Inherited from BasePushable.push
- Defined in src/index.ts:80

return

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

throw

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

Generated using TypeDoc