@oscarpalmer/timer 0.42.0 → 0.44.0

package/dist/index.mjs

@@ -46,42 +46,50 @@ function getInterval(value) {
 	return typeof value === "number" && value > 0 ? value : 0;
 }
 function getTimer(type, callback, time) {
-	const interval = getInterval(time);
-	function run(now) {
+	function run() {
+		const now = performance.now();
 		start ??= now;
 		if (interval === 0 || now - start >= interval - OFFSET) {
-			if (throttle) start = now;
+			start = throttle ? now : void 0;
 			callback(...args);
-		} else frame = requestAnimationFrame(run);
+		} else id = startTimer(run);
 	}
+	const interval = getInterval(time);
 	const throttle = type === TIMER_THROTTLE;
 	let args;
-	let frame;
+	let id;
 	let start;
 	const timer = (...parameters) => {
 		timer.cancel();
 		args = parameters;
-		frame = requestAnimationFrame(run);
+		if (throttle) run();
+		else id = startTimer(run);
 	};
 	timer.cancel = () => {
-		cancelAnimationFrame(frame);
+		clearTimer(id);
 	};
 	return timer;
 }
 const OFFSET = 5;
 const TIMER_THROTTLE = "throttle";
 const TIMER_WAIT = "wait";
+// istanbul ignore next
+const clearTimer = typeof cancelAnimationFrame === "function" ? cancelAnimationFrame : clearTimeout;
+// istanbul ignore next
+const startTimer = typeof requestAnimationFrame === "function" ? requestAnimationFrame : setTimeout;
 //#endregion
 //#region node_modules/@oscarpalmer/atoms/dist/promise/models.mjs
 const PROMISE_ABORT_EVENT = "abort";
 const PROMISE_ABORT_OPTIONS = { once: true };
 //#endregion
