Class PullTransfer

Hierarchy

  • PassThrough
    • PullTransfer

Constructors

constructor

Properties

stats

Methods

cancel on write

Constructors

constructor

  • new PullTransfer(opts?): PullTransfer

  • Parameters

    • Optional opts: TransformOptions

    Returns PullTransfer

Properties

Private Readonly stats

stats: StatsObject = ...

Methods

cancel

on

  • on(event, listener): this

  • Parameters

    • event: "close"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • on(event, listener): this

  • Parameters

    • event: "data"
    • listener: ((chunk) => void)
        • (chunk): void

        • Parameters

          • chunk: unknown

          Returns void

    Returns this

  • on(event, listener): this

  • Parameters

    • event: "end"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • on(event, listener): this

  • Parameters

    • event: "error"
    • listener: ((err) => void)
        • (err): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • on(event, listener): this

  • Parameters

    • event: "pause"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • on(event, listener): this

  • Parameters

    • event: "readable"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • on(event, listener): this

  • Parameters

    • event: "resume"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • on(event, listener): this

  • Parameters

    • event: "progress"
    • listener: ((stats) => void)

    Returns this

  • on<T>(event, listener): this

  • Type Parameters

    • T extends unknown[]

    Parameters

    • event: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: T

          Returns void

    Returns this

write

  • write(chunk, encoding?, cb?): boolean

  • Parameters

    • chunk: Buffer
    • Optional encoding: BufferEncoding
    • Optional cb: ((error) => void)
        • (error): void

        • Parameters

          • error: undefined | null | Error

          Returns void

    Returns boolean

  • write(chunk, cb?): boolean

  • Parameters

    • chunk: Buffer
    • Optional cb: ((error) => void)
        • (error): void

        • Parameters

          • error: undefined | null | Error

          Returns void

    Returns boolean

Settings

Member Visibility

Theme

On This Page

constructorstatscancelonwrite