Interface ReadableOptions

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

Hierarchy (view full)

Properties

signal? emitClose? highWaterMark? objectMode? autoDestroy? encoding?

Methods

construct? destroy? read?

Properties

Optionalsignal

signal?: AbortSignal

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

OptionalemitClose

emitClose?: boolean

OptionalhighWaterMark

highWaterMark?: number

OptionalobjectMode

objectMode?: boolean

OptionalautoDestroy

autoDestroy?: boolean

Optionalencoding

encoding?: BufferEncoding

Methods

Optionalconstruct

  • construct(this, callback): void

  • Parameters

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

        • Parameters

          • Optionalerror: Error

          Returns void

    Returns void

Optionaldestroy

  • destroy(this, error, callback): void

  • Parameters

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

        • Parameters

          • Optionalerror: Error

          Returns void

    Returns void

Optionalread

  • read(this, size): void

  • Parameters

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods