Interface TransformOptions<T>

interface TransformOptions<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);
    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);
    allowHalfOpen?: boolean;
    readableObjectMode?: boolean;
    writableObjectMode?: boolean;
    readableHighWaterMark?: number;
    writableHighWaterMark?: number;
    writableCorked?: number;
    transform?: ((this: T, chunk: any, encoding: BufferEncoding, callback: TransformCallback) => void);
    flush?: ((this: T, callback: TransformCallback) => void);
}

Type Parameters

Hierarchy (view full)

Properties

signal? emitClose? highWaterMark? objectMode? construct? destroy? autoDestroy? encoding? read? decodeStrings? defaultEncoding? write? writev? final? allowHalfOpen? readableObjectMode? writableObjectMode? readableHighWaterMark? writableHighWaterMark? writableCorked? transform? flush?

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)

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)

OptionalallowHalfOpen

allowHalfOpen?: boolean

OptionalreadableObjectMode

readableObjectMode?: boolean

OptionalwritableObjectMode

writableObjectMode?: boolean

OptionalreadableHighWaterMark

readableHighWaterMark?: number

OptionalwritableHighWaterMark

writableHighWaterMark?: number

OptionalwritableCorked

writableCorked?: number

Optionaltransform

transform?: ((this: T, chunk: any, encoding: BufferEncoding, callback: TransformCallback) => void)

Optionalflush

flush?: ((this: T, callback: TransformCallback) => void)

Settings

Member Visibility

On This Page

Properties