Class EarlyTimer

Wrapper over JS timers that allows re-scheduling them to earlier time

Index

Constructors

Methods

emitBefore emitBeforeNext emitNow emitWhenIdle onTimeout reset

Constructors

constructor

new EarlyTimer(): EarlyTimer
Returns EarlyTimer
- Defined in packages/core/src/utils/early-timer.ts:14

Methods

emitBefore

emitBefore(ts): void
Emit the timer before the given time
Parameters
- ts: number
  Unix time in MS
Returns void
- Defined in packages/core/src/utils/early-timer.ts:51

emitBeforeNext

emitBeforeNext(ms): void
Emit the timer before the next given milliseconds

Shorthand for emitBefore(Date.now() + ms)
Parameters
- ms: number
  Milliseconds to schedule for
Returns void
- Defined in packages/core/src/utils/early-timer.ts:42

emitNow

emitNow(): void
Emit the timer right now

Returns void
- Defined in packages/core/src/utils/early-timer.ts:62

emitWhenIdle

emitWhenIdle(): void
Emit the timer when the event loop is idle (basically setImmediate())

Returns void
- Defined in packages/core/src/utils/early-timer.ts:22

onTimeout

onTimeout(handler): void
Set timeout handler
Parameters
- handler: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in packages/core/src/utils/early-timer.ts:83

reset

reset(): void
Cancel the timer

Returns void
- Defined in packages/core/src/utils/early-timer.ts:70