Type alias BucketQueueEventHandlers<T>

BucketQueueEventHandlers<T>: {
    corked: (() => void);
    drain: (() => void);
    error: ((error: Error | null | undefined, itemOrItems?: T | T[]) => void);
    finish: (() => void);
    pipe: ((items: T[]) => void);
    spill: ((timestamp: number, pressure: number) => void);
    spilled: ((timestamp: number, pressure: number, prevPressure: number) => void);
    tick: ((timestamp: number, pressure: number) => void);
    uncorked: (() => void);
    unpipe: ((items: T[]) => void);
}

Represents an object of event handlers used by the BucketQueue class.

Typeparam

T The type of items being handled by the event handlers.

Type Parameters

  • T = any

Type declaration

  • corked: (() => void)
      • (): void

      • Handles the "corked" event, which is triggered when the bucket queue is corked.

        Returns void

  • drain: (() => void)
      • (): void

      • Handles the "drain" event, which is triggered when the bucket queue becomes empty.

        Returns void

  • error: ((error: Error | null | undefined, itemOrItems?: T | T[]) => void)
      • (error: Error | null | undefined, itemOrItems?: T | T[]): void

      • Handles the "error" event, which is triggered when an error occurs while processing items in the bucket queue.

        Parameters

        • error: Error | null | undefined

          The error object that was thrown.

        • Optional itemOrItems: T | T[]

          The item or items that caused the error.

        Returns void

  • finish: (() => void)
      • (): void

      • Handles the "finish" event, which is triggered when the bucket queue becomes empty and no more items are expected to be added.

        Returns void

  • pipe: ((items: T[]) => void)
      • (items: T[]): void

      • Handles the "pipe" event, which is triggered when items are added to the bucket queue.

        Parameters

        • items: T[]

          An array of items that were added to the bucket queue.

        Returns void

  • spill: ((timestamp: number, pressure: number) => void)
      • (timestamp: number, pressure: number): void

      • Handles the "spill" event, which is triggered when the bucket queue reaches its maximum batch size and spills.

        Parameters

        • timestamp: number

          The timestamp when the event was triggered.

        • pressure: number

          The number of items currently in the bucket queue.

        Returns void

  • spilled: ((timestamp: number, pressure: number, prevPressure: number) => void)
      • (timestamp: number, pressure: number, prevPressure: number): void

      • Handles the "spilled" event, which is triggered when the bucket queue has spilled and reduced its pressure.

        Parameters

        • timestamp: number

          The timestamp when the event was triggered.

        • pressure: number

          The number of items currently in the bucket queue.

        • prevPressure: number

          The number of items in the bucket queue before it spilled.

        Returns void

  • tick: ((timestamp: number, pressure: number) => void)
      • (timestamp: number, pressure: number): void

      • Handles the "tick" event, which is triggered on each interval if the bucket queue is not empty.

        Parameters

        • timestamp: number

          The timestamp when the event was triggered.

        • pressure: number

          The number of items currently in the bucket queue.

        Returns void

  • uncorked: (() => void)
      • (): void

      • Handles the "uncorked" event, which is triggered when the bucket queue is uncorked.

        Returns void

  • unpipe: ((items: T[]) => void)
      • (items: T[]): void

      • Handles the "unpipe" event, which is triggered when items are removed from the bucket queue.

        Parameters

        • items: T[]

          An array of items that were removed from the bucket queue.

        Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc