Class Delay

Wraps a promise that resolves after the given milliseconds. Uses setTimeout, so the same delay inaccuracies apply.

Hierarchy (View Summary)

Deferred<void>
- Delay

Implements

Resource

Index

Constructors

Methods

then flush cancel free

Constructors

constructor

new Delay(ms: number): Delay
Parameters
- ms: number
Returns Delay
Overrides Deferred.constructor
- Defined in src/timing.ts:30

Methods

then

then(action: Producer<unknown>, onError?: Consumer<any>): this
Shorthand to run the given action when the promise resolves.
Parameters
- action: Producer<unknown>
- onError: Consumer<any> = ignore
Returns this
- Defined in src/timing.ts:38

flush

flush(): void
Aborts the timeout by resolving the promise.

Returns void
- Defined in src/timing.ts:46

cancel

cancel(reason?: any): void
Aborts the timeout by rejecting the promise.
Parameters
- reason: any = ...
Returns void
- Defined in src/timing.ts:56

free

free(): void
Returns void
Implementation of Resource.free
- Defined in src/timing.ts:63