Class MqService

constructor

• new MqService(connectionString?, queueName?, exchange?, requeueUnhandled?, logger?): MqService

• Create a new MqService instance.

  Parameters

  • connectionString: string = 'amqp://localhost'

    The connection string to the message queue.
  • queueName: string = null

    The name of the queue to use. Normally this should be your service name. Only needed if you want to consume messages.
  • exchange: string = 'general'

    The exchange to use.
  • requeueUnhandled: boolean = false

    If true, unhandled messages will be requeued, otherwise they will be discarded.
  • logger: {
        error: ((message: string, error: any) => void);
        log: ((message: string) => void);
        warn: ((message: string) => void);
    } = console

    The logger to use for logging messages.

    • error: ((message: string, error: any) => void)

      • • (message, error): void

        • Parameters

          • message: string
          • error: any

          Returns void

    • log: ((message: string) => void)

      • • (message): void

        • Parameters

          • message: string

          Returns void

    • warn: ((message: string) => void)

      • • (message): void

        • Parameters

          • message: string

          Returns void

  Returns MqService

ReadonlyconnectionString

Readonlyexchange

Readonlylogger

close

• close(): Promise<void>

• Returns Promise<void>

getListenerCount

• getListenerCount(): number

• Returns number

publish

• publish<TChannel>(event, payload): Promise<void>

• Type Parameters

  • TChannel extends
        | "COCKPIT_ADD_REGISTRATION"
        | "EMAIL_GENERIC"
        | "EMAIL_BUTTON"
        | "CUSTOMER_MERGE"
        | "CUSTOMER_DELETE"
        | "CUSTOMER_CREATED"

  Parameters

  • event: TChannel
  • payload: {
        COCKPIT_ADD_REGISTRATION: {
            name: "cockpit.addRegistration";
            payload: CockpitAddRegistrationPayload;
        };
        CUSTOMER_CREATED: {
            name: "customer.created";
            payload: CustomerCreatedEventPayload;
        };
        CUSTOMER_DELETE: {
            name: "customer.delete";
            payload: CustomerDeleteEventPayload;
        };
        CUSTOMER_MERGE: {
            name: "customer.merge";
            payload: MergeCustomerPayload;
        };
        EMAIL_BUTTON: {
            name: "email.button";
            payload: ButtonEmailEventPayload;
        };
        EMAIL_GENERIC: {
            name: "email.generic";
            payload: GenericEmailEventPayload;
        };
    }[TChannel]["payload"]

  Returns Promise<void>

startConsuming

• startConsuming(): Promise<void>

• Returns Promise<void>

subscribe

• subscribe<TChannel>(event, handler): Promise<void>

• Type Parameters

  • TChannel extends
        | "COCKPIT_ADD_REGISTRATION"
        | "EMAIL_GENERIC"
        | "EMAIL_BUTTON"
        | "CUSTOMER_MERGE"
        | "CUSTOMER_DELETE"
        | "CUSTOMER_CREATED"

  Parameters

  • event: TChannel
  • handler: MqHandler<TChannel>

  Returns Promise<void>