@oscarpalmer/timer 0.37.0 → 0.38.0

package/src/work.ts

@@ -1,7 +1,7 @@
 import {
-	activeTimers,
-	intervalBuffer,
-	milliseconds,
+	TIMERS_ACTIVE,
+	BUFFER_INTERVAL,
+	MILLISECONDS,
 	TYPE_WAIT,
 	WORK_CONTINUE,
 	WORK_PAUSE,
@@ -9,12 +9,7 @@ import {
 	WORK_START,
 	WORK_STOP,
 } from './constants';
-import type {
-	TimerOptions,
-	TimerState,
-	WorkHandlerTimer,
-	WorkHandlerType,
-} from './models';
+import type {TimerOptions, TimerState, WorkHandlerTimer, WorkHandlerType} from './models';
 import type {Timer} from './timer';
 
 function finish(
@@ -25,7 +20,7 @@ function finish(
 ): void {
 	cancelAnimationFrame(state.frame as never);
 
-	activeTimers.delete(timer.instance);
+	TIMERS_ACTIVE.delete(timer.instance);
 
 	state.active = false;
 	state.elapsed = 0;
@@ -89,10 +84,7 @@ function run(
 			return;
 		}
 
-		if (
-			options.interval === milliseconds ||
-			state.elapsed >= options.interval - intervalBuffer
-		) {
+		if (options.interval === MILLISECONDS || state.elapsed >= options.interval - BUFFER_INTERVAL) {
 			if (options.count > -1) {
 				(state.callback as (index: number) => void)(state.index);
 			}
@@ -102,10 +94,7 @@ function run(
 			state.elapsed = 0;
 			state.index += 1;
 
-			if (
-				options.count === -1 ||
-				(options.count > 0 && state.index >= options.count)
-			) {
+			if (options.count === -1 || (options.count > 0 && state.index >= options.count)) {
 				finish(timer, state, options, true);
 
 				return;
@@ -124,23 +113,19 @@ function setState(type: WorkHandlerType, state: TimerState): void {
 	state.total = pausable ? state.total : 0;
 }
 
-export function stop(
-		timer: WorkHandlerTimer,
-		state: TimerState,
-		options: TimerOptions,
-	): Timer {
-		cancelAnimationFrame(state.frame as never);
+export function stop(timer: WorkHandlerTimer, state: TimerState, options: TimerOptions): Timer {
+	cancelAnimationFrame(state.frame as never);
 
-		activeTimers.delete(timer.instance);
+	TIMERS_ACTIVE.delete(timer.instance);
 
-		options.onAfter?.(false);
+	options.onAfter?.(false);
 
-		state.active = !stop;
-		state.frame = undefined;
-		state.paused = false;
+	state.active = !stop;
+	state.frame = undefined;
+	state.paused = false;
 
-		return timer.instance;
-	}
+	return timer.instance;
+}
 
 export function work(
 	type: WorkHandlerType,
@@ -171,7 +156,7 @@ export function work(
 		return pause(timer, state);
 	}
 
-	activeTimers.add(timer.instance);
+	TIMERS_ACTIVE.add(timer.instance);
 
 	const runner = run(timer, state, options);
 

package/types/constants.d.ts

@@ -1,26 +1,26 @@
 import type { TimerType, WorkHandlerType } from './models';
 import type { Timer } from './timer';
-export declare const defaultTimeout = 30000;
-/**
- * A set of all active timers
- */
-export declare const activeTimers: Set<Timer>;
 /**
  * Buffer value to use when evaluating if a specific time is within a certain range
  */
-export declare const intervalBuffer = 5;
+export declare const BUFFER_INTERVAL = 5;
+export declare const DEFAULT_TIMEOUT = 30000;
 /**
  * Message to show when a when-timer is destroyed
  */
-export declare const destroyedMessage = "Timer has already been destroyed";
+export declare const MESSAGE_DESTROYED = "Timer has already been destroyed";
 /**
- * A set of timers that were paused due to the document being hidden
+ * Message to show when a when-timer is started
  */
-export declare const hiddenTimers: Set<Timer>;
+export declare const MESSAGE_STARTED = "Timer has already been started";
 /**
- * Message to show when a when-timer is started
+ * A set of all active timers
+ */
+export declare const TIMERS_ACTIVE: Set<Timer>;
+/**
+ * A set of timers that were paused due to the document being hidden
  */
-export declare const startedMessage = "Timer has already been started";
+export declare const TIMERS_HIDDEN: Set<Timer>;
 export declare const TYPE_REPEAT: TimerType;
 export declare const TYPE_WAIT: TimerType;
 export declare const TYPE_WHEN: TimerType;
@@ -32,4 +32,4 @@ export declare const WORK_STOP: WorkHandlerType;
 /**
  * A calculated average of the refresh rate of the display _(in milliseconds)_
  */
-export declare let milliseconds: number;
+export declare let MILLISECONDS: number;

package/types/delay.d.ts

@@ -1,4 +1,6 @@
 /**
- * Create a delayed promise that resolves after a certain amount of time _(in milliseconds; defaults to screen refresh rate)_
+ * Create a delayed promise that resolves after a certain amount of time
+ * @param time How long to wait for _(in milliseconds; defaults to screen refresh rate)_
+ * @returns A promise that resolves after the delay
  */
 export declare function delay(time?: number): Promise<void>;

package/types/is.d.ts

@@ -2,17 +2,25 @@ import type { Timer } from './timer';
 import type { When } from './when';
 /**
  * Is the value a repeating timer?
+ * @param value Value to check
+ * @returns `true` if the value is a repeating 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
  */
 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
  */
 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
  */
 export declare function isWhen(value: unknown): value is When;

package/types/repeat.d.ts

@@ -3,6 +3,9 @@ import { type RepeatOptions } from './models';
 import { Timer } from './timer';
 /**
  * Create a repeating timer
+ * @param callback Callback to run on each interval
+ * @param options Timer options
+ * @returns Timer instance
  */
 export declare function repeat(callback: (index: number) => void, options?: Partial<RepeatOptions>): Timer;
 export type { RepeatOptions, Timer };

package/types/when.d.ts

@@ -32,17 +32,31 @@ declare class When {
      * Pauses the timer _(if it was running)_
      */
     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>;
     /**
      * Stops the timer _(if it was running)_
      */
     stop(): When;
     /**
-     * Starts the timer and returns a promise that resolves when the condition is met
+     * 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
+ * @param condition Condition to check
+ * @param options Timer options
+ * @returns Timer instance
  */
 export declare function when(condition: () => boolean, options?: Partial<WhenOptions>): When;
 export type { When };

package/dist/constants.cjs

@@ -1,53 +0,0 @@
-function calculate() {
-	return new Promise((resolve) => {
-		const values = [];
-		let last;
-		function step(now) {
-			if (last != null) values.push(now - last);
-			last = now;
-			if (values.length >= 10) {
-				const median = values.sort().slice(2, -2).reduce((first, second) => first + second, 0) / (values.length - 4);
-				resolve(median);
-			} else requestAnimationFrame(step);
-		}
-		requestAnimationFrame(step);
-	});
-}
-const defaultTimeout = 3e4;
-const activeTimers = /* @__PURE__ */ new Set();
-const intervalBuffer = 5;
-const destroyedMessage = "Timer has already been destroyed";
-const hiddenTimers = /* @__PURE__ */ new Set();
-const startedMessage = "Timer has already been started";
-const TYPE_REPEAT = "repeat";
-const TYPE_WAIT = "wait";
-const TYPE_WHEN = "when";
-const WORK_CONTINUE = "continue";
-const WORK_PAUSE = "pause";
-const WORK_RESTART = "restart";
-const WORK_START = "start";
-const WORK_STOP = "stop";
-let milliseconds = 1e3 / 60;
-calculate().then((value) => {
-	milliseconds = value;
-});
-exports.TYPE_REPEAT = TYPE_REPEAT;
-exports.TYPE_WAIT = TYPE_WAIT;
-exports.TYPE_WHEN = TYPE_WHEN;
-exports.WORK_CONTINUE = WORK_CONTINUE;
-exports.WORK_PAUSE = WORK_PAUSE;
-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;
-Object.defineProperty(exports, "milliseconds", {
-	enumerable: true,
-	get: function() {
-		return milliseconds;
-	}
-});
-exports.startedMessage = startedMessage;

package/dist/delay.cjs

@@ -1,15 +0,0 @@
-const require_constants = require("./constants.cjs");
-const require_get = require("./get.cjs");
-function delay(time) {
-	return new Promise((resolve) => {
-		const interval = require_get.getValidNumber(time, require_constants.milliseconds);
-		let start;
-		function step(now) {
-			start ??= now;
-			if (interval === require_constants.milliseconds || now - start >= interval - 5) resolve();
-			else requestAnimationFrame(step);
-		}
-		requestAnimationFrame(step);
-	});
-}
-exports.delay = delay;

package/dist/get.cjs

@@ -1,17 +0,0 @@
-const require_rolldown_runtime = require("./rolldown_runtime.cjs");
-const require_constants = require("./constants.cjs");
-let __oscarpalmer_atoms_function = require("@oscarpalmer/atoms/function");
-__oscarpalmer_atoms_function = require_rolldown_runtime.__toESM(__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) {
-	const actualDefault = defaultValue ?? 0;
-	return typeof value === "number" && value > actualDefault ? value : actualDefault;
-}
-exports.getCallback = getCallback;
-exports.getValidNumber = getValidNumber;
-exports.getValidTimeout = getValidTimeout;

package/dist/global.cjs

@@ -1,15 +0,0 @@
-const require_constants = require("./constants.cjs");
-if (globalThis._oscarpalmer_timers == null) Object.defineProperty(globalThis, "_oscarpalmer_timers", { get() {
-	return globalThis._oscarpalmer_timer_debug ? [...require_constants.activeTimers] : [];
-} });
-/* istanbul ignore next */
-document.addEventListener("visibilitychange", () => {
-	const from = document.hidden ? require_constants.activeTimers : require_constants.hiddenTimers;
-	const method = document.hidden ? require_constants.WORK_PAUSE : require_constants.WORK_CONTINUE;
-	const to = document.hidden ? require_constants.hiddenTimers : require_constants.activeTimers;
-	for (const timer of from) {
-		timer[method]();
-		to.add(timer);
-	}
-	from.clear();
-});

package/dist/index.cjs

@@ -1,14 +0,0 @@
-require("./global.cjs");
-const require_when = require("./when.cjs");
-const require_wait = require("./wait.cjs");
-const require_repeat = require("./repeat.cjs");
-const require_is = require("./is.cjs");
-const require_delay = require("./delay.cjs");
-exports.delay = require_delay.delay;
-exports.isRepeated = require_is.isRepeated;
-exports.isTimer = require_is.isTimer;
-exports.isWaited = require_is.isWaited;
-exports.isWhen = require_is.isWhen;
-exports.repeat = require_repeat.repeat;
-exports.wait = require_wait.wait;
-exports.when = require_when.when;

package/dist/is.cjs

@@ -1,20 +0,0 @@
-const require_constants = require("./constants.cjs");
-function is(names, value) {
-	return names.includes(value?.$timer);
-}
-function isRepeated(value) {
-	return is([require_constants.TYPE_REPEAT], value);
-}
-function isTimer(value) {
-	return is([require_constants.TYPE_REPEAT, require_constants.TYPE_WAIT], value);
-}
-function isWaited(value) {
-	return is([require_constants.TYPE_WAIT], value);
-}
-function isWhen(value) {
-	return is(["when"], value) && typeof value.then === "function";
-}
-exports.isRepeated = isRepeated;
-exports.isTimer = isTimer;
-exports.isWaited = isWaited;
-exports.isWhen = isWhen;

package/dist/models.cjs

@@ -1,7 +0,0 @@
-var TimerTrace = class extends Error {
-	constructor() {
-		super();
-		this.name = "TimerTrace";
-	}
-};
-exports.TimerTrace = TimerTrace;

package/dist/repeat.cjs

@@ -1,18 +0,0 @@
-const require_constants = require("./constants.cjs");
-const require_get = require("./get.cjs");
-require("./global.cjs");
-const require_models = require("./models.cjs");
-const require_timer = require("./timer.cjs");
-function repeat(callback, options) {
-	return new require_timer.Timer(require_constants.TYPE_REPEAT, {
-		callback: require_get.getCallback(callback),
-		trace: new require_models.TimerTrace().stack
-	}, {
-		onAfter: require_get.getCallback(options?.onAfter),
-		onError: require_get.getCallback(options?.onTimeout),
-		count: require_get.getValidNumber(options?.count),
-		interval: require_get.getValidNumber(options?.interval, require_constants.milliseconds),
-		timeout: require_get.getValidNumber(options?.timeout)
-	}, true);
-}
-exports.repeat = repeat;

package/dist/rolldown_runtime.cjs

@@ -1,21 +0,0 @@
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __copyProps = (to, from, except, desc) => {
-	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
-		key = keys[i];
-		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
-			get: ((k) => from[k]).bind(null, key),
-			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
-		});
-	}
-	return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
-	value: mod,
-	enumerable: true
-}) : target, mod));
-exports.__toESM = __toESM;

package/dist/timer.cjs

@@ -1,68 +0,0 @@
-const require_rolldown_runtime = require("./rolldown_runtime.cjs");
-const require_constants = require("./constants.cjs");
-const require_work = require("./work.cjs");
-let __oscarpalmer_atoms_function = require("@oscarpalmer/atoms/function");
-__oscarpalmer_atoms_function = require_rolldown_runtime.__toESM(__oscarpalmer_atoms_function);
-var Timer = class {
-	state;
-	get active() {
-		return this.state.active;
-	}
-	get destroyed() {
-		return this.state.destroyed;
-	}
-	get paused() {
-		return this.state.paused;
-	}
-	get trace() {
-		return globalThis._oscarpalmer_timer_debug ?? false ? this.state.trace : void 0;
-	}
-	constructor(type, state, options, start) {
-		this.options = options;
-		this.$timer = type;
-		this.state = {
-			...state,
-			active: false,
-			destroyed: false,
-			elapsed: 0,
-			frame: void 0,
-			index: 0,
-			paused: false,
-			total: 0
-		};
-		if (start) this.start();
-	}
-	continue() {
-		return this.#work(require_constants.WORK_CONTINUE);
-	}
-	destroy() {
-		this.state.destroyed = true;
-		this.options.onAfter = __oscarpalmer_atoms_function.noop;
-		this.options.onError = __oscarpalmer_atoms_function.noop;
-		this.state.callback = __oscarpalmer_atoms_function.noop;
-		if (!globalThis._oscarpalmer_timer_debug) this.state.trace = void 0;
-		require_work.stop({
-			instance: this,
-			type: this.$timer
-		}, this.state, this.options);
-	}
-	pause() {
-		return this.#work(require_constants.WORK_PAUSE);
-	}
-	restart() {
-		return this.#work(require_constants.WORK_RESTART);
-	}
-	start() {
-		return this.#work(require_constants.WORK_START);
-	}
-	stop() {
-		return this.#work(require_constants.WORK_STOP);
-	}
-	#work(type) {
-		return require_work.work(type, {
-			instance: this,
-			type: this.$timer
-		}, this.state, this.options);
-	}
-};
-exports.Timer = Timer;