Class EntityEventPublisher

Specialised EventPublisher that accepts events with an entityId

See

Index

Constructors

Methods

Constructors

constructor

new EntityEventPublisher(
    __namedParameters: {
        defaultHeaders?: Record<string, string>;
        signingSecret: string;
        url: string;
    } & { sqlClient: Sql },
): EntityEventPublisher
Parameters
- __namedParameters: { defaultHeaders?: Record<string, string>; signingSecret: string; url: string } & {
  sqlClient: Sql;
  }
Returns EntityEventPublisher
- Defined in packages/entity-services/src/entity/EntityEventPublisher.ts:26

Methods

publish

publish<
    E extends EntityEvent<T, D>,
    T extends string = TypeForEvent<E>,
    D extends object = DataForEvent<E>,
>(
    event: Event<T, D> & { entityId: string },
    opts?: { headers?: Record<string, string> },
): Promise<void>
Type Parameters
- E extends EntityEvent<T, D>
- T extends string = TypeForEvent<E>
- D extends object = DataForEvent<E>
Parameters
- event: Event<T, D> & { entityId: string }
  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 packages/entity-services/src/entity/EntityEventPublisher.ts:39