-//#region node_modules/@oscarpalmer/atoms/dist/promise/helpers.mjs
-function getNumberOrDefault(value) {
-	return typeof value === "number" && value > 0 ? value : 0;
+//#region node_modules/@oscarpalmer/atoms/dist/internal/number.mjs
+function getNumberOrDefault(value, defaultValue, minimum) {
+	return typeof value === "number" && !Number.isNaN(value) && value >= (minimum ?? 0) ? Math.floor(value) : defaultValue;
 }
+//#endregion
+//#region node_modules/@oscarpalmer/atoms/dist/promise/helpers.mjs
 function getPromiseOptions(input) {
-	if (typeof input === "number") return { time: getNumberOrDefault(input) };
+	if (typeof input === "number") return { time: getNumberOrDefault(input, 0) };
 	if (input instanceof AbortSignal) return {
 		signal: input,
 		time: 0
@@ -89,7 +97,7 @@ function getPromiseOptions(input) {
 	const options = typeof input === "object" && input !== null ? input : {};
 	return {
 		signal: options.signal instanceof AbortSignal ? options.signal : void 0,
-		time: getNumberOrDefault(options.time)
+		time: getNumberOrDefault(options.time, 0)
 	};
 }
 //#endregion
@@ -155,7 +163,7 @@ function isWaited(value) {
 * @returns `true` if the value is a conditional timer
 */
 function isWhen(value) {
-	return is(["when"], value) && typeof value.then === "function";
+	return is(["when"], value) && typeof value.start === "function";
 }
 //#endregion
 //#region node_modules/@oscarpalmer/atoms/dist/internal/function/misc.mjs
@@ -191,7 +199,7 @@ function finish(timer, state, options, success) {
 	state.active = false;
 	state.elapsed = 0;
 	state.frame = void 0;
-	if (timer.type === "wait") state.callback();
+	if (timer.name === "wait") state.callback();
 	else options.onAfter?.(success);
 }
 function ignore(type, state) {
@@ -266,108 +274,78 @@ function work(type, timer, state, options) {
 }
 //#endregion
 //#region src/timer.ts
-var Timer = class {
-	state;
-	/**
-	* Is the timer active?
-	*/
-	get active() {
-		return this.state.active;
-	}
-	/**
-	* Is the timer destroyed?
-	*/
-	get destroyed() {
-		return this.state.destroyed;
-	}
-	/**
-	* Is the timer paused?
-	*/
-	get paused() {
-		return this.state.paused;
-	}
-	/**
-	* Get the timer's origin _(if debugging is enabled)_
-	*/
-	get trace() {
-		return globalThis._oscarpalmer_timer_debug ?? false ? this.state.trace : void 0;
-	}
-	constructor(type, state, options, start) {
-		this.options = options;
-		Object.defineProperty(this, "$timer", { value: type });
-		this.state = {
-			...state,
-			active: false,
-			destroyed: false,
-			elapsed: 0,
-			frame: void 0,
-			index: 0,
-			paused: false,
-			total: 0
-		};
-		if (start) this.start();
-	}
-	/**
-	* Continue running the timer _(if it's paused)_
-	*/
-	continue() {
-		return this.#work(WORK_CONTINUE);
-	}
-	/**
-	* Destroy the timer
-	*/
-	destroy() {
-		this.state.destroyed = true;
-		this.options.onAfter = noop;
-		this.options.onError = noop;
-		this.state.callback = noop;
-		if (!globalThis._oscarpalmer_timer_debug) this.state.trace = void 0;
-		stop({
-			instance: this,
-			type: this.$timer
-		}, this.state, this.options);
-	}
-	/**
-	* Pause the timer _(if it's running)_
-	*/
-	pause() {
-		return this.#work(WORK_PAUSE);
-	}
-	/**
-	* Restart the timer _(or start it, if it's not running)_
-	*/
-	restart() {
-		return this.#work(WORK_RESTART);
-	}
-	/**
-	* Start the timer _(if it's not running)_
-	*/
-	start() {
-		return this.#work(WORK_START);
-	}
-	/**
-	* Stop the timer _(if it's running)_
-	*/
-	stop() {
-		return this.#work(WORK_STOP);
-	}
-	#work(type) {
+function createTimer(name, pick, options, start) {
+	function worker(type) {
 		return work(type, {
-			instance: this,
-			type: this.$timer
-		}, this.state, this.options);
+			name,
+			instance
+		}, state, options);
 	}
-};
+	const state = {
+		...pick,
+		active: false,
+		destroyed: false,
+		elapsed: 0,
+		frame: void 0,
+		index: 0,
+		paused: false,
+		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)
+	};
+	Object.defineProperties(instance, {
+		$timer: {
+			enumerable: false,
+			value: name
+		},
+		active: {
+			enumerable: true,
+			get: () => state.active
+		},
+		destroyed: {
+			enumerable: true,
+			get: () => state.destroyed
+		},
+		paused: {
+			enumerable: true,
+			get: () => state.paused
+		},
+		trace: {
+			enumerable: true,
+			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);
+}
 //#endregion
 //#region src/repeat.ts
 /**
 * Create a repeating timer
+*
 * @param callback Callback to run on each interval
 * @param options Timer options
 * @returns Timer instance
 */
 function repeat(callback, options) {
-	return new Timer(TYPE_REPEAT, {
+	return createTimer(TYPE_REPEAT, {
 		callback: getCallback(callback),
 		trace: new TimerTrace().stack
 	}, {
@@ -382,11 +360,12 @@ function repeat(callback, options) {
 //#region src/wait.ts
 /**
 * Create a waiting timer
+*
 * @param callback Callback to run when the timer has finished
 * @param time How long to wait for _(in milliseconds; defaults to screen refresh rate)_
 */
 function wait(callback, time) {
-	return new Timer(TYPE_WAIT, {
+	return createTimer(TYPE_WAIT, {
 		callback: getCallback(callback),
 		trace: new TimerTrace().stack
 	}, {
@@ -399,130 +378,43 @@ function wait(callback, time) {
 }
 //#endregion
 //#region src/when.ts
-var When = class {
-	state = {
-		promise: void 0,
-		rejecter: void 0,
-		resolver: void 0,
-		started: false,
-		timer: void 0
-	};
-	/**
-	* Is the timer active?
-	*/
-	get active() {
-		return this.state.timer?.active ?? false;
-	}
-	/**
-	* Is the timer destroyed?
-	*/
-	get destroyed() {
-		return this.state.timer == null;
-	}
-	/**
-	* Is the timer paused?
-	*/
-	get paused() {
-		return this.state.timer?.paused ?? false;
-	}
-	/**
-	* Get the timer's origin _(if debugging is enabled)_
-	*/
-	get trace() {
-		return globalThis._oscarpalmer_timer_debug ?? false ? this.state.timer?.trace : void 0;
-	}
-	constructor(condition, options) {
-		Object.defineProperty(this, "$timer", { value: TYPE_WHEN });
-		const { state } = this;
-		state.promise = new Promise((resolve, reject) => {
-			state.resolver = resolve;
-			state.rejecter = reject;
-		});
-		let result = false;
-		this.state.timer = new Timer(TYPE_WHEN, {
-			callback() {
-				try {
-					if (condition()) {
-						result = true;
-						state.timer.stop();
-					}
-				} catch {
-					state.timer.stop();
-				}
-			},
-			trace: new TimerTrace().stack
-		}, {
-			onAfter: () => {
-				if (result) state.resolver?.();
-				else state.rejecter?.();
-				this.destroy();
-			},
-			onError: () => {
-				state.rejecter?.();
-				this.destroy();
-			},
-			count: getValidNumber(options?.count),
-			interval: getValidNumber(options?.interval),
-			timeout: getValidTimeout(options?.timeout)
-		}, false);
-	}
-	/**
-	* Continues the timer _(if it was paused)_
-	*/
-	continue() {
-		this.state.timer?.continue();
-		return this;
-	}
-	/**
-	* Destroys the timer _(and stops it,if it was running)_
-	*/
-	destroy() {
-		const { state } = this;
-		state.timer?.destroy();
-		state.promise = void 0;
-		state.resolver = noop;
-		state.rejecter = noop;
-		state.timer = void 0;
-	}
-	/**
-	* Pauses the timer _(if it was running)_
-	*/
-	pause() {
-		this.state.timer?.pause();
-		return this;
-	}
-	/**
-	* Start the timer
-	* @param resolve Optional resolve callback
-	* @param reject Optional reject callback
-	* @returns Promise that resolves when the condition is met
-	*/
-	start(resolve, reject) {
-		const { state } = this;
-		if (state.timer == null) throw new Error(MESSAGE_DESTROYED);
-		if (state.started) throw new Error(MESSAGE_STARTED);
-		state.started = true;
-		state.timer.start();
-		return state.promise.then(resolve ?? noop, reject ?? noop);
-	}
-	/**
-	* Stops the timer _(if it was running)_
-	*/
-	stop() {
-		this.state.timer?.stop();
-		return this;
-	}
-	/**
-	* Start the timer
-	* @deprecated Use `start()` instead
-	* @param resolve Optional resolve callback
-	* @param reject Optional reject callback
-	* @returns Promise that resolves when the condition is met
-	*/
-	then(resolve, reject) {
-		return this.start(resolve, reject);
+function destroyWhen(state) {
+	state.timer?.destroy();
+	state.promise = void 0;
+	state.resolver = noop;
+	state.rejecter = noop;
+	state.timer = void 0;
+}
+function onAfter(instance, state) {
+	if (state.result) state.resolver?.();
+	else state.rejecter?.();
+	instance.destroy();
+}
+function onCallback(condition, state) {
+	try {
+		if (condition()) {
+			state.result = true;
+			state.timer.stop();
+		}
+	} catch {
+		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();
+	return state.promise.then(resolve);
+}
 /**
 * Create a conditional timer
 * @param condition Condition to check
@@ -530,7 +422,57 @@ var When = class {
 * @returns Timer instance
 */
 function when(condition, options) {
-	return new When(condition, options);
+	const state = {
+		promise: void 0,
+		result: false,
+		started: false,
+		timer: void 0
+	};
+	let instance;
+	state.promise = new Promise((resolve, reject) => {
+		state.resolver = resolve;
+		state.rejecter = reject;
+	});
+	state.timer = createTimer(TYPE_WHEN, {
+		callback: () => onCallback(condition, state),
+		trace: new TimerTrace().stack
+	}, {
+		onAfter: () => onAfter(instance, state),
+		onError: () => onError(instance, state),
+		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),
+		start: (resolve) => startWhen(state, resolve),
+		stop: () => onWhen("stop", instance, state)
+	};
+	Object.defineProperties(instance, {
+		$timer: {
+			enumerable: false,
+			value: TYPE_WHEN
+		},
+		active: {
+			enumerable: true,
+			get: () => state.timer?.active ?? false
+		},
+		destroyed: {
+			enumerable: true,
+			get: () => state.timer == null
+		},
+		paused: {
+			enumerable: true,
+			get: () => state.timer?.paused ?? false
+		},
+		trace: {
+			enumerable: true,
+			get: () => globalThis._oscarpalmer_timer_debug ?? false ? state.timer?.trace : void 0
+		}
+	});
+	return Object.freeze(instance);
 }
 //#endregion
 export { delay, isRepeated, isTimer, isWaited, isWhen, repeat, wait, when };

package/dist/is.d.mts

@@ -1,6 +1,4 @@
-import { Timer } from "./timer.mjs";
-import { When } from "./when.mjs";
-
+import { Timer, When } from "./models.mjs";
 //#region src/is.d.ts
 /**
  * Is the value a repeating timer?

package/dist/is.mjs

@@ -33,7 +33,7 @@ function isWaited(value) {
 * @returns `true` if the value is a conditional timer
 */
 function isWhen(value) {
-	return is(["when"], value) && typeof value.then === "function";
+	return is(["when"], value) && typeof value.start === "function";
 }
 //#endregion
 export { isRepeated, isTimer, isWaited, isWhen };

package/dist/models.d.mts

@@ -1,5 +1,3 @@
-import { Timer } from "./timer.mjs";
-
 //#region src/models.d.ts
 /**
  * Options for a repeating timer
@@ -26,6 +24,49 @@ type RepeatOptions = {
    */
   timeout: number;
 };
+type Timer = {
+  /**
+   * Is the timer active?
+   */
+  get active(): boolean;
+  /**
+   * Is the timer destroyed?
+   */
+  get destroyed(): boolean;
+  /**
+   * Is the timer paused?
+   */
+  get paused(): boolean;
+  /**
+   * Get the timer's origin _(if debugging is enabled)_
+   */
+  get trace(): string | undefined;
+  /**
+   * Continue running the timer _(if it's paused)_
+   */
+  continue(): Timer;
+  /**
+   * Destroy the timer
+   */
+  destroy(): void;
+  /**
+   * Pause the timer _(if it's running)_
+   */
+  pause(): Timer;
+  /**
+   * Restart the timer _(or start it, if it's not running)_
+   */
+  restart(): Timer;
+  /**
+   * Start the timer _(if it's not running)_
+   */
+  start(): Timer;
+  /**
+   * Stop the timer _(if it's running)_
+   */
+  stop(): Timer;
+};
+type TimerName = 'repeat' | 'wait' | 'when';
 type TimerOptions = {
   onAfter: ((finished: boolean) => void) | undefined;
   onError: (() => void) | undefined;
@@ -47,7 +88,47 @@ type TimerState = {
 declare class TimerTrace extends Error {
   constructor();
 }
-type TimerType = 'repeat' | 'wait' | 'when';
+type When = {
+  /**
+   * Is the timer active?
+   */
+  get active(): boolean;
+  /**
+   * Is the timer destroyed?
+   */
+  get destroyed(): boolean;
+  /**
+   * Is the timer paused?
+   */
+  get paused(): boolean;
+  /**
+   * Get the timer's origin _(if debugging is enabled)_
+   */
+  get trace(): string | undefined;
+  /**
+   * Continues the timer _(if it was paused)_
+   */
+  continue(): When;
+  /**
+   * Destroys the timer _(and stops it,if it was running)_
+   */
+  destroy(): void;
+  /**
+   * Pauses the timer _(if it was running)_
+   */
+  pause(): When;
+  /**
+   * Start the timer
+   *
+   * @param resolve Optional resolve callback
+   * @returns Promise that resolves when the condition is met
+   */
+  start(resolve?: (() => void) | null): Promise<void>;
+  /**
+   * Stops the timer _(if it was running)_
+   */
+  stop(): When;
+};
 /**
  * Options for a conditional timer
  */
@@ -69,14 +150,15 @@ type WhenState = {
   promise: Promise<void>;
   rejecter?: () => void;
   resolver?: () => void;
+  result: boolean;
   started: boolean;
   timer: Timer;
 };
 type WorkHandler = (type: WorkHandlerType, timer: WorkHandlerTimer, state: TimerState, options: TimerOptions) => Timer;
 type WorkHandlerTimer = {
   instance: Timer;
-  type: TimerType;
+  name: TimerName;
 };
 type WorkHandlerType = 'continue' | 'pause' | 'restart' | 'start' | 'stop';
 //#endregion
-export { RepeatOptions, TimerOptions, TimerState, TimerTrace, TimerType, WhenOptions, WhenState, WorkHandler, WorkHandlerTimer, WorkHandlerType };
+export { RepeatOptions, Timer, TimerName, TimerOptions, TimerState, TimerTrace, When, WhenOptions, WhenState, WorkHandler, WorkHandlerTimer, WorkHandlerType };

package/dist/repeat.d.mts

@@ -1,12 +1,13 @@
-import { Timer } from "./timer.mjs";
-import { RepeatOptions } from "./models.mjs";
+import { RepeatOptions, Timer } from "./models.mjs";
+import "./global.mjs";
 //#region src/repeat.d.ts
 /**
  * Create a repeating timer
+ *
  * @param callback Callback to run on each interval
  * @param options Timer options
  * @returns Timer instance
  */
 declare function repeat(callback: (index: number) => void, options?: Partial<RepeatOptions>): Timer;
 //#endregion
-export { type RepeatOptions, type Timer, repeat };
+export { repeat };

package/dist/repeat.mjs

@@ -2,16 +2,17 @@ import { TYPE_REPEAT } from "./constants.mjs";
 import { getCallback, getValidNumber } from "./get.mjs";
 import "./global.mjs";
 import { TimerTrace } from "./models.mjs";
-import { Timer } from "./timer.mjs";
+import { createTimer } from "./timer.mjs";
 //#region src/repeat.ts
 /**
 * Create a repeating timer
+*
 * @param callback Callback to run on each interval
 * @param options Timer options
 * @returns Timer instance
 */
 function repeat(callback, options) {
-	return new Timer(TYPE_REPEAT, {
+	return createTimer(TYPE_REPEAT, {
 		callback: getCallback(callback),
 		trace: new TimerTrace().stack
 	}, {