@oscarpalmer/timer 0.34.0 → 0.36.0

package/dist/constants.cjs

@@ -13,6 +13,7 @@ function calculate() {
 		requestAnimationFrame(step);
 	});
 }
+const defaultTimeout = 3e4;
 const activeTimers = /* @__PURE__ */ new Set();
 const intervalBuffer = 5;
 const destroyedMessage = "Timer has already been destroyed";
@@ -39,6 +40,7 @@ exports.WORK_RESTART = WORK_RESTART;
 exports.WORK_START = WORK_START;
 exports.WORK_STOP = WORK_STOP;
 exports.activeTimers = activeTimers;
+exports.defaultTimeout = defaultTimeout;
 exports.destroyedMessage = destroyedMessage;
 exports.hiddenTimers = hiddenTimers;
 exports.intervalBuffer = intervalBuffer;

package/dist/constants.js

@@ -13,6 +13,7 @@ function calculate() {
 		requestAnimationFrame(step);
 	});
 }
+const defaultTimeout = 3e4;
 const activeTimers = /* @__PURE__ */ new Set();
 const intervalBuffer = 5;
 const destroyedMessage = "Timer has already been destroyed";
@@ -30,4 +31,4 @@ let milliseconds = 1e3 / 60;
 calculate().then((value) => {
 	milliseconds = value;
 });
-export { TYPE_REPEAT, TYPE_WAIT, TYPE_WHEN, WORK_CONTINUE, WORK_PAUSE, WORK_RESTART, WORK_START, WORK_STOP, activeTimers, destroyedMessage, hiddenTimers, intervalBuffer, milliseconds, startedMessage };
+export { TYPE_REPEAT, TYPE_WAIT, TYPE_WHEN, WORK_CONTINUE, WORK_PAUSE, WORK_RESTART, WORK_START, WORK_STOP, activeTimers, defaultTimeout, destroyedMessage, hiddenTimers, intervalBuffer, milliseconds, startedMessage };

package/dist/get.cjs

@@ -1,10 +1,16 @@
 const require_rolldown_runtime = require("./rolldown_runtime.cjs");
+const require_constants = require("./constants.cjs");
 const __oscarpalmer_atoms_function = require_rolldown_runtime.__toESM(require("@oscarpalmer/atoms/function"));
 function getCallback(value) {
 	return typeof value === "function" ? value : __oscarpalmer_atoms_function.noop;
 }
+function getValidTimeout(value) {
+	return typeof value === "number" && value > 0 ? value : require_constants.defaultTimeout;
+}
 function getValidNumber(value, defaultValue) {
-	return typeof value === "number" && value > (defaultValue ?? 0) ? value : defaultValue ?? 0;
+	const actualDefault = defaultValue ?? 0;
+	return typeof value === "number" && value > actualDefault ? value : actualDefault;
 }
 exports.getCallback = getCallback;
 exports.getValidNumber = getValidNumber;
+exports.getValidTimeout = getValidTimeout;

package/dist/get.js

@@ -1,8 +1,13 @@
+import { defaultTimeout } from "./constants.js";
 import { noop } from "@oscarpalmer/atoms/function";
 function getCallback(value) {
 	return typeof value === "function" ? value : noop;
 }
+function getValidTimeout(value) {
+	return typeof value === "number" && value > 0 ? value : defaultTimeout;
+}
 function getValidNumber(value, defaultValue) {
-	return typeof value === "number" && value > (defaultValue ?? 0) ? value : defaultValue ?? 0;
+	const actualDefault = defaultValue ?? 0;
+	return typeof value === "number" && value > actualDefault ? value : actualDefault;
 }
-export { getCallback, getValidNumber };
+export { getCallback, getValidNumber, getValidTimeout };

package/dist/repeat.cjs

@@ -9,10 +9,10 @@ function repeat(callback, options) {
 		trace: new require_models.TimerTrace().stack
 	}, {
 		onAfter: require_get.getCallback(options?.onAfter),
-		onError: void 0,
+		onError: require_get.getCallback(options?.onTimeout),
 		count: require_get.getValidNumber(options?.count),
 		interval: require_get.getValidNumber(options?.interval, require_constants.milliseconds),
-		timeout: 0
+		timeout: require_get.getValidNumber(options?.timeout)
 	}, true);
 }
 exports.repeat = repeat;

package/dist/repeat.js

@@ -9,10 +9,10 @@ function repeat(callback, options) {
 		trace: new TimerTrace().stack
 	}, {
 		onAfter: getCallback(options?.onAfter),
-		onError: void 0,
+		onError: getCallback(options?.onTimeout),
 		count: getValidNumber(options?.count),
 		interval: getValidNumber(options?.interval, milliseconds),
-		timeout: 0
+		timeout: getValidNumber(options?.timeout)
 	}, true);
 }
 export { repeat };

