Interface WritableOptions

Hierarchy

StreamOptions<Writable>
- WritableOptions
  - DuplexOptions

Index

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: Writable
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      Optional error: null | Error
      Returns void
Returns void
Inherited from StreamOptions.construct

`Optional` destroy

destroy(this, error, callback): void
Parameters
- this: Writable
- error: null | Error
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      Optional error: null | Error
      Returns void
Returns void
Inherited from StreamOptions.destroy

`Optional` final

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

`Optional` write

write(this, chunk, encoding, callback): void
Parameters
- this: Writable
- 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: Writable
- chunks: {
  chunk: any;
  encoding: BufferEncoding;
  }[]
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      Optional error: null | Error
      Returns void
Returns void

Generated using TypeDoc