Interface WritableOptions

Hierarchy

<internal>.internal.StreamOptions<<internal>.Writable>
- WritableOptions

Index

Properties

Methods

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?: <internal>.AbortSignal

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

Methods

Optional construct

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

Inherited from StreamOptions.construct
- Defined in node_modules/@types/node/stream.d.ts:39
Parameters
- this: <internal>.Writable
- callback: (error?: null | <internal>.Error) => void
  - - (error?: null | <internal>.Error): void
    - Parameters
      - Optional error: null | <internal>.Error
      Returns void
Returns void

Optional destroy

destroy(this: <internal>.Writable, error: null | <internal>.Error, callback: (error: null | <internal>.Error) => void): void

Inherited from StreamOptions.destroy
- Defined in node_modules/@types/node/stream.d.ts:40
Parameters
- this: <internal>.Writable
- error: null | <internal>.Error
- callback: (error: null | <internal>.Error) => void
  - - (error: null | <internal>.Error): void
    - Parameters
      - error: null | <internal>.Error
      Returns void
Returns void

Optional final

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

- Defined in node_modules/@types/node/stream.d.ts:493
Parameters
- this: <internal>.Writable
- callback: (error?: null | <internal>.Error) => void
  - - (error?: null | <internal>.Error): void
    - Parameters
      - Optional error: null | <internal>.Error
      Returns void
Returns void

Optional write

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

- Defined in node_modules/@types/node/stream.d.ts:484
Parameters
- this: <internal>.Writable
- chunk: any
- encoding: BufferEncoding
- callback: (error?: null | <internal>.Error) => void
  - - (error?: null | <internal>.Error): void
    - Parameters
      - Optional error: null | <internal>.Error
      Returns void
Returns void

Optional writev

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

- Defined in node_modules/@types/node/stream.d.ts:485
Parameters
- this: <internal>.Writable
- chunks: { chunk: any; encoding: BufferEncoding }[]
- callback: (error?: null | <internal>.Error) => void
  - - (error?: null | <internal>.Error): void
    - Parameters
      - Optional error: null | <internal>.Error
      Returns void
Returns void

Generated using TypeDoc