package/dist/timer.cjs

@@ -3,6 +3,7 @@ const require_constants = require("./constants.cjs");
 const require_work = require("./work.cjs");
 const __oscarpalmer_atoms_function = require_rolldown_runtime.__toESM(require("@oscarpalmer/atoms/function"));
 var Timer = class {
+	state;
 	get active() {
 		return this.state.active;
 	}

package/dist/timer.full.js

@@ -22,6 +22,8 @@ function calculate$1() {
         requestAnimationFrame(step);
     });
 }
+//
+const defaultTimeout = 30_000;
 /**
  * A set of all active timers
  */
@@ -98,10 +100,14 @@ calculate().then((value) => {
 function getCallback(value) {
     return typeof value === 'function' ? value : noop;
 }
+function getValidTimeout(value) {
+    return typeof value === 'number' && value > 0 ? value : defaultTimeout;
+}
 function getValidNumber(value, defaultValue) {
-    return typeof value === 'number' && value > (defaultValue ?? 0)
+    const actualDefault = defaultValue ?? 0;
+    return typeof value === 'number' && value > actualDefault
         ? value
-        : defaultValue ?? 0;
+        : actualDefault;
 }
 
 /**
@@ -366,10 +372,10 @@ function repeat(callback, options) {
         trace: new TimerTrace().stack,
     }, {
         onAfter: getCallback(options?.onAfter),
-        onError: undefined,
+        onError: getCallback(options?.onTimeout),
         count: getValidNumber(options?.count),
         interval: getValidNumber(options?.interval, milliseconds),
-        timeout: 0,
+        timeout: getValidNumber(options?.timeout),
     }, true);
 }
 
@@ -462,7 +468,7 @@ class When {
             },
             count: getValidNumber(options?.count),
             interval: getValidNumber(options?.interval, milliseconds),
-            timeout: getValidNumber(options?.timeout),
+            timeout: getValidTimeout(options?.timeout),
         }, false);
     }
     /**

package/dist/timer.js

@@ -2,6 +2,7 @@ import { WORK_CONTINUE, WORK_PAUSE, WORK_RESTART, WORK_START, WORK_STOP } from "
 import { stop, work } from "./work.js";
 import { noop } from "@oscarpalmer/atoms/function";
 var Timer = class {
+	state;
 	get active() {
 		return this.state.active;
 	}

package/dist/when.cjs

@@ -57,7 +57,7 @@ var When = class {
 			},
 			count: require_get.getValidNumber(options?.count),
 			interval: require_get.getValidNumber(options?.interval, require_constants.milliseconds),
-			timeout: require_get.getValidNumber(options?.timeout)
+			timeout: require_get.getValidTimeout(options?.timeout)
 		}, false);
 	}
 	continue() {

package/dist/when.js

@@ -1,5 +1,5 @@
 import { TYPE_WHEN, destroyedMessage, milliseconds, startedMessage } from "./constants.js";
-import { getValidNumber } from "./get.js";
+import { getValidNumber, getValidTimeout } from "./get.js";
 import "./global.js";
 import { TimerTrace } from "./models.js";
 import { Timer } from "./timer.js";
@@ -56,7 +56,7 @@ var When = class {
 			},
 			count: getValidNumber(options?.count),
 			interval: getValidNumber(options?.interval, milliseconds),
-			timeout: getValidNumber(options?.timeout)
+			timeout: getValidTimeout(options?.timeout)
 		}, false);
 	}
 	continue() {

package/package.json

@@ -16,7 +16,7 @@
 		"dts-bundle-generator": "^9.5",
 		"glob": "^11",
 		"jsdom": "^26.1",
-		"rollup": "^4.47",
+		"rollup": "^4.49",
 		"tslib": "^2.8",
 		"typescript": "^5.9",
 		"vite": "npm:rolldown-vite@latest",
@@ -95,5 +95,5 @@
 	},
 	"type": "module",
 	"types": "types/index.d.cts",
-	"version": "0.34.0"
+	"version": "0.36.0"
 }

package/src/constants.ts

@@ -32,6 +32,10 @@ function calculate(): Promise<number> {
 	});
 }
 
+//
+
+export const defaultTimeout = 30_000;
+
 /**
  * A set of all active timers
  */

package/src/get.ts

@@ -1,12 +1,19 @@
 import {noop} from '@oscarpalmer/atoms/function';
 import type {GenericCallback} from '@oscarpalmer/atoms/models';
+import {defaultTimeout} from './constants';
 
 export function getCallback(value: unknown): GenericCallback {
 	return typeof value === 'function' ? (value as GenericCallback) : noop;
 }
 
+export function getValidTimeout(value: unknown): number {
+	return typeof value === 'number' && value > 0 ? value : defaultTimeout;
+}
+
 export function getValidNumber(value: unknown, defaultValue?: number): number {
-	return typeof value === 'number' && value > (defaultValue ?? 0)
+	const actualDefault = defaultValue ?? 0;
+
+	return typeof value === 'number' && value > actualDefault
 		? value
-		: defaultValue ?? 0;
+		: actualDefault;
 }

package/src/models.ts

@@ -4,19 +4,27 @@ import type {Timer} from './timer';
  * Options for a repeating timer
  */
 export type RepeatOptions = {
-	/**
-	 * Callback to be called when the timer has stopped, either manually or by completing its work
-	 */
-	onAfter: ((finished: boolean) => void) | undefined;
-	/**
-	 * How many times the timer should repeat
-	 */
-	count: number;
-	/**
-	 * The interval between each repeat
-	 */
-	interval: number;
-};
+		/**
+		 * Callback to be called when the timer has stopped, either manually or by completing its work
+		 */
+		onAfter: (finished: boolean) => void;
+		/**
+		 * Callback to be called after the timer has timed out
+		 */
+		onTimeout: () => void;
+		/**
+		 * How many times the timer should repeat
+		 */
+		count: number;
+		/**
+		 * The interval between each repeat
+		 */
+		interval: number;
+		/**
+		 * The timeout for the timer _(any value above `0` will enable the timeout)_
+		 */
+		timeout: number;
+	};
 
 export type TimerOptions = {
 	onAfter: ((finished: boolean) => void) | undefined;
@@ -52,19 +60,19 @@ export type TimerType = 'repeat' | 'wait' | 'when';
  * Options for a conditional timer
  */
 export type WhenOptions = {
-	/**
-	 * How many times the timer should check the condition
-	 */
-	count: number;
-	/**
-	 * Then interval between each condtional check
-	 */
-	interval: number;
-	/**
-	 * The timeout for the timer
-	 */
-	timeout: number;
-};
+		/**
+		 * How many times the timer should check the condition
+		 */
+		count: number;
+		/**
+		 * Then interval between each condtional check
+		 */
+		interval: number;
+		/**
+		 * The timeout for the timer _(any value above `0` will enable the timeout)_
+		 */
+		timeout: number;
+	};
 
 export type WhenState = {
 	promise: Promise<void>;

package/src/repeat.ts

@@ -19,10 +19,10 @@ export function repeat(
 		},
 		{
 			onAfter: getCallback(options?.onAfter),
-			onError: undefined,
+			onError: getCallback(options?.onTimeout),
 			count: getValidNumber(options?.count),
 			interval: getValidNumber(options?.interval, milliseconds),
-			timeout: 0,
+			timeout: getValidNumber(options?.timeout),
 		},
 		true,
 	);

package/src/when.ts

@@ -5,13 +5,14 @@ import {
 	startedMessage,
 	TYPE_WHEN,
 } from './constants';
-import {getValidNumber} from './get';
+import {getValidNumber, getValidTimeout} from './get';
 import './global';
 import {TimerTrace, type WhenOptions, type WhenState} from './models';
 import {Timer} from './timer';
 
 class When {
 	private readonly $timer = TYPE_WHEN;
+
 	private readonly state: WhenState = {
 		promise: undefined as never,
 		rejecter: undefined as never,
@@ -93,7 +94,7 @@ class When {
 				},
 				count: getValidNumber(options?.count),
 				interval: getValidNumber(options?.interval, milliseconds),
-				timeout: getValidNumber(options?.timeout),
+				timeout: getValidTimeout(options?.timeout),
 			},
 			false,
 		);

package/types/constants.d.cts

@@ -67,6 +67,7 @@ export type TimerState = {
 };
 export type TimerType = "repeat" | "wait" | "when";
 export type WorkHandlerType = "continue" | "pause" | "restart" | "start" | "stop";
+export declare const defaultTimeout = 30000;
 /**
  * A set of all active timers
  */

package/types/constants.d.ts

@@ -1,5 +1,6 @@
 import type { TimerType, WorkHandlerType } from './models';
 import type { Timer } from './timer';
+export declare const defaultTimeout = 30000;
 /**
  * A set of all active timers
  */

package/types/get.d.cts

@@ -5,6 +5,7 @@
  */
 export type GenericCallback = (...args: any[]) => any;
 export declare function getCallback(value: unknown): GenericCallback;
+export declare function getValidTimeout(value: unknown): number;
 export declare function getValidNumber(value: unknown, defaultValue?: number): number;
 
 export {};

package/types/get.d.ts

@@ -1,3 +1,4 @@
 import type { GenericCallback } from '@oscarpalmer/atoms/models';
 export declare function getCallback(value: unknown): GenericCallback;
+export declare function getValidTimeout(value: unknown): number;
 export declare function getValidNumber(value: unknown, defaultValue?: number): number;

package/types/index.d.cts

@@ -54,7 +54,11 @@ export type RepeatOptions = {
 	/**
 	 * Callback to be called when the timer has stopped, either manually or by completing its work
 	 */
-	onAfter: ((finished: boolean) => void) | undefined;
+	onAfter: (finished: boolean) => void;
+	/**
+	 * Callback to be called after the timer has timed out
+	 */
+	onTimeout: () => void;
 	/**
 	 * How many times the timer should repeat
 	 */
@@ -63,6 +67,10 @@ export type RepeatOptions = {
 	 * The interval between each repeat
 	 */
 	interval: number;
+	/**
+	 * The timeout for the timer _(any value above `0` will enable the timeout)_
+	 */
+	timeout: number;
 };
 export type TimerOptions = {
 	onAfter: ((finished: boolean) => void) | undefined;
@@ -96,7 +104,7 @@ export type WhenOptions = {
 	 */
 	interval: number;
 	/**
-	 * The timeout for the timer
+	 * The timeout for the timer _(any value above `0` will enable the timeout)_
 	 */
 	timeout: number;
 };

package/types/is.d.cts

@@ -79,7 +79,7 @@ export type WhenOptions = {
 	 */
 	interval: number;
 	/**
-	 * The timeout for the timer
+	 * The timeout for the timer _(any value above `0` will enable the timeout)_
 	 */
 	timeout: number;
 };

package/types/models.d.cts

@@ -54,7 +54,11 @@ export type RepeatOptions = {
 	/**
 	 * Callback to be called when the timer has stopped, either manually or by completing its work
 	 */
-	onAfter: ((finished: boolean) => void) | undefined;
+	onAfter: (finished: boolean) => void;
+	/**
+	 * Callback to be called after the timer has timed out
+	 */
+	onTimeout: () => void;
 	/**
 	 * How many times the timer should repeat
 	 */
@@ -63,6 +67,10 @@ export type RepeatOptions = {
 	 * The interval between each repeat
 	 */
 	interval: number;
+	/**
+	 * The timeout for the timer _(any value above `0` will enable the timeout)_
+	 */
+	timeout: number;
 };
 export type TimerOptions = {
 	onAfter: ((finished: boolean) => void) | undefined;
@@ -99,7 +107,7 @@ export type WhenOptions = {
 	 */
 	interval: number;
 	/**
-	 * The timeout for the timer
+	 * The timeout for the timer _(any value above `0` will enable the timeout)_
 	 */
 	timeout: number;
 };

package/types/models.d.ts

@@ -6,7 +6,11 @@ export type RepeatOptions = {
     /**
      * Callback to be called when the timer has stopped, either manually or by completing its work
      */
-    onAfter: ((finished: boolean) => void) | undefined;
+    onAfter: (finished: boolean) => void;
+    /**
+     * Callback to be called after the timer has timed out
+     */
+    onTimeout: () => void;
     /**
      * How many times the timer should repeat
      */
@@ -15,6 +19,10 @@ export type RepeatOptions = {
      * The interval between each repeat
      */
     interval: number;
+    /**
+     * The timeout for the timer _(any value above `0` will enable the timeout)_
+     */
+    timeout: number;
 };
 export type TimerOptions = {
     onAfter: ((finished: boolean) => void) | undefined;
@@ -51,7 +59,7 @@ export type WhenOptions = {
      */
     interval: number;
     /**
-     * The timeout for the timer
+     * The timeout for the timer _(any value above `0` will enable the timeout)_
      */
     timeout: number;
 };

package/types/repeat.d.cts

@@ -54,7 +54,11 @@ export type RepeatOptions = {
 	/**
 	 * Callback to be called when the timer has stopped, either manually or by completing its work
 	 */
-	onAfter: ((finished: boolean) => void) | undefined;
+	onAfter: (finished: boolean) => void;
+	/**
+	 * Callback to be called after the timer has timed out
+	 */
+	onTimeout: () => void;
 	/**
 	 * How many times the timer should repeat
 	 */
@@ -63,6 +67,10 @@ export type RepeatOptions = {
 	 * The interval between each repeat
 	 */
 	interval: number;
+	/**
+	 * The timeout for the timer _(any value above `0` will enable the timeout)_
+	 */
+	timeout: number;
 };
 export type TimerOptions = {
 	onAfter: ((finished: boolean) => void) | undefined;

package/types/when.d.cts

@@ -13,7 +13,7 @@ export type WhenOptions = {
 	 */
 	interval: number;
 	/**
-	 * The timeout for the timer
+	 * The timeout for the timer _(any value above `0` will enable the timeout)_
 	 */
 	timeout: number;
 };