Class AdminEventPublisher

Publishes business events to B2B consumers

Template: T

The type of the event, should be unique within its domain

Template: D

The event data for this specific event type and domain. It must be (de)seriable to/from JSON.

Template: E

Event with type T and data D

Index

Constructors

Methods

Constructors

constructor

new AdminEventPublisher(
    __namedParameters: {
        defaultHeaders?: Record<string, string>;
        signingSecret: string;
        url: string;
    },
): AdminEventPublisher
Parameters
- __namedParameters: { defaultHeaders?: Record<string, string>; signingSecret: string; url: string }
Returns AdminEventPublisher
- Defined in webhook/AdminEventPublisher.ts:15

Methods

publish

publish<
    E extends AdminEvent<T, D>,
    T extends string = TypeForAdminEvent<E>,
    D extends object = DataForAdminEvent<E>,
>(
    event: E,
    opts?: { headers?: Record<string, string> },
): Promise<void>
Type Parameters
- E extends AdminEvent<T, D>
- T extends string = TypeForAdminEvent<E>
- D extends object = DataForAdminEvent<E>
Parameters
- event: E
  Must be serialisable
- Optionalopts: { headers?: Record<string, string> }
  - Optionalheaders?: Record<string, string>
    Additional HTTP headers to be included in the message
Returns Promise<void>
- Defined in webhook/AdminEventPublisher.ts:32