@oscarpalmer/timer 0.46.0 → 0.48.0

package/dist/constants.d.mts

@@ -5,6 +5,7 @@ import { TimerName, TimerStates, WorkHandlerType } from "./models.mjs";
  */
 declare const BUFFER_INTERVAL = 5;
 declare const DEFAULT_TIMEOUT = 30000;
+declare const GLOBAL_NAME = "_oscarpalmer_timers";
 /**
  * Message to show when a when-timer is started
  */
@@ -19,4 +20,4 @@ declare const WORK_RESTART: WorkHandlerType;
 declare const WORK_START: WorkHandlerType;
 declare const WORK_STOP: WorkHandlerType;
 //#endregion
-export { BUFFER_INTERVAL, DEFAULT_TIMEOUT, MESSAGE_STARTED, STATES, TYPE_REPEAT, TYPE_WAIT, TYPE_WHEN, WORK_CONTINUE, WORK_PAUSE, WORK_RESTART, WORK_START, WORK_STOP };
+export { BUFFER_INTERVAL, DEFAULT_TIMEOUT, GLOBAL_NAME, MESSAGE_STARTED, STATES, TYPE_REPEAT, TYPE_WAIT, TYPE_WHEN, WORK_CONTINUE, WORK_PAUSE, WORK_RESTART, WORK_START, WORK_STOP };

package/dist/constants.mjs

@@ -4,6 +4,7 @@
 */
 const BUFFER_INTERVAL = 5;
 const DEFAULT_TIMEOUT = 3e4;
+const GLOBAL_NAME = "_oscarpalmer_timers";
 /**
 * Message to show when a when-timer is started
 */
@@ -21,4 +22,4 @@ const WORK_RESTART = "restart";
 const WORK_START = "start";
 const WORK_STOP = "stop";
 //#endregion
-export { BUFFER_INTERVAL, DEFAULT_TIMEOUT, MESSAGE_STARTED, STATES, TYPE_REPEAT, TYPE_WAIT, TYPE_WHEN, WORK_CONTINUE, WORK_PAUSE, WORK_RESTART, WORK_START, WORK_STOP };
+export { BUFFER_INTERVAL, DEFAULT_TIMEOUT, GLOBAL_NAME, MESSAGE_STARTED, STATES, TYPE_REPEAT, TYPE_WAIT, TYPE_WHEN, WORK_CONTINUE, WORK_PAUSE, WORK_RESTART, WORK_START, WORK_STOP };

package/dist/global.mjs

@@ -1,7 +1,8 @@
-import { STATES } from "./constants.mjs";
+import { GLOBAL_NAME, STATES } from "./constants.mjs";
 import { onVisibilityChange } from "./misc.mjs";
 //#region src/global.ts
