Class Clock

The mock clock implementation

Hierarchy

Clock

Implements

TimerProvider

Index

Constructors

constructor

new Clock(): Clock
Returns Clock
- Defined in src/index.ts:182

Properties

`Private` #now

#now: number = 1

`Private` `Optional` #saved

#saved?: Saved

`Private` #timers

#timers: Map<number, Timer[]> = ...

Date

Date: typeof MockDate

setImmediate

setImmediate: SetImmediate

Schedule a function to be run the next time the clock is advanced by any ammount.

setInterval

setInterval: SetInterval

Schedule a function to be run when the clock advances each multiple of n past the current point.

If multiple steps are advanced at once, for example doing c.setInterval(fn, 1) ; c.advance(1000), then it will only call the function once. This allows you to simulate clock jitter.

Only ms granularity.

setTimeout

setTimeout: SetTimeout

Schedule a function to be run when the clock has advanced n ms beyond the current point.

Only ms granularity.

Accessors

timers

get timers(): Map<number, Timer[]>
Returns Map<number, Timer[]>
- Defined in src/index.ts:150

Methods

`Private` #setImmediate

#setImmediate(f, ...a): Timer
Parameters
- f: ((...a) => any)
  - - (...a): any
    - Parameters
      
      Rest ...a: any[]
      
      Returns any
- Rest ...a: any[]
Returns Timer
- Defined in src/index.ts:265

`Private` #setInterval

#setInterval(f, n?, ...a): Timer
Parameters
- f: ((...a) => any)
  - - (...a): any
    - Parameters
      
      Rest ...a: any[]
      
      Returns any
- n: number = 1
- Rest ...a: any[]
Returns Timer
- Defined in src/index.ts:425

`Private` #setTimeout

#setTimeout(f, n?, ...a): Timer
Parameters
- f: ((...a) => any)
  - - (...a): any
    - Parameters
      
      Rest ...a: any[]
      
      Returns any
- n: number = 1
- Rest ...a: any[]
Returns Timer
- Defined in src/index.ts:325

advance

advance(n): void
Advance the clock by n ms. Use floats for smaller increments of time.
Parameters
- n: number
Returns void
- Defined in src/index.ts:244

clearImmediate

clearImmediate(t): void
Clear an immediate timer created by the clock. (alias for clearTimeout)
Parameters
- t: Timer | Immediate
Returns void
- Defined in src/index.ts:417

clearInterval

clearInterval(t): void
Clear an interval created by the clock. (alias for clearTimeout)
Parameters
- t: Timer | Timeout
Returns void
- Defined in src/index.ts:405

clearTimeout

clearTimeout(t): void
Clear a timeout created by the clock.
Parameters
- t: Timer | Timeout
Returns void
- Defined in src/index.ts:393

enter

enter(): (() => void)
Mocks all the things in the global space.

Returns exit function, for ease of doing t.teardown(c.enter()).

Returns (() => void)
- - (): void
  - Returns void
- Defined in src/index.ts:500

exit

exit(): boolean
If entered, exit the clock, restoring the global state

Returns boolean
- Defined in src/index.ts:676

flow

flow(n, step?): Promise<void>
Advance the clock in steps, awaiting a Promise at each step, so that actual asynchronous events can occur, as well as timers.
Parameters
- n: number
- step: number = 5
Returns Promise<void>
- Defined in src/index.ts:258

hrtime

hrtime(s?): [number, number]
Mock of process.hrtime(), returning [seconds, nanoseconds] on the clock.
Parameters
- s: [number, number] = ...
Returns [number, number]
- Defined in src/index.ts:479

hrtimeBigint

hrtimeBigint(): bigint
Mock of process.hrtime.bigint(), returning BigInt representation of current nanosecond time.

Returns bigint
- Defined in src/index.ts:491

now

now(): number
Returns the current ms time on the clock.

Returns number
- Defined in src/index.ts:229

setImmediatePromise

setImmediatePromise(value?, options?): Promise<void>
The promisified setImmediate, also available via promisify(clock.setImmediate)
Parameters
- Optional value: undefined
- Optional options: {
  reffed?: boolean;
  signal?: AbortSignal;
  }
  - Optional reffed?: boolean
  - Optional signal?: AbortSignal
Returns Promise<void>
- Defined in src/index.ts:274
setImmediatePromise<T>(value, options?): Promise<T>
Type Parameters
- T = void
Parameters
- value: T
- Optional options: {
  reffed?: boolean;
  signal?: AbortSignal;
  }
  - Optional reffed?: boolean
  - Optional signal?: AbortSignal
