@xylabs/timer

@xylabs/timer

Base functionality used throughout XY Labs TypeScript/JavaScript libraries

Install

Using npm:

npm install {{name}}

Using yarn:

yarn add {{name}}

Using pnpm:

pnpm add {{name}}

Using bun:

bun add {{name}}

License

See the LICENSE file for license rights and limitations (LGPL-3.0-only).

Reference

packages

timer

### .temp-typedoc

  ### functions

    ### <a id="clearTimeoutEx"></a>clearTimeoutEx

@xylabs/timer

function clearTimeoutEx(id): void;

Cancels a timeout previously created with setTimeoutEx.

Parameters

id

string

The timeout ID returned by setTimeoutEx.

Returns

void

    ### <a id="setTimeoutEx"></a>setTimeoutEx

@xylabs/timer

function setTimeoutEx(func, delay): string;

Sets a timeout using an optimized internal timer that coalesces multiple timeouts into a single native timer.

Parameters

func

Function

The function to call after the delay.

delay

number

The delay in milliseconds (must be >= 0).

Returns

string

A unique string ID that can be used with clearTimeoutEx to cancel the timeout.