-Object.defineProperty(globalThis, "_oscarpalmer_timers", { get() {
+/* istanbul ignore next */
+if (!("_oscarpalmer_timers" in globalThis)) Object.defineProperty(globalThis, GLOBAL_NAME, { get() {
 	return globalThis._oscarpalmer_timer_debug ? [...STATES.active].map((state) => state.timer) : [];
 } });
 document.addEventListener("visibilitychange", onVisibilityChange);

package/dist/index.d.mts

@@ -152,28 +152,32 @@ declare global {
 //#region src/is.d.ts
 /**
  * Is the value a repeating timer?
+ *
  * @param value Value to check
- * @returns `true` if the value is a repeating timer
+ * @returns `true` if the value is a repeating timer, otherwise `false`
  */
-declare function isRepeated(value: unknown): value is Timer;
+export declare function isRepeated(value: unknown): value is Timer;
 /**
  * Is the value a timer?
+ *
  * @param value Value to check
- * @returns `true` if the value is a timer
+ * @returns `true` if the value is a timer, otherwise `false`
  */
-declare function isTimer(value: unknown): value is Timer;
+export declare function isTimer(value: unknown): value is Timer;
 /**
  * Is the value a waiting timer?
+ *
  * @param value Value to check
- * @returns `true` if the value is a waiting timer
+ * @returns `true` if the value is a waiting timer, otherwise `false`
  */
-declare function isWaited(value: unknown): value is Timer;
+export declare function isWaited(value: unknown): value is Timer;
 /**
  * Is the value a conditional timer?
+ *
  * @param value Value to check
- * @returns `true` if the value is a conditional timer
+ * @returns `true` if the value is a conditional timer, otherwise `false`
  */
-declare function isWhen(value: unknown): value is When;
+export declare function isWhen(value: unknown): value is When;
 //#endregion
 //#region src/repeat.d.ts
 /**
@@ -181,9 +185,9 @@ declare function isWhen(value: unknown): value is When;
  *
  * @param callback Callback to run on each interval
  * @param options Timer options
- * @returns Timer instance
+ * @returns Repeating timer
  */
-declare function repeat(callback: (index: number) => void, options?: Partial<RepeatOptions>): Timer;
+export declare function repeat(callback: (index: number) => void, options?: Partial<RepeatOptions>): Timer;
 //#endregion
 //#region src/wait.d.ts
 /**
@@ -191,8 +195,9 @@ declare function repeat(callback: (index: number) => void, options?: Partial<Rep
  *
  * @param callback Callback to run when the timer has finished
  * @param time How long to wait for _(in milliseconds; defaults to screen refresh rate)_
+ * @returns Waiting timer
  */
-declare function wait(callback: () => void, time?: number): Timer;
+export declare function wait(callback: () => void, time?: number): Timer;
 //#endregion
 //#region src/when.d.ts
 /**
@@ -201,6 +206,6 @@ declare function wait(callback: () => void, time?: number): Timer;
  * @param options Timer options
  * @returns Timer instance
  */
-declare function when(condition: () => boolean, options?: Partial<WhenOptions>): When;
+export declare function when(condition: () => boolean, options?: Partial<WhenOptions>): When;
 //#endregion
-export { type RepeatOptions, type Timer, type TimerOptions, type When, type WhenOptions, isRepeated, isTimer, isWaited, isWhen, repeat, wait, when };
+export type { RepeatOptions, Timer, TimerOptions, When, WhenOptions };

package/dist/index.mjs

@@ -1,5 +1,6 @@
 //#region src/constants.ts
 const DEFAULT_TIMEOUT = 3e4;
+const GLOBAL_NAME = "_oscarpalmer_timers";
 /**
 * Message to show when a when-timer is started
 */
@@ -129,7 +130,8 @@ function updateStates(state, hide) {
 }
 //#endregion
 //#region src/global.ts
-Object.defineProperty(globalThis, "_oscarpalmer_timers", { get() {
+/* istanbul ignore next */
+if (!("_oscarpalmer_timers" in globalThis)) Object.defineProperty(globalThis, GLOBAL_NAME, { get() {
 	return globalThis._oscarpalmer_timer_debug ? [...STATES.active].map((state) => state.timer) : [];
 } });
 document.addEventListener("visibilitychange", onVisibilityChange);
@@ -140,32 +142,36 @@ function is(names, value) {
 }
 /**
 * Is the value a repeating timer?
+* 
 * @param value Value to check
-* @returns `true` if the value is a repeating timer
+* @returns `true` if the value is a repeating timer, otherwise `false`
 */
 function isRepeated(value) {
 	return is([TYPE_REPEAT], value);
 }
 /**
 * Is the value a timer?
+* 
 * @param value Value to check
-* @returns `true` if the value is a timer
+* @returns `true` if the value is a timer, otherwise `false`
 */
 function isTimer(value) {
 	return is([TYPE_REPEAT, TYPE_WAIT], value);
 }
 /**
 * Is the value a waiting timer?
+* 
 * @param value Value to check
-* @returns `true` if the value is a waiting timer
+* @returns `true` if the value is a waiting timer, otherwise `false`
 */
 function isWaited(value) {
 	return is([TYPE_WAIT], value);
 }
 /**
 * Is the value a conditional timer?
+* 
 * @param value Value to check
-* @returns `true` if the value is a conditional timer
+* @returns `true` if the value is a conditional timer, otherwise `false`
 */
 function isWhen(value) {
 	return is(["when"], value) && typeof value.start === "function";
@@ -235,7 +241,7 @@ function createTimer(name, pick, options, start) {
 *
 * @param callback Callback to run on each interval
 * @param options Timer options
-* @returns Timer instance
+* @returns Repeating timer
 */
 function repeat(callback, options) {
 	return createTimer(TYPE_REPEAT, {
@@ -256,6 +262,7 @@ function repeat(callback, options) {
 *
 * @param callback Callback to run when the timer has finished
 * @param time How long to wait for _(in milliseconds; defaults to screen refresh rate)_
+* @returns Waiting timer
 */
 function wait(callback, time) {
 	return createTimer(TYPE_WAIT, {

package/dist/is.d.mts

@@ -2,26 +2,30 @@ import { Timer, When } from "./models.mjs";
 //#region src/is.d.ts
 /**
  * Is the value a repeating timer?
+ *
  * @param value Value to check
- * @returns `true` if the value is a repeating timer
+ * @returns `true` if the value is a repeating timer, otherwise `false`
  */
 declare function isRepeated(value: unknown): value is Timer;
 /**
  * Is the value a timer?
+ *
  * @param value Value to check
- * @returns `true` if the value is a timer
+ * @returns `true` if the value is a timer, otherwise `false`
  */
 declare function isTimer(value: unknown): value is Timer;
 /**
  * Is the value a waiting timer?
+ *
  * @param value Value to check
- * @returns `true` if the value is a waiting timer
+ * @returns `true` if the value is a waiting timer, otherwise `false`
  */
 declare function isWaited(value: unknown): value is Timer;
 /**
  * Is the value a conditional timer?
+ *
  * @param value Value to check
- * @returns `true` if the value is a conditional timer
+ * @returns `true` if the value is a conditional timer, otherwise `false`
  */
 declare function isWhen(value: unknown): value is When;
 //#endregion

package/dist/is.mjs

@@ -5,32 +5,36 @@ function is(names, value) {
 }
 /**
 * Is the value a repeating timer?
+* 
 * @param value Value to check
-* @returns `true` if the value is a repeating timer
+* @returns `true` if the value is a repeating timer, otherwise `false`
 */
 function isRepeated(value) {
 	return is([TYPE_REPEAT], value);
 }
 /**
 * Is the value a timer?
+* 
 * @param value Value to check
-* @returns `true` if the value is a timer
+* @returns `true` if the value is a timer, otherwise `false`
 */
 function isTimer(value) {
 	return is([TYPE_REPEAT, TYPE_WAIT], value);
 }
 /**
 * Is the value a waiting timer?
+* 
 * @param value Value to check
-* @returns `true` if the value is a waiting timer
+* @returns `true` if the value is a waiting timer, otherwise `false`
 */
 function isWaited(value) {
 	return is([TYPE_WAIT], value);
 }
 /**
 * Is the value a conditional timer?
+* 
 * @param value Value to check
-* @returns `true` if the value is a conditional timer
+* @returns `true` if the value is a conditional timer, otherwise `false`
 */
 function isWhen(value) {
 	return is(["when"], value) && typeof value.start === "function";

package/dist/repeat.d.mts

@@ -6,7 +6,7 @@ import "./global.mjs";
  *
  * @param callback Callback to run on each interval
  * @param options Timer options
- * @returns Timer instance
+ * @returns Repeating timer
  */
 declare function repeat(callback: (index: number) => void, options?: Partial<RepeatOptions>): Timer;
 //#endregion

package/dist/repeat.mjs

@@ -9,7 +9,7 @@ import { createTimer } from "./timer.mjs";
 *
 * @param callback Callback to run on each interval
 * @param options Timer options
-* @returns Timer instance
+* @returns Repeating timer
 */
 function repeat(callback, options) {
 	return createTimer(TYPE_REPEAT, {

package/dist/wait.d.mts

@@ -6,6 +6,7 @@ import "./global.mjs";
  *
  * @param callback Callback to run when the timer has finished
  * @param time How long to wait for _(in milliseconds; defaults to screen refresh rate)_
+ * @returns Waiting timer
  */
 declare function wait(callback: () => void, time?: number): Timer;
 //#endregion

package/dist/wait.mjs

@@ -9,6 +9,7 @@ import { createTimer } from "./timer.mjs";
 *
 * @param callback Callback to run when the timer has finished
 * @param time How long to wait for _(in milliseconds; defaults to screen refresh rate)_
+* @returns Waiting timer
 */
 function wait(callback, time) {
 	return createTimer(TYPE_WAIT, {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@oscarpalmer/timer",
-	"version": "0.46.0",
+	"version": "0.48.0",
 	"description": "A better solution for timeout- and interval-based timers.",
 	"keywords": [
 		"requestAnimationFrame",
@@ -30,6 +30,10 @@
 			"types": "./dist/index.d.mts",
 			"default": "./dist/index.mjs"
 		},
+		"./is": {
+			"types": "./dist/is.d.mts",
+			"default": "./dist/is.mjs"
+		},
 		"./models": {
 			"types": "./dist/models.d.mts",
 			"default": "./dist/models.mjs"
@@ -56,14 +60,14 @@
 		"watch": "npx vite build --watch"
 	},
 	"dependencies": {
-		"@oscarpalmer/atoms": "^0.193"
+		"@oscarpalmer/atoms": "^0.199"
 	},
 	"devDependencies": {
-		"@oxlint/plugins": "^1.80",
+		"@oxlint/plugins": "^1.81",
 		"@types/node": "^26.4",
 		"@vitest/coverage-istanbul": "^4.1",
 		"jsdom": "^30",
-		"tsdown": "^0.22",
+		"tsdown": "^0.23",
 		"typescript": "^6",
 		"vite": "npm:@voidzero-dev/vite-plus-core@latest",
 		"vite-plus": "latest",

package/src/constants.ts

@@ -7,6 +7,8 @@ export const BUFFER_INTERVAL = 5;
 
 export const DEFAULT_TIMEOUT = 30_000;
 
+export const GLOBAL_NAME = '_oscarpalmer_timers';
+
 /**
  * Message to show when a when-timer is started
  */

package/src/global.ts

@@ -1,4 +1,4 @@
-import {STATES} from './constants';
+import {GLOBAL_NAME, STATES} from './constants';
 import {onVisibilityChange} from './misc';
 import type {Timer} from './models';
 
@@ -10,10 +10,15 @@ declare global {
 	var _oscarpalmer_timers: Timer[] | undefined;
 }
 
-Object.defineProperty(globalThis, '_oscarpalmer_timers', {
-	get() {
-		return globalThis._oscarpalmer_timer_debug ? [...STATES.active].map(state => state.timer) : [];
-	},
-});
+/* istanbul ignore next */
+if (!(GLOBAL_NAME in globalThis)) {
+	Object.defineProperty(globalThis, GLOBAL_NAME, {
+		get() {
+			return globalThis._oscarpalmer_timer_debug
+				? [...STATES.active].map(state => state.timer)
+				: [];
+		},
+	});
+}
 
 document.addEventListener('visibilitychange', onVisibilityChange);

package/src/is.ts

@@ -8,8 +8,9 @@ function is(names: string[], value: unknown) {
 
 /**
  * Is the value a repeating timer?
+ * 
  * @param value Value to check
- * @returns `true` if the value is a repeating timer
+ * @returns `true` if the value is a repeating timer, otherwise `false`
  */
 export function isRepeated(value: unknown): value is Timer {
 	return is([TYPE_REPEAT], value);
@@ -17,8 +18,9 @@ export function isRepeated(value: unknown): value is Timer {
 
 /**
  * Is the value a timer?
+ * 
  * @param value Value to check
- * @returns `true` if the value is a timer
+ * @returns `true` if the value is a timer, otherwise `false`
  */
 export function isTimer(value: unknown): value is Timer {
 	return is([TYPE_REPEAT, TYPE_WAIT], value);
@@ -26,8 +28,9 @@ export function isTimer(value: unknown): value is Timer {
 
 /**
  * Is the value a waiting timer?
+ * 
  * @param value Value to check
- * @returns `true` if the value is a waiting timer
+ * @returns `true` if the value is a waiting timer, otherwise `false`
  */
 export function isWaited(value: unknown): value is Timer {
 	return is([TYPE_WAIT], value);
@@ -35,8 +38,9 @@ export function isWaited(value: unknown): value is Timer {
 
 /**
  * Is the value a conditional timer?
+ * 
  * @param value Value to check
- * @returns `true` if the value is a conditional timer
+ * @returns `true` if the value is a conditional timer, otherwise `false`
  */
 export function isWhen(value: unknown): value is When {
 	return is([TYPE_WHEN], value) && typeof (value as When).start === 'function';

package/src/repeat.ts

@@ -9,7 +9,7 @@ import {createTimer} from './timer';
  *
  * @param callback Callback to run on each interval
  * @param options Timer options
- * @returns Timer instance
+ * @returns Repeating timer
  */
 export function repeat(callback: (index: number) => void, options?: Partial<RepeatOptions>): Timer {
 	return createTimer(

package/src/wait.ts

@@ -9,6 +9,7 @@ import {createTimer} from './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)_
+ * @returns Waiting timer
  */
 export function wait(callback: () => void, time?: number): Timer {
 	return createTimer(