Interface ReadableOptions<T>

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

Type Parameters

Hierarchy (view full)

Properties

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

Optionalconstruct

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

Optionaldestroy

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

OptionalautoDestroy

autoDestroy?: boolean

Optionalencoding

encoding?: BufferEncoding

Optionalread

read?: ((this: T, size: number) => void)

Settings

Member Visibility

On This Page

Properties