Interface AsyncTransformOptions<T>

Type Parameters

  • T = any

Hierarchy

  • DuplexOptions
    • AsyncTransformOptions

Properties

allowHalfOpen? autoDestroy? decodeStrings? defaultEncoding? emitClose? encoding? flush? highWaterMark? objectMode? readableHighWaterMark? readableObjectMode? transform? writableCorked? writableHighWaterMark? writableObjectMode?

Methods

destroy? final? read? write? writev?

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)

Type declaration

    • (this: Transform): any

    • Performs any final actions after the source has ended

      Parameters

      • this: Transform

      Returns 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)

Type declaration

    • (this: Transform, data: T, encoding: string): any

    • Transforms data from the source by calling the push method

      Parameters

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

      Returns any

Optional writableCorked

writableCorked?: number

Optional writableHighWaterMark

writableHighWaterMark?: number

Optional writableObjectMode

writableObjectMode?: boolean

Methods

Optional destroy

  • Parameters

    • this: Duplex
    • error: null | Error
    • callback: ((error: null | Error) => void)
        • (error: null | Error): void

        • Parameters

          • error: null | Error

          Returns void

    Returns void

Optional final

  • Parameters

    • this: Duplex
    • callback: ((error?: null | Error) => void)
        • (error?: null | Error): void

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Optional read

  • Parameters

    • this: Duplex
    • size: number

    Returns void

Optional write

  • Parameters

    • this: Duplex
    • chunk: any
    • encoding: BufferEncoding
    • callback: ((error?: null | Error) => void)
        • (error?: null | Error): void

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Optional writev

  • Parameters

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

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Settings

Member Visibility

Theme