Returns Promise<T>
- Defined in src/index.ts:281

setIntervalPromise

setIntervalPromise(n?, value?, options?): AsyncGenerator<void, any, unknown>
promisified setInterval, also available via promisify(clock.setImmediate)
Parameters
- Optional n: number
- Optional value: undefined
- Optional options: {
  reffed?: boolean;
  signal?: AbortSignal;
  }
  - Optional reffed?: boolean
  - Optional signal?: AbortSignal
Returns AsyncGenerator<void, any, unknown>
- Defined in src/index.ts:444
setIntervalPromise<T>(n?, value?, options?): AsyncGenerator<T, any, unknown>
Type Parameters
- T = void
Parameters
- Optional n: number
- Optional value: T
- Optional options: {
  reffed?: boolean;
  signal?: AbortSignal;
  }
  - Optional reffed?: boolean
  - Optional signal?: AbortSignal
Returns AsyncGenerator<T, any, unknown>
- Defined in src/index.ts:452

setTimeoutPromise

setTimeoutPromise(n?, value?, options?): Promise<void>
The promisified setTimeout, also available via promisify(clock.setTimeout)
Parameters
- Optional n: number
- Optional value: undefined
- Optional options: {
  reffed?: boolean;
  signal?: AbortSignal;
  }
  - Optional reffed?: boolean
  - Optional signal?: AbortSignal
Returns Promise<void>
- Defined in src/index.ts:336
setTimeoutPromise<T>(n, value, options?): Promise<T>
Type Parameters
- T = void
Parameters
- n: number
- value: T
- Optional options: {
  reffed?: boolean;
  signal?: AbortSignal;
  }
  - Optional reffed?: boolean
  - Optional signal?: AbortSignal
Returns Promise<T>
- Defined in src/index.ts:344

travel

travel(to): void
Set the clock to a specific time. Will fire timers that you zoom past.
Parameters
- to: number
Returns void
- Defined in src/index.ts:236

Class Clock

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Clock

Properties

Private #now

Private Optional #saved

Private #timers

Date

setImmediate

setInterval

setTimeout

Accessors

timers

Returns Map<number, Timer[]>

Methods

Private #setImmediate

Parameters

f: ((...a) => any)

Parameters

Rest ...a: any[]

Returns any

Rest ...a: any[]

Returns Timer

Private #setInterval

Parameters

f: ((...a) => any)

Parameters

Rest ...a: any[]

Returns any

n: number = 1

Rest ...a: any[]

Returns Timer

Private #setTimeout

Parameters

f: ((...a) => any)

Parameters

Rest ...a: any[]

Returns any

n: number = 1

Rest ...a: any[]

Returns Timer

advance

Parameters

n: number

Returns void

clearImmediate

Parameters

t: Timer | Immediate

Returns void

clearInterval

Parameters

t: Timer | Timeout

Returns void

clearTimeout

Parameters

t: Timer | Timeout

Returns void

enter

Returns (() => void)

Returns void

exit

Returns boolean

flow

Parameters

n: number

step: number = 5

Returns Promise<void>

hrtime

Parameters

s: [number, number] = ...

Returns [number, number]

hrtimeBigint

`Private` #now

`Private` `Optional` #saved

`Private` #timers

`Private` #setImmediate

`Rest` ...a: any[]

`Rest` ...a: any[]

`Private` #setInterval

`Rest` ...a: any[]

`Rest` ...a: any[]

`Private` #setTimeout

`Rest` ...a: any[]

`Rest` ...a: any[]

`Optional` value: undefined

`Optional` options: {
reffed?: boolean;
signal?: AbortSignal;
}

`Optional` reffed?: boolean

`Optional` signal?: AbortSignal

`Optional` options: {
reffed?: boolean;
signal?: AbortSignal;
}

`Optional` reffed?: boolean

`Optional` signal?: AbortSignal

`Optional` n: number

`Optional` value: undefined

`Optional` options: {
reffed?: boolean;
signal?: AbortSignal;
}

`Optional` reffed?: boolean

`Optional` signal?: AbortSignal

`Optional` n: number

`Optional` value: T

`Optional` options: {
reffed?: boolean;
signal?: AbortSignal;
}

`Optional` reffed?: boolean

`Optional` signal?: AbortSignal

`Optional` n: number

`Optional` value: undefined

`Optional` options: {
reffed?: boolean;
signal?: AbortSignal;
}

`Optional` reffed?: boolean

`Optional` signal?: AbortSignal

`Optional` options: {
reffed?: boolean;
signal?: AbortSignal;
}

`Optional` reffed?: boolean

`Optional` signal?: AbortSignal