bare-timers

stable

bare-timers — Native timers for Javascript. It is a native addon and requires Bare >=1.7.0.

Mirrors the Node.js timers module.

npm i bare-timers

Usage

const { setTimeout, clearTimeout } = require('bare-timers')

API

Functions

`setTimeout`

setTimeout<T extends unknown[]>(callback: (...args: T) => unknown, delay: number, ...args: T): Timeout

_Source

Schedule execution once after delay milliseconds, clamped to a minimum of 1ms.

Parameters

Parameter	Type	Default	Description
`callback`	`(...args: T) => unknown`	—	The function to run after the delay.
`delay`	`number`	—	Milliseconds to wait before running; clamped to a minimum of `1`.
`args`	`T`	—	Additional arguments passed to `callback`.

`clearTimeout(timer: Timeout): void`

_Source

Cancel a pending timeout, preventing it from firing.

Parameters

Parameter	Type	Default	Description
`timer`	`Timeout`	—	The timeout handle to cancel.

`setInterval`

setInterval<T extends unknown[]>(callback: (...args: T) => unknown, delay: number, ...args: T): Timeout

_Source

Schedule repeated execution every delay milliseconds, clamped to a minimum of 1ms.

Parameters

Parameter	Type	Default	Description
`callback`	`(...args: T) => unknown`	—	The function to run on each interval.
`delay`	`number`	—	Milliseconds between runs; clamped to a minimum of `1`.
`args`	`T`	—	Additional arguments passed to `callback`.

`clearInterval(timer: Timeout): void`

_Source

Cancel a pending interval, preventing further firings.

Parameters

Parameter	Type	Default	Description
`timer`	`Timeout`	—	The interval handle to cancel.

`setImmediate<T extends unknown[]>(callback: (...args: T) => unknown, ...args: T): Immediate`

_Source

Schedule execution once at the end of the current event loop iteration.

Parameters

Parameter	Type	Default	Description
`callback`	`(...args: T) => unknown`	—	The function to run at the end of the current event loop iteration.
`args`	`T`	—	Additional arguments passed to `callback`.

`clearImmediate(immediate: Immediate): void`

_Source

Cancel a pending immediate, preventing it from firing.

Parameters

Parameter	Type	Default	Description
`immediate`	`Immediate`	—	The immediate handle to cancel.

Types

`Task`

interface Task {
  ref(): this
  unref(): this
  hasRef(): boolean
}

_Source

The base handle shared by Timeout and Immediate, controlling whether it keeps the event loop alive.

`Timeout`

interface Timeout extends Task {
  refresh(): this
}

_Source

The handle returned by setTimeout and setInterval.

`Immediate`

interface Immediate extends Task {}

_Source

The handle returned by setImmediate.

`bare-timers/promises`

Functions

`setTimeout<T>(delay?: number, value?: T, options?: TimeoutOptions): Promise<T>`

_Source

Schedule execution once after delay milliseconds, clamped to a minimum of 1ms.

Parameters

Parameter	Type	Default	Description
`delay?`	`number`	—	Milliseconds to wait before running; clamped to a minimum of `1`.
`value?`	`T`	—	The value the returned promise resolves with.
`options?`	`TimeoutOptions`	—	Options; `ref` defaults to `true` (set `false` to unref), and `signal` may be an `AbortSignal` that cancels the timer.

`setInterval<T>(delay?: number, value?: T, options?: TimeoutOptions): AsyncGenerator<T>`

_Source

Schedule repeated execution every delay milliseconds, clamped to a minimum of 1ms.

Parameters

Parameter	Type	Default	Description
`delay?`	`number`	—	Milliseconds between runs; clamped to a minimum of `1`.
`value?`	`T`	—	The value yielded on each iteration.
`options?`	`TimeoutOptions`	—	Options; `ref` defaults to `true` (set `false` to unref), and `signal` may be an `AbortSignal` that cancels the timer.

`setImmediate<T>(value?: T, options?: ImmediateOptions): Promsie<T>`

_Source

Schedule execution once at the end of the current event loop iteration.

Parameters

Parameter	Type	Default	Description
`value?`	`T`	—	The value the returned promise resolves with.
`options?`	`ImmediateOptions`	—	Options; `ref` defaults to `true` (set `false` to unref), and `signal` may be an `AbortSignal` that cancels the timer.

Types

`TaskOptions`

interface TaskOptions {
  ref?: boolean
  signal?: AbortSignal
}

_Source

Shared options for the bare-timers/promises scheduling functions.

`TimeoutOptions`

interface TimeoutOptions extends TaskOptions {}

_Source

Options for bare-timers/promises' setTimeout and setInterval.

`ImmediateOptions`

interface ImmediateOptions extends TaskOptions {}

_Source

Options for bare-timers/promises' setImmediate.

bare-timers

Usage

API

Functions

`setTimeout`

`clearTimeout(timer: Timeout): void`

`setInterval`

`clearInterval(timer: Timeout): void`

`setImmediate<T extends unknown[]>(callback: (...args: T) => unknown, ...args: T): Immediate`

`clearImmediate(immediate: Immediate): void`

Types

`Task`

`Timeout`

`Immediate`

`bare-timers/promises`

Functions

`setTimeout<T>(delay?: number, value?: T, options?: TimeoutOptions): Promise<T>`

`setInterval<T>(delay?: number, value?: T, options?: TimeoutOptions): AsyncGenerator<T>`

`setImmediate<T>(value?: T, options?: ImmediateOptions): Promsie<T>`

Types

`TaskOptions`

`TimeoutOptions`

`ImmediateOptions`

See also

On this page