@oscarpalmer/timer 0.44.0 → 0.46.0

package/dist/timer.mjs

@@ -1,31 +1,28 @@
 import { WORK_CONTINUE, WORK_PAUSE, WORK_RESTART, WORK_START, WORK_STOP } from "./constants.mjs";
-import { stop, work } from "./work.mjs";
+import { work } from "./work.mjs";
 import { noop } from "@oscarpalmer/atoms/function";
 //#region src/timer.ts
 function createTimer(name, pick, options, start) {
-	function worker(type) {
-		return work(type, {
-			name,
-			instance
-		}, state, options);
-	}
 	const state = {
 		...pick,
+		name,
+		options,
 		active: false,
 		destroyed: false,
 		elapsed: 0,
 		frame: void 0,
 		index: 0,
 		paused: false,
+		timer: void 0,
 		total: 0
 	};
 	const instance = {
-		continue: () => worker(WORK_CONTINUE),
-		destroy: () => destroyTimer(name, instance, state, options),
-		pause: () => worker(WORK_PAUSE),
-		restart: () => worker(WORK_RESTART),
-		start: () => worker(WORK_START),
-		stop: () => worker(WORK_STOP)
+		continue: () => work(WORK_CONTINUE, state),
+		destroy: noop,
+		pause: () => work(WORK_PAUSE, state),
+		restart: () => work(WORK_RESTART, state),
+		start: () => work(WORK_START, state),
+		stop: () => work(WORK_STOP, state)
 	};
 	Object.defineProperties(instance, {
 		$timer: {
@@ -34,11 +31,11 @@ function createTimer(name, pick, options, start) {
 		},
 		active: {
 			enumerable: true,
-			get: () => state.active
+			get: () => state.active && !state.paused
 		},
 		destroyed: {
 			enumerable: true,
-			get: () => state.destroyed
+			value: false
 		},
 		paused: {
 			enumerable: true,
@@ -49,19 +46,9 @@ function createTimer(name, pick, options, start) {
 			get: () => globalThis._oscarpalmer_timer_debug ?? false ? state.trace : void 0
 		}
 	});
-	if (start) instance.start();
-	return Object.freeze(instance);
-}
-function destroyTimer(name, instance, state, options) {
-	state.destroyed = true;
-	options.onAfter = noop;
-	options.onError = noop;
-	state.callback = noop;
-	if (!globalThis._oscarpalmer_timer_debug) state.trace = void 0;
-	stop({
-		instance,
-		name
-	}, state, options);
+	state.timer = Object.freeze(instance);
+	if (start) state.timer.start();
+	return state.timer;
 }
 //#endregion
 export { createTimer };

package/dist/wait.mjs

@@ -1,5 +1,5 @@
 import { TYPE_WAIT } from "./constants.mjs";
-import { getCallback, getValidNumber } from "./get.mjs";
+import { getCallback, getValidNumber } from "./misc.mjs";
 import "./global.mjs";
 import { TimerTrace } from "./models.mjs";
 import { createTimer } from "./timer.mjs";

package/dist/when.mjs

@@ -1,21 +1,13 @@
-import { MESSAGE_DESTROYED, MESSAGE_STARTED, TYPE_WHEN, WORK_CONTINUE } from "./constants.mjs";
-import { getValidNumber, getValidTimeout } from "./get.mjs";
+import { MESSAGE_STARTED, TYPE_WHEN, WORK_CONTINUE, WORK_PAUSE, WORK_STOP } from "./constants.mjs";
+import { getValidNumber, getValidTimeout } from "./misc.mjs";
 import "./global.mjs";
 import { TimerTrace } from "./models.mjs";
 import { createTimer } from "./timer.mjs";
 import { noop } from "@oscarpalmer/atoms/function";
 //#region src/when.ts
-function destroyWhen(state) {
-	state.timer?.destroy();
-	state.promise = void 0;
-	state.resolver = noop;
-	state.rejecter = noop;
-	state.timer = void 0;
-}
-function onAfter(instance, state) {
+function onAfter(state) {
 	if (state.result) state.resolver?.();
 	else state.rejecter?.();
-	instance.destroy();
 }
 function onCallback(condition, state) {
 	try {
@@ -27,16 +19,11 @@ function onCallback(condition, state) {
 		state.timer.stop();
 	}
 }
-function onError(instance, state) {
-	state.rejecter?.();
-	instance.destroy();
-}
 function onWhen(type, instance, state) {
 	state.timer?.[type]?.();
 	return instance;
 }
 function startWhen(state, resolve) {
-	if (state.timer == null) throw new Error(MESSAGE_DESTROYED);
 	if (state.started) throw new Error(MESSAGE_STARTED);
 	state.started = true;
 	state.timer.start();
@@ -64,18 +51,18 @@ function when(condition, options) {
 		callback: () => onCallback(condition, state),
 		trace: new TimerTrace().stack
 	}, {
-		onAfter: () => onAfter(instance, state),
-		onError: () => onError(instance, state),
+		onAfter: () => onAfter(state),
+		onError: () => state.rejecter?.(),
 		count: getValidNumber(options?.count),
 		interval: getValidNumber(options?.interval),
 		timeout: getValidTimeout(options?.timeout)
 	}, false);
 	instance = {
 		continue: () => onWhen(WORK_CONTINUE, instance, state),
-		destroy: () => destroyWhen(state),
-		pause: () => onWhen("pause", instance, state),
+		destroy: noop,
+		pause: () => onWhen(WORK_PAUSE, instance, state),
 		start: (resolve) => startWhen(state, resolve),
-		stop: () => onWhen("stop", instance, state)
+		stop: () => onWhen(WORK_STOP, instance, state)
 	};
 	Object.defineProperties(instance, {
 		$timer: {
@@ -84,15 +71,15 @@ function when(condition, options) {
 		},
 		active: {
 			enumerable: true,
-			get: () => state.timer?.active ?? false
+			get: () => state.timer.active
 		},
 		destroyed: {
 			enumerable: true,
-			get: () => state.timer == null
+			value: false
 		},
 		paused: {
 			enumerable: true,
-			get: () => state.timer?.paused ?? false
+			get: () => state.timer.paused
 		},
 		trace: {
 			enumerable: true,

package/dist/work.d.mts

@@ -1,6 +1,6 @@
-import { Timer, TimerOptions, TimerState, WorkHandlerTimer, WorkHandlerType } from "./models.mjs";
+import { Timer, TimerState, WorkHandlerType } from "./models.mjs";
 //#region src/work.d.ts
-declare function stop(timer: WorkHandlerTimer, state: TimerState, options: TimerOptions): Timer;
-declare function work(type: WorkHandlerType, timer: WorkHandlerTimer, state: TimerState, options: TimerOptions): Timer;
+declare function stop(state: TimerState): Timer;
+declare function work(type: WorkHandlerType, state: TimerState, hide?: boolean): Timer;
 //#endregion
 export { stop, work };

package/dist/work.mjs

@@ -1,47 +1,39 @@
-import { TIMERS_ACTIVE, WORK_PAUSE, WORK_STOP } from "./constants.mjs";
+import { WORK_PAUSE } from "./constants.mjs";
+import { updateStates } from "./misc.mjs";
 //#region src/work.ts
-function finish(timer, state, options, success) {
+function finish(state, success) {
+	updateStates(state);
 	cancelAnimationFrame(state.frame);
-	TIMERS_ACTIVE.delete(timer.instance);
 	state.active = false;
 	state.elapsed = 0;
 	state.frame = void 0;
-	if (timer.name === "wait") state.callback();
-	else options.onAfter?.(success);
+	if (state.name === "wait") state.callback();
+	else state.options.onAfter?.(success);
 }
 function ignore(type, state) {
-	if (state.destroyed) return type !== WORK_STOP;
 	if (state.paused) return type === "pause" || type === "start";
-	return state.active && type === "start";
+	return state.active && (type === "continue" || type === "start");
 }
-function pause(timer, state) {
-	cancelAnimationFrame(state.frame);
-	state.frame = void 0;
-	return timer.instance;
-}
-function run(timer, state, options) {
+function run(state) {
 	let last;
-	let start;
 	return function step(now) {
 		if (!state.active) return;
 		last ??= now;
-		start ??= now;
 		const difference = now - last;
 		state.elapsed += difference;
 		state.total += difference;
 		last = now;
-		if (options.timeout > 0 && state.total >= options.timeout) {
-			options.onError?.();
-			finish(timer, state, options, false);
+		if (state.options.timeout > 0 && state.total >= state.options.timeout) {
+			state.options.onError?.();
+			finish(state, false);
 			return;
 		}
-		if (options.interval === 0 || state.elapsed >= options.interval - 5) {
-			if (options.count > -1) state.callback(state.index);
-			start = now;
+		if (state.options.interval === 0 || state.elapsed >= state.options.interval - 5) {
+			if (state.options.count > -1) state.callback(state.index);
 			state.elapsed = 0;
 			state.index += 1;
-			if (options.count === -1 || options.count > 0 && state.index >= options.count) {
-				finish(timer, state, options, true);
+			if (state.options.count === -1 || state.options.count > 0 && state.index >= state.options.count) {
+				finish(state, true);
 				return;
 			}
 		}
@@ -54,30 +46,30 @@ function setState(type, state) {
 	state.index = pausable ? state.index : 0;
 	state.total = pausable ? state.total : 0;
 }
-function stop(timer, state, options) {
+function stop(state) {
+	updateStates(state);
 	cancelAnimationFrame(state.frame);
-	TIMERS_ACTIVE.delete(timer.instance);
-	options.onAfter?.(false);
-	state.active = !stop;
+	state.options.onAfter?.(false);
+	state.active = false;
 	state.frame = void 0;
 	state.paused = false;
-	return timer.instance;
+	return state.timer;
 }
-function work(type, timer, state, options) {
-	if (ignore(type, state)) return timer.instance;
+function work(type, state, hide) {
+	if (ignore(type, state)) return state.timer;
 	setState(type, state);
-	if (type === "stop") return stop(timer, state, options);
+	if (type === "stop") return stop(state);
 	if (type === "pause" || type === "restart") {
 		cancelAnimationFrame(state.frame);
 		state.frame = void 0;
 	}
 	state.active = true;
 	state.paused = type === WORK_PAUSE;
-	if (state.paused) return pause(timer, state);
-	TIMERS_ACTIVE.add(timer.instance);
-	const runner = run(timer, state, options);
+	updateStates(state, state.paused ? hide : false);
+	if (state.paused) return state.timer;
+	const runner = run(state);
 	state.frame = requestAnimationFrame(runner);
-	return timer.instance;
+	return state.timer;
 }
 //#endregion
 export { stop, work };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@oscarpalmer/timer",
-	"version": "0.44.0",
+	"version": "0.46.0",
 	"description": "A better solution for timeout- and interval-based timers.",
 	"keywords": [
 		"requestAnimationFrame",
@@ -30,10 +30,6 @@
 			"types": "./dist/index.d.mts",
 			"default": "./dist/index.mjs"
 		},
-		"./delay": {
-			"types": "./dist/delay.d.mts",
-			"default": "./dist/delay.mjs"
-		},
 		"./models": {
 			"types": "./dist/models.d.mts",
 			"default": "./dist/models.mjs"
@@ -64,7 +60,7 @@
 	},
 	"devDependencies": {
 		"@oxlint/plugins": "^1.80",
-		"@types/node": "^26.3",
+		"@types/node": "^26.4",
 		"@vitest/coverage-istanbul": "^4.1",
 		"jsdom": "^30",
 		"tsdown": "^0.22",

package/src/constants.ts

@@ -1,4 +1,4 @@
-import type {Timer, TimerName, WorkHandlerType} from './models';
+import type {TimerName, TimerStates, WorkHandlerType} from './models';
 
 /**
  * Buffer value to use when evaluating if a specific time is within a certain range
@@ -7,25 +7,15 @@ export const BUFFER_INTERVAL = 5;
 
 export const DEFAULT_TIMEOUT = 30_000;
 
-/**
- * Message to show when a when-timer is destroyed
- */
-export const MESSAGE_DESTROYED = 'Timer has already been destroyed';
-
 /**
  * Message to show when a when-timer is started
  */
 export const MESSAGE_STARTED = 'Timer has already been started';
 
-/**
- * A set of all active timers
- */
-export const TIMERS_ACTIVE = new Set<Timer>();
-
-/**
- * A set of timers that were paused due to the document being hidden
- */
-export const TIMERS_HIDDEN = new Set<Timer>();
+export const STATES: TimerStates = {
+	active: new Set(),
+	hidden: new Set(),
+};
 
 export const TYPE_REPEAT: TimerName = 'repeat';
 

package/src/global.ts

@@ -1,29 +1,19 @@
-import {TIMERS_ACTIVE, TIMERS_HIDDEN, WORK_CONTINUE, WORK_PAUSE} from './constants';
+import {STATES} from './constants';
+import {onVisibilityChange} from './misc';
 import type {Timer} from './models';
 
 declare global {
 	var _oscarpalmer_timer_debug: boolean | undefined;
+	/**
+	 * All active timers _(or `undefined` if debugging is not enabled)_
+	 */
 	var _oscarpalmer_timers: Timer[] | undefined;
 }
 
-if (globalThis._oscarpalmer_timers == null) {
-	Object.defineProperty(globalThis, '_oscarpalmer_timers', {
-		get() {
-			return globalThis._oscarpalmer_timer_debug ? [...TIMERS_ACTIVE] : [];
-		},
-	});
-}
-
-/* istanbul ignore next */
-document.addEventListener('visibilitychange', () => {
-	const from = document.hidden ? TIMERS_ACTIVE : TIMERS_HIDDEN;
-	const method = document.hidden ? WORK_PAUSE : WORK_CONTINUE;
-	const to = document.hidden ? TIMERS_HIDDEN : TIMERS_ACTIVE;
-
-	for (const timer of from) {
-		timer[method]();
-		to.add(timer);
-	}
-
-	from.clear();
+Object.defineProperty(globalThis, '_oscarpalmer_timers', {
+	get() {
+		return globalThis._oscarpalmer_timer_debug ? [...STATES.active].map(state => state.timer) : [];
+	},
 });
+
+document.addEventListener('visibilitychange', onVisibilityChange);

package/src/index.ts

@@ -1,6 +1,5 @@
 import './global';
 
-export {delay} from './delay';
 export {isRepeated, isTimer, isWaited, isWhen} from './is';
 export type {RepeatOptions, Timer, TimerOptions, When, WhenOptions} from './models';
 export {repeat} from './repeat';

package/src/misc.ts

@@ -0,0 +1,55 @@
+import {noop} from '@oscarpalmer/atoms/function';
+import type {GenericCallback} from '@oscarpalmer/atoms/models';
+import {DEFAULT_TIMEOUT, STATES, WORK_CONTINUE, WORK_PAUSE} from './constants';
+import type {TimerState} from './models';
+import {work} from './work';
+
+export function getCallback(value: unknown): GenericCallback {
+	return typeof value === 'function' ? (value as GenericCallback) : noop;
+}
+
+export function getValidNumber(value: unknown, defaultValue?: number): number {
+	const actualDefault = defaultValue ?? 0;
+
+	return typeof value === 'number' && value > actualDefault ? value : actualDefault;
+}
+
+export function getValidTimeout(value: unknown): number {
+	return typeof value === 'number' && value > 0 ? value : DEFAULT_TIMEOUT;
+}
+
+/* istanbul ignore next */
+export function onVisibilityChange(): void {
+	const from = document.hidden ? STATES.active : STATES.hidden;
+	const type = document.hidden ? WORK_PAUSE : WORK_CONTINUE;
+
+	for (const stored of from) {
+		const state = stored instanceof WeakRef ? stored.deref() : stored;
+
+		if (state == null) {
+			from.delete(stored as never);
+		} else {
+			work(type, state, true);
+		}
+	}
+}
+
+export function updateStates(state: TimerState, hide?: boolean): void {
+	STATES.active.delete(state);
+
+	/* istanbul ignore next */
+	STATES.hidden.delete(state.reference!);
+
+	if (hide == null) {
+		return;
+	}
+
+	/* istanbul ignore if */
+	if (hide) {
+		state.reference ??= new WeakRef(state);
+
+		STATES.hidden.add(state.reference);
+	} else {
+		STATES.active.add(state);
+	}
+}

package/src/models.ts

@@ -32,6 +32,8 @@ export type Timer = {
 
 	/**
 	 * Is the timer destroyed?
+	 * 
+	 * @deprecated Timers take care of their own cleanup; this always returns `false`
 	 */
 	get destroyed(): boolean;
 
@@ -52,6 +54,8 @@ export type Timer = {
 
 	/**
 	 * Destroy the timer
+	 * 
+	 * @deprecated Timers take care of their own cleanup
 	 */
 	destroy(): void;
 
@@ -91,11 +95,26 @@ export type TimerState = {
 	callback: () => void;
 	destroyed: boolean;
 	elapsed: number;
-	frame: number | undefined;
+	frame?: number;
 	index: number;
+	name: TimerName;
+	options: TimerOptions;
 	paused: boolean;
+	reference?: WeakRef<TimerState>;
+	timer: Timer;
 	total: number;
-	trace: string | undefined;
+	trace?: string;
+};
+
+export type TimerStates = {
+	/**
+	 * A set of all active timers
+	 */
+	active: Set<TimerState>;
+	/**
+	 * A set of timers that were paused due to the document being hidden
+	 */
+	hidden: Set<WeakRef<TimerState>>;
 };
 
 export class TimerTrace extends Error {
@@ -114,6 +133,8 @@ export type When = {
 
 	/**
 	 * Is the timer destroyed?
+	 * 
+	 * @deprecated Timers take care of their own cleanup; this always returns `false`
 	 */
 	get destroyed(): boolean;
 
@@ -134,6 +155,8 @@ export type When = {
 
 	/**
 	 * Destroys the timer _(and stops it,if it was running)_
+	 * 
+	 * @deprecated Timers take care of their own cleanup
 	 */
 	destroy(): void;
 

package/src/repeat.ts

@@ -1,5 +1,5 @@
 import {TYPE_REPEAT} from './constants';
-import {getCallback, getValidNumber} from './get';
+import {getCallback, getValidNumber} from './misc';
 import './global';
 import {type RepeatOptions, type Timer, TimerTrace} from './models';
 import {createTimer} from './timer';

package/src/timer.ts

@@ -1,7 +1,7 @@
 import {noop} from '@oscarpalmer/atoms/function';
 import {WORK_CONTINUE, WORK_PAUSE, WORK_RESTART, WORK_START, WORK_STOP} from './constants';
-import type {Timer, TimerName, TimerOptions, TimerState, WorkHandlerType} from './models';
-import {stop, work} from './work';
+import type {Timer, TimerName, TimerOptions, TimerState} from './models';
+import {work} from './work';
 
 export function createTimer(
 	name: TimerName,
@@ -9,36 +9,27 @@ export function createTimer(
 	options: TimerOptions,
 	start: boolean,
 ): Timer {
-	function worker(type: WorkHandlerType): Timer {
-		return work(
-			type,
-			{
-				name,
-				instance: instance as Timer,
-			},
-			state,
-			options,
-		);
-	}
-
 	const state: TimerState = {
 		...pick,
+		name,
+		options,
 		active: false,
 		destroyed: false,
 		elapsed: 0,
 		frame: undefined,
 		index: 0,
 		paused: false,
+		timer: undefined as never,
 		total: 0,
 	};
 
 	const instance = {
-		continue: () => worker(WORK_CONTINUE),
-		destroy: () => destroyTimer(name, instance as Timer, state, options),
-		pause: () => worker(WORK_PAUSE),
-		restart: () => worker(WORK_RESTART),
-		start: () => worker(WORK_START),
-		stop: () => worker(WORK_STOP),
+		continue: () => work(WORK_CONTINUE, state),
+		destroy: noop,
+		pause: () => work(WORK_PAUSE, state),
+		restart: () => work(WORK_RESTART, state),
+		start: () => work(WORK_START, state),
+		stop: () => work(WORK_STOP, state),
 	};
 
 	Object.defineProperties(instance, {
@@ -48,11 +39,11 @@ export function createTimer(
 		},
 		active: {
 			enumerable: true,
-			get: () => state.active,
+			get: () => state.active && !state.paused,
 		},
 		destroyed: {
 			enumerable: true,
-			get: () => state.destroyed,
+			value: false,
 		},
 		paused: {
 			enumerable: true,
@@ -64,28 +55,11 @@ export function createTimer(
 		},
 	});
 
-	if (start) {
-		instance.start();
-	}
-
-	return Object.freeze(instance) as Timer;
-}
+	state.timer = Object.freeze(instance) as Timer;
 
-function destroyTimer(
-	name: TimerName,
-	instance: Timer,
-	state: TimerState,
-	options: TimerOptions,
-): void {
-	state.destroyed = true;
-
-	options.onAfter = noop;
-	options.onError = noop;
-	state.callback = noop;
-
-	if (!globalThis._oscarpalmer_timer_debug) {
-		state.trace = undefined;
+	if (start) {
+		state.timer.start();
 	}
 
-	stop({instance, name}, state, options);
+	return state.timer;
 }

package/src/wait.ts

@@ -1,5 +1,5 @@
 import {TYPE_WAIT} from './constants';
-import {getCallback, getValidNumber} from './get';
+import {getCallback, getValidNumber} from './misc';
 import './global';
 import {type Timer, TimerTrace} from './models';
 import {createTimer} from './timer';