@oscarpalmer/timer 0.42.0 → 0.43.0

package/README.md

@@ -64,7 +64,7 @@ function callback(index) {
 	// 'index' is the current step
 	// starts at 0, goes up to a maximum of count - 1
 	// for this example: 0 → 9
-};
+}
 ```
 
 When you create a repeated timer, you can also provide a callback to run when the timer stops, as below:

package/dist/index.d.mts

@@ -117,13 +117,16 @@ declare global {
 }
 //#endregion
 //#region node_modules/@oscarpalmer/atoms/dist/promise/models.d.mts
+/**
+ * Options for a _Promise_-handling function
+ */
 type PromiseOptions = {
   /**
-   * AbortSignal for aborting the promise; when aborted, the promise will reject with the reason of the signal
+   * AbortSignal for aborting the _Promise_; when aborted, the _Promise_ will reject with the reason of the signal
    */
   signal?: AbortSignal;
   /**
-   * How long to wait for (in milliseconds; defaults to `0`)
+   * How long to wait for _(in milliseconds; defaults to `0`)_
    */
   time?: number;
 };
@@ -132,12 +135,14 @@ type PromiseOptions = {
 //#region src/promise/delay.d.ts
 /**
  * Create a delayed promise that resolves after a certain amount of time, or rejects if aborted
+ *
  * @param options Options for the delay
  * @returns Delayed promise
  */
 declare function delay(options?: PromiseOptions): Promise<void>;
 /**
  * Create a delayed promise that resolves after a certain amount of time
+ *
  * @param time How long to wait for _(in milliseconds; defaults to `0`)_
  * @returns Delayed promise
  */
@@ -178,23 +183,15 @@ declare class When {
   pause(): When;
   /**
    * Start the timer
+   *
    * @param resolve Optional resolve callback
-   * @param reject Optional reject callback
    * @returns Promise that resolves when the condition is met
    */
-  start(resolve?: (() => void) | null, reject?: (() => void) | null): Promise<void>;
+  start(resolve?: (() => void) | null): Promise<void>;
   /**
    * Stops the timer _(if it was running)_
    */
   stop(): When;
-  /**
-   * 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?: (() => void) | null, reject?: (() => void) | null): Promise<void>;
 }
 /**
  * Create a conditional timer
@@ -233,6 +230,7 @@ declare function isWhen(value: unknown): value is When;
 //#region src/repeat.d.ts
 /**
  * Create a repeating timer
+ *
  * @param callback Callback to run on each interval
  * @param options Timer options
  * @returns Timer instance
@@ -242,9 +240,10 @@ declare function repeat(callback: (index: number) => void, options?: Partial<Rep
 //#region src/wait.d.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)_
  */
 declare function wait(callback: () => void, time?: number): Timer;
 //#endregion
-export { PromiseOptions, type RepeatOptions, type Timer, type When, delay, isRepeated, isTimer, isWaited, isWhen, repeat, wait, when };
+export { type PromiseOptions, type RepeatOptions, type Timer, type When, delay, isRepeated, isTimer, isWaited, isWhen, repeat, wait, when };

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
@@ -267,6 +275,7 @@ function work(type, timer, state, options) {
 //#endregion
 //#region src/timer.ts
 var Timer = class {
+	options;
 	state;
 	/**
 	* Is the timer active?
@@ -362,6 +371,7 @@ var Timer = class {
 //#region src/repeat.ts
 /**
 * Create a repeating timer
+*
 * @param callback Callback to run on each interval
 * @param options Timer options
 * @returns Timer instance
@@ -382,6 +392,7 @@ 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)_
 */
@@ -493,17 +504,17 @@ var When = class {
 	}
 	/**
 	* 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) {
+	start(resolve) {
 		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);
+		return state.promise.then(resolve);
 	}
 	/**
 	* Stops the timer _(if it was running)_
@@ -512,16 +523,6 @@ var When = class {
 		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);
-	}
 };
 /**
 * Create a conditional 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/repeat.d.mts

@@ -3,6 +3,7 @@ import { RepeatOptions } from "./models.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

package/dist/repeat.mjs

@@ -6,6 +6,7 @@ import { Timer } 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

package/dist/wait.d.mts

@@ -2,6 +2,7 @@ import { Timer } from "./timer.mjs";
 //#region src/wait.d.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)_
  */

package/dist/wait.mjs

@@ -6,6 +6,7 @@ import { Timer } from "./timer.mjs";
 //#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)_
 */

package/dist/when.d.mts

@@ -34,23 +34,15 @@ declare class When {
   pause(): When;
   /**
    * Start the timer
+   *
    * @param resolve Optional resolve callback
-   * @param reject Optional reject callback
    * @returns Promise that resolves when the condition is met
    */
-  start(resolve?: (() => void) | null, reject?: (() => void) | null): Promise<void>;
+  start(resolve?: (() => void) | null): Promise<void>;
   /**
    * Stops the timer _(if it was running)_
    */
   stop(): When;
-  /**
-   * 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?: (() => void) | null, reject?: (() => void) | null): Promise<void>;
 }
 /**
  * Create a conditional timer

package/dist/when.mjs

@@ -99,17 +99,17 @@ var When = class {
 	}
 	/**
 	* 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) {
+	start(resolve) {
 		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);
+		return state.promise.then(resolve);
 	}
 	/**
 	* Stops the timer _(if it was running)_
@@ -118,16 +118,6 @@ var When = class {
 		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);
-	}
 };
 /**
 * Create a conditional timer

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@oscarpalmer/timer",
-	"version": "0.42.0",
+	"version": "0.43.0",
 	"description": "A better solution for timeout- and interval-based timers.",
 	"keywords": [
 		"requestAnimationFrame",
@@ -56,14 +56,15 @@
 		"watch": "npx vite build --watch"
 	},
 	"dependencies": {
-		"@oscarpalmer/atoms": "^0.165"
+		"@oscarpalmer/atoms": "^0.187"
 	},
 	"devDependencies": {
-		"@types/node": "^25.5",
+		"@oxlint/plugins": "^1.66",
+		"@types/node": "^25.9",
 		"@vitest/coverage-istanbul": "^4.1",
-		"jsdom": "^28.1",
-		"tsdown": "^0.21",
-		"typescript": "^5.9",
+		"jsdom": "^29.1",
+		"tsdown": "^0.22",
+		"typescript": "^6",
 		"vite": "npm:@voidzero-dev/vite-plus-core@latest",
 		"vite-plus": "latest",
 		"vitest": "npm:@voidzero-dev/vite-plus-test@latest"

package/src/is.ts

@@ -40,5 +40,5 @@ export function isWaited(value: unknown): value is Timer {
  * @returns `true` if the value is a conditional timer
  */
 export function isWhen(value: unknown): value is When {
-	return is([TYPE_WHEN], value) && typeof (value as When).then === 'function';
+	return is([TYPE_WHEN], value) && typeof (value as When).start === 'function';
 }

package/src/repeat.ts

@@ -6,6 +6,7 @@ import {Timer} from './timer';
 
 /**
  * Create a repeating timer
+ *
  * @param callback Callback to run on each interval
  * @param options Timer options
  * @returns Timer instance

package/src/wait.ts

@@ -6,6 +6,7 @@ import {Timer} from './timer';
 
 /**
  * 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)_
  */

package/src/when.ts

@@ -131,11 +131,11 @@ class When {
 
 	/**
 	 * Start the timer
+	 *
 	 * @param resolve Optional resolve callback
-	 * @param reject Optional reject callback
 	 * @returns Promise that resolves when the condition is met
 	 */
-	start(resolve?: (() => void) | null, reject?: (() => void) | null): Promise<void> {
+	start(resolve?: (() => void) | null): Promise<void> {
 		const {state} = this;
 
 		if (state.timer == null) {
@@ -150,7 +150,7 @@ class When {
 
 		state.timer.start();
 
-		return state.promise.then(resolve ?? noop, reject ?? noop);
+		return state.promise.then(resolve);
 	}
 
 	/**
@@ -161,18 +161,6 @@ class When {
 
 		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
-	 */
-	// oxlint-disable-next-line no-thenable: Returning a promise-like object, so it's ok ;)
-	then(resolve?: (() => void) | null, reject?: (() => void) | null): Promise<void> {
-		return this.start(resolve, reject);
-	}
 }
 
 /**