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, callback): void;
    destroy?(this, error, callback): void;
    final?(this, callback): void;
    flush?(this, callback): void;
    read?(this, size): void;
    transform?(this, chunk, encoding, callback): void;
    write?(this, chunk, encoding, callback): void;
    writev?(this, chunks, callback): void;
}

Hierarchy (view full)

Properties

allowHalfOpen? autoDestroy? decodeStrings? defaultEncoding? emitClose? encoding? highWaterMark? objectMode? readableHighWaterMark? readableObjectMode? signal? writableCorked? writableHighWaterMark? writableObjectMode?

Methods

construct? destroy? final? flush? read? transform? write? writev?

Properties

Optional allowHalfOpen

allowHalfOpen?: boolean

Optional autoDestroy

autoDestroy?: boolean

Optional decodeStrings

decodeStrings?: boolean

Optional defaultEncoding

defaultEncoding?: BufferEncoding

Optional emitClose

emitClose?: boolean

Optional encoding

encoding?: BufferEncoding

Optional highWaterMark

highWaterMark?: number

Optional objectMode

objectMode?: boolean

Optional readableHighWaterMark

readableHighWaterMark?: number

Optional readableObjectMode

readableObjectMode?: boolean

Optional signal

signal?: AbortSignal

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

Optional writableCorked

writableCorked?: number

Optional writableHighWaterMark

writableHighWaterMark?: number

Optional writableObjectMode

writableObjectMode?: boolean

Methods

Optional construct

  • construct(this, callback): void

  • Parameters

    Returns void

Optional destroy

  • destroy(this, error, callback): void

  • Parameters

    Returns void

Optional final

  • final(this, callback): void

  • Parameters

    Returns void

Optional flush

  • flush(this, callback): void

  • Parameters

    Returns void

Optional read

  • read(this, size): void

  • Parameters

    Returns void

Optional transform

Optional write

  • write(this, chunk, encoding, callback): void

  • Parameters

    Returns void

Optional writev

  • writev(this, chunks, callback): void

  • Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

allowHalfOpenautoDestroydecodeStringsdefaultEncodingemitCloseencodinghighWaterMarkobjectModereadableHighWaterMarkreadableObjectModesignalwritableCorkedwritableHighWaterMarkwritableObjectModeconstructdestroyfinalflushreadtransformwritewritev