Interface WritableOptions<T>

interface WritableOptions<T> {
    autoDestroy?: boolean;
    decodeStrings?: boolean;
    defaultEncoding?: BufferEncoding;
    emitClose?: boolean;
    highWaterMark?: number;
    objectMode?: boolean;
    signal?: AbortSignal;
    construct?(this, callback): void;
    destroy?(this, error, callback): void;
    final?(this, callback): void;
    write?(this, chunk, encoding, callback): void;
    writev?(this, chunks, callback): void;
}

Type Parameters

Hierarchy (view full)

Properties

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

Methods

construct? destroy? final? write? writev?

Properties

Optional autoDestroy

autoDestroy?: boolean

Optional decodeStrings

decodeStrings?: boolean

Optional defaultEncoding

defaultEncoding?: BufferEncoding

Optional emitClose

emitClose?: boolean

Optional highWaterMark

highWaterMark?: number

Optional objectMode

objectMode?: boolean

Optional signal

signal?: AbortSignal

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

Methods

Optional construct

  • construct(this, callback): void

  • Parameters

    • this: T
    • callback: ((error?) => void)
        • (error?): void

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Optional destroy

  • destroy(this, error, callback): void

  • Parameters

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

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Optional final

  • final(this, callback): void

  • Parameters

    • this: T
    • callback: ((error?) => void)
        • (error?): void

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Optional write

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

  • Parameters

    • this: T
    • chunk: any
    • encoding: BufferEncoding
    • callback: ((error?) => void)
        • (error?): void

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Optional writev

  • writev(this, chunks, callback): void

  • Parameters

    • this: T
    • chunks: {
          chunk: any;
          encoding: BufferEncoding;
      }[]
    • callback: ((error?) => void)
        • (error?): void

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Settings

Member Visibility

Theme

On This Page