Interface TransformOptions

Hierarchy

DuplexOptions
- TransformOptions

Properties

`Optional` allowHalfOpen

allowHalfOpen?: boolean

`Optional` autoDestroy

autoDestroy?: boolean

`Optional` decodeStrings

decodeStrings?: boolean

`Optional` defaultEncoding

defaultEncoding?: BufferEncoding

`Optional` emitClose

emitClose?: boolean

`Optional` encoding

encoding?: BufferEncoding

`Optional` highWaterMark

highWaterMark?: number

`Optional` objectMode

objectMode?: boolean

`Optional` readableHighWaterMark

readableHighWaterMark?: number

`Optional` readableObjectMode

readableObjectMode?: boolean

`Optional` signal

signal?: AbortSignal

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

`Optional` writableCorked

writableCorked?: number

`Optional` writableHighWaterMark

writableHighWaterMark?: number

`Optional` writableObjectMode

writableObjectMode?: boolean

Methods

`Optional` construct

construct(this, callback): void
Parameters
- this: Transform
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      Optional error: null | Error
      Returns void
Returns void
Overrides DuplexOptions.construct

`Optional` destroy

destroy(this, error, callback): void
Parameters
- this: Transform
- error: null | Error
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      Optional error: null | Error
      Returns void
Returns void
Overrides DuplexOptions.destroy

`Optional` final

final(this, callback): void
Parameters
- this: Transform
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      Optional error: null | Error
      Returns void
Returns void
Overrides DuplexOptions.final

`Optional` flush

flush(this, callback): void
Parameters
- this: Transform
- callback: TransformCallback
Returns void

`Optional` read

read(this, size): void
Parameters
- this: Transform
- size: number
Returns void
Overrides DuplexOptions.read

`Optional` transform

transform(this, chunk, encoding, callback): void
Parameters
- this: Transform
- chunk: any
- encoding: BufferEncoding
- callback: TransformCallback
Returns void

`Optional` write

write(this, chunk, encoding, callback): void
Parameters
- this: Transform
- chunk: any
- encoding: BufferEncoding
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      Optional error: null | Error
      Returns void
Returns void
Overrides DuplexOptions.write

`Optional` writev

writev(this, chunks, callback): void
Parameters
- this: Transform
- chunks: {
  chunk: any;
  encoding: BufferEncoding;
  }[]
- callback: ((error?) => void)
  - - (error?): void
    - Parameters
      Optional error: null | Error
      Returns void
Returns void
Overrides DuplexOptions.writev

Generated using TypeDoc