Interface ReadableOptions

Hierarchy

Properties

autoDestroy?: boolean
emitClose?: boolean
encoding?: BufferEncoding
highWaterMark?: number
objectMode?: boolean
signal?: AbortSignal

When provided the corresponding AbortController can be used to cancel an asynchronous action.

Methods

  • Parameters

    • this: "stream".Readable<any>
    • callback: ((error?: Error) => void)
        • (error?: Error): void
        • Parameters

          • Optional error: Error

          Returns void

    Returns void

  • Parameters

    • this: "stream".Readable<any>
    • error: Error
    • callback: ((error: Error) => void)
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns void

Generated using TypeDoc