Class Transform<IsAsync>Abstract

Abstract Readonlyevents

closed

• get closed(): boolean

  Returns boolean

pullable

• get pullable(): boolean

  Returns boolean

close

• close(): void

  Returns void

destroyDumpQueue

• destroyDumpQueue(): MaybePromise<Uint8Array<ArrayBufferLike>[], IsAsync>

  Close the stream, and return all of the queued data

  Returns MaybePromise<Uint8Array<ArrayBufferLike>[], IsAsync>

pull

• pull(ideal: number): MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync>

  Grab some data from the stream.

  Parameters

  • ideal: number

    The ideal amount of data. Implementers should ignore this if there data is chunked, and instead give the whole chunk. If they do not yet have a full chunk, give what you have.

  Returns MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync>

  Uint8Array containing the data, but if there will be more data, there just is not yet, AND the stream is sync, it will give undefined.