EventBusService
internal.internal.EventBusService
Can keep track of multiple subscribers to different events and run the subscribers when events happen. Events will run asynchronously.
Implements
Properties
__configModule__Record<string, unknown>__container__anyRequired__moduleDeclaration__Record<string, unknown>enqueue_Promise<void>Requiredmanager_EntityManagerRequiredshouldEnqueuerRunbooleanRequiredtransactionManager_undefined | EntityManagerRequiredAccessors
activeManager_
Protected get activeManager_(): EntityManager
Returns
EntityManager
EntityManagerEntityManagerRequiredInherited from
TransactionBaseService.activeManager_
Methods
atomicPhase_
Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>
Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.
TResultobjectRequiredTErrorobjectRequiredParameters
work(transactionManager: EntityManager) => Promise<TResult>RequiredisolationOrErrorHandlerIsolationLevel | (error: TError) => Promise<void | TResult>maybeErrorHandlerOrDontFail(error: TError) => Promise<void | TResult>Returns
Promise<TResult>
PromisePromise<TResult>RequiredInherited from
TransactionBaseService.atomicPhase_
emit
emit<T>(data): Promise<void | StagedJob[]>
Calls all subscribers when an event occurs.
TobjectRequiredParameters
Returns
Promise<void | StagedJob[]>
the jobs from our queue
Implementation of
emit<T>(eventName, data, options?): Promise<void | StagedJob>
Calls all subscribers when an event occurs.
TobjectRequiredParameters
eventNamestringRequireddataTRequiredoptionsRecord<string, unknown>Returns
Promise<void | StagedJob>
the job from our queue
Implementation of
EventBusTypes.IEventBusService.emit
enqueuer_
enqueuer_(): Promise<void>
Returns
Promise<void>
PromisePromise<void>RequiredlistJobs
Protected listJobs(listConfig): Promise<never[] | StagedJob[]>
Parameters
Returns
Promise<never[] | StagedJob[]>
shouldRetryTransaction_
Protected shouldRetryTransaction_(err): boolean
Parameters
errRecord<string, unknown> | { code: string }RequiredReturns
boolean
booleanbooleanInherited from
TransactionBaseService.shouldRetryTransaction_
startEnqueuer
startEnqueuer(): void
Returns
void
voidvoidstopEnqueuer
stopEnqueuer(): Promise<void>
Returns
Promise<void>
PromisePromise<void>Requiredsubscribe
subscribe(event, subscriber, context?): EventBusService
Adds a function to a list of event subscribers.
Parameters
eventstring | symbolRequiredcontextSubscriberContextReturns
Implementation of
unsubscribe
unsubscribe(event, subscriber, context): EventBusService
Removes function from the list of event subscribers.
Parameters
eventstring | symbolRequiredReturns
Implementation of
withTransaction
withTransaction(transactionManager?): EventBusService
Parameters
transactionManagerEntityManagerReturns
Implementation of
IEventBusService.withTransaction