Class EventService<TEvents>

Default implementation of the event service.

Type Parameters

TEvents extends Record<string, unknown>

Implements

Index

Constructors

constructor

Methods

afterAppShutdown emit onAppInit onAppStart subscribe subscribeAll

Constructors

constructor

new EventService<TEvents extends Record<string, unknown>>(
    eventRepository: Repository<
        Event<TEvents[keyof TEvents]>,
        EventCreateData<TEvents[keyof TEvents]>,
    >,
    eventSubscriberRunRepository: Repository<
        EventSubscriberRun<TEvents[keyof TEvents]>,
        EventSubscriberRunCreateData<TEvents[keyof TEvents]>,
    >,
    logger: LoggerInterface,
): EventService<TEvents>
Type Parameters
- TEvents extends Record<string, unknown>
Parameters
- eventRepository: Repository<
  Event<TEvents[keyof TEvents]>,
  EventCreateData<TEvents[keyof TEvents]>,
  >
- eventSubscriberRunRepository: Repository<
  EventSubscriberRun<TEvents[keyof TEvents]>,
  EventSubscriberRunCreateData<TEvents[keyof TEvents]>,
  >
- logger: LoggerInterface
Returns EventService<TEvents>
- Defined in src/event/event.service.ts:57

Methods

afterAppShutdown

afterAppShutdown(): void
Runs just after the app shuts down. This is useful for things like the data source service, which should still be available at the OnAppShutdown hooks.

In most cases you probably want to implement OnAppShutdown.

Returns void
Implementation of AfterAppShutdown.afterAppShutdown
- Defined in src/event/event.service.ts:95

emit

emit<K extends string | number | symbol>(
    type: K,
    data: TEvents[K],
    cleanupAfterMs?: number,
): Promise<void>
Emits an event of the given type and data.
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- data: TEvents[K]
- cleanupAfterMs: number = Ms.DAY
Returns Promise<void>
Implementation of EventServiceInterface.emit
- Defined in src/event/event.service.ts:107

onAppInit

onAppInit(app: ZibriApplication): void
Runs when the app initializes.
Parameters
- app: ZibriApplication
Returns void
Implementation of OnAppInit.onAppInit
- Defined in src/event/event.service.ts:70

onAppStart

onAppStart(): Promise<void>
Runs when the app starts.

Returns Promise<void>
Implementation of OnAppStart.onAppStart
- Defined in src/event/event.service.ts:78

subscribe<K extends string | number | symbol>(
    type: K,
    hook: (
        value: Event<TEvents[K]>,
        signal: AbortSignal,
    ) => void | Promise<void>,
    options: EventSubscribeOptions,
): Promise<EventSubscription>
Subscribes to events of the given type with the given hook.

Additional options can be provided, like eg. Retries or the id of the subscriber. This needs to be unique.
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- hook: (value: Event<TEvents[K]>, signal: AbortSignal) => void | Promise<void>
- options: EventSubscribeOptions
Returns Promise<EventSubscription>
Implementation of EventServiceInterface.subscribe
- Defined in src/event/event.service.ts:118

subscribeAll

subscribeAll(
    hook: (
        value: Event<TEvents[keyof TEvents]>,
        signal: AbortSignal,
    ) => void | Promise<void>,
    options: EventSubscribeOptions,
): Promise<EventSubscription>
Subscribes to ALL events with the given hook.

Additional options can be provided, like eg. Retries or the id of the subscriber. This needs to be unique.
Parameters
- hook: (
  value: Event<TEvents[keyof TEvents]>,
  signal: AbortSignal,
  ) => void | Promise<void>
- options: EventSubscribeOptions
Returns Promise<EventSubscription>
Implementation of EventServiceInterface.subscribeAll
- Defined in src/event/event.service.ts:155

Class EventService<TEvents>

Type Parameters

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns EventService<TEvents>

Methods

afterAppShutdown

Returns void

emit

Type Parameters

Parameters

Returns Promise<void>

onAppInit

Parameters

Returns void

onAppStart

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<EventSubscription>

subscribeAll

Parameters

Returns Promise<EventSubscription>

Settings

On This Page