Interface ReadableOptions<T>

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

Type Parameters

Hierarchy (View Summary)

Properties

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

Methods

construct? destroy? read?

Properties

OptionalautoDestroy

autoDestroy?: boolean

OptionalemitClose

emitClose?: boolean

Optionalencoding

encoding?: BufferEncoding

OptionalhighWaterMark

highWaterMark?: number

OptionalobjectMode

objectMode?: boolean

Optionalsignal

signal?: AbortSignal

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

Methods

Optionalconstruct

  • construct(this: T, callback: (error?: null | Error) => void): void

    Parameters

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

    Returns void

Optionaldestroy

  • destroy(
        this: T,
        error: null | Error,
        callback: (error?: null | Error) => void,
    ): void

    Parameters

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

    Returns void

Optionalread

  • read(this: T, size: number): void

    Parameters

    • this: T
    • size: number

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods