Stratal API Reference
    Preparing search index...

    Interface IQueueConsumer<T>

    Queue consumer interface

    Consumers handle messages based on their messageTypes declaration. A consumer receives messages of the declared types from ANY queue.

    @Transient()
    export class EmailConsumer implements IQueueConsumer<SendEmailInput> {
      readonly messageTypes = ['email.send', 'email.batch.send']

      async handle(message: QueueMessage<SendEmailInput>): Promise<void> {
        // Process email...
      }
    }
    interface IQueueConsumer<T = unknown> {
        messageTypes: string[];
        handle(message: QueueMessage<T>): Promise<void>;
        onError?(error: Error, message: QueueMessage<T>): Promise<void>;
    }

    Type Parameters

    • T = unknown
    Index

    Properties

    messageTypes

    Methods

    handle onError?

    Properties

    messageTypes: string[]

    Message types this consumer handles.

    The consumer receives messages matching these types from ANY queue. Use '*' to match all message types (wildcard consumer).

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods