Interface WritableOptions

interface WritableOptions {
    autoDestroy?: boolean;
    decodeStrings?: boolean;
    defaultEncoding?: BufferEncoding;
    emitClose?: boolean;
    highWaterMark?: number;
    objectMode?: boolean;
    signal?: AbortSignal;
    construct(this: Writable, callback: (error?: null | Error) => void): void;
    destroy(
        this: Writable,
        error: null | Error,
        callback: (error?: null | Error) => void,
    ): void;
    final(this: Writable, callback: (error?: null | Error) => void): void;
    write(
        this: Writable,
        chunk: any,
        encoding: BufferEncoding,
        callback: (error?: null | Error) => void,
    ): void;
    writev(
        this: Writable,
        chunks: { chunk: any; encoding: BufferEncoding }[],
        callback: (error?: null | Error) => void,
    ): void;
}

Hierarchy (View Summary)

Properties

autoDestroy? decodeStrings? defaultEncoding? emitClose? highWaterMark? objectMode? signal?

Methods

construct? destroy? final? write? writev?

Properties

OptionalautoDestroy

autoDestroy?: boolean

OptionaldecodeStrings

decodeStrings?: boolean

OptionaldefaultEncoding

defaultEncoding?: BufferEncoding

OptionalemitClose

emitClose?: boolean

OptionalhighWaterMark

highWaterMark?: number

OptionalobjectMode

objectMode?: boolean

Optionalsignal

signal?: AbortSignal

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

Methods

Optionalconstruct

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

  • Parameters

    • this: Writable
    • callback: (error?: null | Error) => void

    Returns void

Optionaldestroy

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

  • Parameters

    • this: Writable
    • error: null | Error
    • callback: (error?: null | Error) => void

    Returns void

Optionalfinal

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

  • Parameters

    • this: Writable
    • callback: (error?: null | Error) => void

    Returns void

Optionalwrite

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

  • Parameters

    Returns void

Optionalwritev

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

  • Parameters

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods