Interface TransformOptions

interface TransformOptions {
    allowHalfOpen?: boolean;
    autoDestroy?: boolean;
    decodeStrings?: boolean;
    defaultEncoding?: BufferEncoding;
    emitClose?: boolean;
    encoding?: BufferEncoding;
    highWaterMark?: number;
    objectMode?: boolean;
    readableHighWaterMark?: number;
    readableObjectMode?: boolean;
    signal?: AbortSignal;
    writableCorked?: number;
    writableHighWaterMark?: number;
    writableObjectMode?: boolean;
    construct?(this: Transform, callback: Object): void;
    destroy?(this: Transform, error: Error, callback: Object): void;
    final?(this: Transform, callback: Object): void;
    flush?(this: Transform, callback: TransformCallback): void;
    read?(this: Transform, size: number): void;
    transform?(this: Transform, chunk: any, encoding: BufferEncoding, callback: TransformCallback): void;
    write?(this: Transform, chunk: any, encoding: BufferEncoding, callback: Object): void;
    writev?(this: Transform, chunks: {
        chunk: any;
        encoding: BufferEncoding;
    }[], callback: Object): void;
}

Hierarchy (view full)

Properties

allowHalfOpen?: boolean
autoDestroy?: boolean
decodeStrings?: boolean
defaultEncoding?: BufferEncoding
emitClose?: boolean
encoding?: BufferEncoding
highWaterMark?: number
objectMode?: boolean
readableHighWaterMark?: number
readableObjectMode?: boolean
signal?: AbortSignal

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

writableCorked?: number
writableHighWaterMark?: number
writableObjectMode?: boolean

Methods

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void