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? emitClose? encoding? highWaterMark? objectMode? signal?

Methods

construct? destroy? read?

Properties

Optional autoDestroy

autoDestroy?: boolean

Optional emitClose

emitClose?: boolean

Optional encoding

encoding?: BufferEncoding

Optional highWaterMark

highWaterMark?: number

Optional objectMode

objectMode?: boolean

Optional signal

signal?: AbortSignal

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

Methods

Optional construct

  • construct(this, callback): void

  • Parameters

    • this: Readable
    • callback: ((error?) => void)
        • (error?): void

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Optional destroy

  • destroy(this, error, callback): void

  • Parameters

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

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Optional read

  • read(this, size): void

  • Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc