Elapse

Calculates and tracks the elapsed time, to create a customizable timer that can be started, paused, resumed, and stopped. It’s useful for tracking elapsed time in applications where you need to manage time-based events.

Usage

import { Elapse } from 'utilix';

// Create a new Elapse instance with a 1 second interval
const elapse = new Elapse({
	interval: 1000,
	onTick: (time) => {
		console.log(`Elapsed time: ${time}ms`);
	}
});

// After some time, pause the elapse timer
setTimeout(() => {
	elapse.pause();
}, 5000);

// After some more time, resume the elapse timer
setTimeout(() => {
	elapse.resume();
}, 10000);

// Finally, stop the elapse timer
setTimeout(() => {
	elapse.stop();
}, 15000);

Manual start

By default the elapse timer will start immediately, to disable this behavior, set the interval.immediate option to false:

const elapse = new Elapse({
	interval: { delay: 1000, immediate: false },
	// ...
});

// Start the elapse timer manually
elapse.start();

Elapse class

class Elapse

Calculates and tracks the elapsed time.

Constructors

constructor(options: ElapseOptions = {})

Creates a new Elapse instance.

Parameters

• options: ElapseOptions = {} The options for the elapse timer.

Properties

Name	Type	Description
state	ElapseState	get The current state of the elapse timer.
time	number	get The elapsed time.

start method

start(): void

Starts the elapse timer.

pause method

pause(): void

Pauses the elapse timer.

resume method

resume(): void

Resumes the elapse timer.

stop method

stop(): void

Stops the elapse timer.

ElapseState type

type ElapseState = 'inactive' | 'active' | 'paused'

The state of the Elapse instance.

ElapseOptions interface

interface ElapseOptions

Options for the Elapse class.

Properties

Name	Type	Description
interval	number | IntervalOptions	optional The interval or options for the interval.
timestamp	() => number	optional Function that returns the current timestamp.
onTick	(time: number) => void	optional Function to be called on each tick.
driftAdjust	boolean	optional Adjust any drift in the elapsed time to the nearest multiple of the interval delay value if exist.

Drift adjusting

The Elapse class has self-adjusting mechanism that help keep the elapsed time accurate (to the nearest multiple of the interval delay value if exist) even if the actual interval drifts due to system load or other factors, this behavior can be disabled by setting the driftAdjust option to false.

Example:

const elapse = new Elapse({
	interval: 1000,
	driftAdjust: false,
	onTick: (time) => {
		console.log(`Elapsed time: ${time}ms`);
	}
});

The output without driftAdjust: false:

Elapsed time: 1000ms
Elapsed time: 2000ms
Elapsed time: 3000ms
Elapsed time: 4000ms
Elapsed time: 5000ms
...

The output when setting driftAdjust: false:

Elapsed time: 1013ms
Elapsed time: 2018ms
Elapsed time: 3031ms
Elapsed time: 4032ms
Elapsed time: 5044ms
...