Interface WritableOptions

Hierarchy

StreamOptions<Writable>
- WritableOptions
  - DuplexOptions

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

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

Methods

Optional construct

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

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

Optional destroy

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

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

Optional final

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

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

Optional write

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

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

Optional writev

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

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

Generated using TypeDoc