Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AsyncTransformOptions<T>

Type parameters

  • T = any

Hierarchy

  • DuplexOptions
    • AsyncTransformOptions

Index

Properties

Methods

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 writableCorked

writableCorked?: number

Optional writableHighWaterMark

writableHighWaterMark?: number

Optional writableObjectMode

writableObjectMode?: boolean

Methods

Optional destroy

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

  • Parameters

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

        • Parameters

          • error: null | Error

          Returns void

    Returns void

Optional final

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

  • Parameters

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

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Optional flush

  • flush(): any

Optional read

  • read(size: number): void

  • Parameters

    • size: number

    Returns void

Optional transform

  • transform(data: T, encoding: string): any

  • Transforms data from the source by calling the push method

    Parameters

    • data: T
    • encoding: string

    Returns any

Optional write

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

  • Parameters

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

  • Parameters

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

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void