Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WriteableStream<T>

A interface that emulates the API shape of a node.js writeable stream for use in desktop and web environments.

Type parameters

  • T

Hierarchy

Implemented by

Index

Methods

destroy

  • destroy(): void

end

  • end(result?: T | Error): void
  • Signals the end of the stream to the consumer. If the result is not an error, will trigger the on('data') event listener if the stream is flowing and buffer the data otherwise until the stream is flowing.

    In case of an error, the on('error') event will be used if the stream is flowing.

    Parameters

    • Optional result: T | Error

    Returns void

error

  • error(error: Error): void

on

  • on(event: "data", callback: (data: T) => void): void
  • on(event: "error", callback: (err: Error) => void): void
  • on(event: "end", callback: () => void): void

pause

  • pause(): void

removeListener

  • removeListener(event: string, callback: Function): void

resume

  • resume(): void

write

  • write(data: T): void | Promise<void>
  • Writing data to the stream will trigger the on('data') event listener if the stream is flowing and buffer the data otherwise until the stream is flowing.

    If a highWaterMark is configured and writing to the stream reaches this mark, a promise will be returned that should be awaited on before writing more data. Otherwise there is a risk of buffering a large number of data chunks without consumer.

    Parameters

    • data: T

    Returns void | Promise<void>