Interface WritableOptions<T>

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

Type Parameters

Hierarchy (view full)

Properties

autoDestroy?: boolean
decodeStrings?: boolean
defaultEncoding?: BufferEncoding
emitClose?: boolean
highWaterMark?: number
objectMode?: boolean
signal?: AbortSignal

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

Methods

  • Parameters

    • this: T
    • callback: Object

    Returns void

  • Parameters

    • this: T
    • error: Error
    • callback: Object

    Returns void

  • Parameters

    • this: T
    • callback: Object

    Returns void

  • Parameters

    Returns void

  • Parameters

    • this: T
    • chunks: {
          chunk: any;
          encoding: BufferEncoding;
      }[]
    • callback: Object

    Returns void