Interface WritableOptions<T>

interface WritableOptions<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;
    decodeStrings?: boolean;
    defaultEncoding?: BufferEncoding;
    write?: ((this: T, chunk: any, encoding: BufferEncoding, callback: ((error?: null | Error) => void)) => void);
    writev?: ((this: T, chunks: {
        chunk: any;
        encoding: BufferEncoding;
    }[], callback: ((error?: null | Error) => void)) => void);
    final?: ((this: T, callback: ((error?: null | Error) => void)) => void);
}

Type Parameters

Hierarchy (view full)

Properties

signal? emitClose? highWaterMark? objectMode? construct? destroy? autoDestroy? decodeStrings? defaultEncoding? write? writev? final?

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

OptionaldecodeStrings

decodeStrings?: boolean

OptionaldefaultEncoding

defaultEncoding?: BufferEncoding

Optionalwrite

write?: ((this: T, chunk: any, encoding: BufferEncoding, callback: ((error?: null | Error) => void)) => void)

Optionalwritev

writev?: ((this: T, chunks: {
    chunk: any;
    encoding: BufferEncoding;
}[], callback: ((error?: null | Error) => void)) => void)

Optionalfinal

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

Settings

Member Visibility

On This Page

Properties