StreamHelper
Defined in: src/util/types.ts:223
Helper interface for generic streaming operations. Provides methods to write data, pipe streams, and handle abort events.
Methods
Section titled “Methods”onAbort()
Section titled “onAbort()”onAbort(
callback):void
Defined in: src/util/types.ts:243
Register a callback to be executed when the stream is aborted.
Parameters
Section titled “Parameters”callback
Section titled “callback”() => void
Callback function
Returns
Section titled “Returns”void
pipe()
Section titled “pipe()”pipe(
stream):Promise<void>
Defined in: src/util/types.ts:233
Pipe a ReadableStream to this stream.
Parameters
Section titled “Parameters”stream
Section titled “stream”ReadableStream
ReadableStream to pipe
Returns
Section titled “Returns”Promise<void>
sleep()
Section titled “sleep()”sleep(
ms):Promise<void>
Defined in: src/util/types.ts:238
Sleep for a specified duration.
Parameters
Section titled “Parameters”number
Milliseconds to sleep
Returns
Section titled “Returns”Promise<void>
write()
Section titled “write()”write(
data):Promise<void>
Defined in: src/util/types.ts:228
Write data to the stream.
Parameters
Section titled “Parameters”Data to write (Uint8Array or string, strings are auto-encoded to UTF-8)
string | Uint8Array<ArrayBufferLike>
Returns
Section titled “Returns”Promise<void>