externalStageManager

Index

Constructors

• constructor

Methods

• configure
• register
• deregister
• notifyOf
• waitForAsyncOperationsToComplete
• waitForNextCue

Constructors

externalconstructor

• new StageManager(cueTimeout: Duration, clock: Clock): StageManager

• Parameters

  • externalcueTimeout: Duration

  • externalclock: Clock

  Returns StageManager

Methods

externalconfigure

• configure(options: { cueTimeout: Duration }): void

• Parameters

  • externaloptions: { cueTimeout: Duration }

  • externalcueTimeout: Duration

  Returns void

externalregister

• register(...subscribers: ListensToDomainEvents[]): void

• Parameters

  • externalrest...subscribers: ListensToDomainEvents[]

  Returns void

externalderegister

• deregister(subscriber: ListensToDomainEvents): void

• Parameters

  • externalsubscriber: ListensToDomainEvents

  Returns void

externalnotifyOf

• notifyOf(event: DomainEvent): void

• Parameters

  • externalevent: DomainEvent

  Returns void

externalwaitForAsyncOperationsToComplete

• waitForAsyncOperationsToComplete(options?: { except: CorrelationId[] }): Promise<void>

• Returns a promise that resolves when all the async operations in progress have completed, or when the cue timeout expires, whichever happens first.

  Resolves immediately when there are no operations in progress.

  ---

  Parameters

  • externaloptions: { except: CorrelationId[] } = ...

  • externalexcept: CorrelationId[]

    Correlation ids of async operations not to wait for. Useful when the caller has registered async operations that can only complete after this wait is over, for example, when actors exiting the stage need to wait for any screenshots to be taken first.

  Returns Promise<void>

externalwaitForNextCue

• waitForNextCue(): Promise<void>

• Returns Promise<void>