Class SyncWait

Simple synchronisation. Supports only a single signal/waiter. Expects one or more calls to .signal() for .forSignal() to resolve

const sw = new SyncWait();
obj.addEventListener(`click`, () => {
 sw.signal();
});

// Wait until click event
await sw.forSignal();

forSignal can also take a maximum time to wait. If the time elapses, an exception is thrown.

didSignal returns true/false if signal happened rather than throwing an exception.

Constructors

flush(): void
Throw away any previous signalled state. This will cause any currently waiters to throw

Returns void

forSignal(maximumWaitMs?: number): Promise<void>
Call with await to wait until .signal() happens. If a wait period is specified, an exception is thrown if signal does not happen within this time.
Parameters
- OptionalmaximumWaitMs: number
Returns Promise<void>