Type alias RateLimitedQueueInstrumentors

RateLimitedQueueInstrumentors: ConnectionInstrumentors & QueueInstrumentors & {
    drop: Instrumentor;
    onHandleMessageError: ((error, message) => void);
    tick: TickInstrumentor;
}

A type that extends the ConnectionInstrumentors and QueueInstrumentors interfaces. This is used to define the instrumentors for the RateLimitedQueueClient.

Type declaration

  • drop: Instrumentor

    A function that is called when a drop is spilled from the queue (meaning that the callback has been called).

    Param

    The function handle to be instrumented.

    Param

    The amount of messages still in the queue.

    Returns

    The return type of the function handle.

  • onHandleMessageError: ((error, message) => void)
      • (error, message): void

      • A function that is called when an error occurs while handling a message.

        Parameters

        • error: Error

          The error that occurred.

        • message: QueueMessage

          The message that caused the error.

        Returns void

  • tick: TickInstrumentor

    The instrumentation function which is run when a "tick" occurs.

    Param

    The function handle to be instrumented.

    Param

    The amount of messages still in the queue.

    Returns

    The return type of the function handle.

Settings

Member Visibility

Theme