Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • T = any

Hierarchy

  • DuplexOptions
    • AsyncTransformOptions

Index

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 flush

flush: (this: Transform) => any | Promise<any>

Performs any final actions after the source has ended

Type declaration

    • (this: Transform): any | Promise<any>
    • Parameters

      • this: Transform

      Returns any | Promise<any>

Optional highWaterMark

highWaterMark: number

Optional objectMode

objectMode: boolean

Optional readableHighWaterMark

readableHighWaterMark: number

Optional readableObjectMode

readableObjectMode: boolean

Optional transform

transform: (this: Transform, data: T, encoding: string) => any | Promise<any>

Transforms data from the source by calling the push method

Type declaration

    • (this: Transform, data: T, encoding: string): any | Promise<any>
    • Parameters

      • this: Transform
      • data: T
      • encoding: string

      Returns any | Promise<any>

Optional writableCorked

writableCorked: number

Optional writableHighWaterMark

writableHighWaterMark: number

Optional writableObjectMode

writableObjectMode: boolean

Methods

Optional destroy

destroy:

Optional final

final:

Optional read

read:

Optional write

write:

Optional writev

writev: