Interface ReadableOptions

interface ReadableOptions {
    autoDestroy?: boolean;
    emitClose?: boolean;
    encoding?: BufferEncoding;
    highWaterMark?: number;
    objectMode?: boolean;
    signal?: AbortSignal;
    construct?(this, callback): void;
    destroy?(this, error, callback): void;
    read?(this, size): void;
}

Hierarchy (view full)

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: Readable
    • callback: ((error?) => void)
        • (error?): void
        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

  • Parameters

    • this: Readable
    • error: null | Error
    • callback: ((error?) => void)
        • (error?): void
        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

  • Parameters

    Returns void

Generated using TypeDoc