Class Stream<T>

constructor

• new Stream<T>(options?: StreamOptions & { onClose?: () => void }): Stream<T>

  Type Parameters

  • T

  Parameters

  • options: StreamOptions & { onClose?: () => void } = {}

  Returns Stream<T>

dropped

buffered

• get buffered(): number

  Number of values currently buffered for async-iterator consumers.

  Returns number

isClosed

• get isClosed(): boolean

  true once the stream has been closed (by Stream.close/Stream.end/Stream.fail).

  Returns boolean

[asyncIterator]

• "[asyncIterator]"(): AsyncIterator<T>

  Returns AsyncIterator<T>

close

• close(): void

  Alias for Stream.end — stop the underlying source and close.

  Returns void

destroy

• destroy(error: Error): void

  Close the stream with a terminal error, rejecting any parked async iterators.

  Parameters

  • error: Error

  Returns void

end

• end(): void

  Gracefully end the stream: iterators drain the buffer then complete.

  Returns void

fail

• fail(error: Error): void

  Emit an error to 'error' listeners. Does not close the stream (transient errors keep the stream alive).

  Parameters

  • error: Error

  Returns void

off

• off(event: "data", listener: Listener<T>): void

  Remove a previously-added listener.

  Parameters

  • event: "data"
  • listener: Listener<T>

  Returns void

• off(event: "error", listener: ErrorListener): void

  Remove a previously-added listener.

  Parameters

  • event: "error"
  • listener: ErrorListener

  Returns void

• off(event: "close", listener: () => void): void

  Remove a previously-added listener.

  Parameters

  • event: "close"
  • listener: () => void

  Returns void

on

• on(event: "data", listener: Listener<T>): () => void

  Subscribe to values ('data'), errors ('error'), or close ('close'). Returns an unsubscribe fn.

  Parameters

  • event: "data"
  • listener: Listener<T>

  Returns () => void

• on(event: "error", listener: ErrorListener): () => void

  Subscribe to values ('data'), errors ('error'), or close ('close'). Returns an unsubscribe fn.

  Parameters

  • event: "error"
  • listener: ErrorListener

  Returns () => void

• on(event: "close", listener: () => void): () => void

  Subscribe to values ('data'), errors ('error'), or close ('close'). Returns an unsubscribe fn.

  Parameters

  • event: "close"
  • listener: () => void

  Returns () => void

push

• push(value: T): void

  Push a value to every listener and the async-iterator buffer. No-op once closed.

  Parameters

  • value: T

  Returns void