@oscarpalmer/timer 0.43.0 → 0.44.0

package/dist/constants.d.mts

@@ -1,6 +1,4 @@
-import { Timer } from "./timer.mjs";
-import { TimerType, WorkHandlerType } from "./models.mjs";
-
+import { Timer, TimerName, WorkHandlerType } from "./models.mjs";
 //#region src/constants.d.ts
 /**
  * Buffer value to use when evaluating if a specific time is within a certain range
@@ -23,9 +21,9 @@ declare const TIMERS_ACTIVE: Set<Timer>;
  * A set of timers that were paused due to the document being hidden
  */
 declare const TIMERS_HIDDEN: Set<Timer>;
-declare const TYPE_REPEAT: TimerType;
-declare const TYPE_WAIT: TimerType;
-declare const TYPE_WHEN: TimerType;
+declare const TYPE_REPEAT: TimerName;
+declare const TYPE_WAIT: TimerName;
+declare const TYPE_WHEN: TimerName;
 declare const WORK_CONTINUE: WorkHandlerType;
 declare const WORK_PAUSE: WorkHandlerType;
 declare const WORK_RESTART: WorkHandlerType;

package/dist/delay.d.mts

@@ -1,3 +1,2 @@
 import { delay } from "@oscarpalmer/atoms/promise/delay";
-import { PromiseOptions } from "@oscarpalmer/atoms/promise/models";
-export { type PromiseOptions, delay };
+export { delay };

package/dist/get.d.mts

@@ -1,5 +1,4 @@
 import { GenericCallback } from "@oscarpalmer/atoms/models";
-
 //#region src/get.d.ts
 declare function getCallback(value: unknown): GenericCallback;
 declare function getValidTimeout(value: unknown): number;

package/dist/global.d.mts

@@ -1,5 +1,4 @@
-import { Timer } from "./timer.mjs";
-
+import { Timer } from "./models.mjs";
 //#region src/global.d.ts
 declare global {
   var _oscarpalmer_timer_debug: boolean | undefined;

package/dist/index.d.mts

@@ -24,49 +24,7 @@ type RepeatOptions = {
    */
   timeout: number;
 };
-type TimerOptions = {
-  onAfter: ((finished: boolean) => void) | undefined;
-  onError: (() => void) | undefined;
-  count: number;
-  interval: number;
-  timeout: number;
-};
-type TimerState = {
-  active: boolean;
-  callback: () => void;
-  destroyed: boolean;
-  elapsed: number;
-  frame: number | undefined;
-  index: number;
-  paused: boolean;
-  total: number;
-  trace: string | undefined;
-};
-type TimerType = 'repeat' | 'wait' | 'when';
-/**
- * Options for a conditional timer
- */
-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 _(any value above `0` will enable the timeout)_
-   */
-  timeout: number;
-};
-//#endregion
-//#region src/timer.d.ts
-declare class Timer {
-  #private;
-  protected readonly options: TimerOptions;
-  private readonly $timer;
-  protected readonly state: TimerState;
+type Timer = {
   /**
    * Is the timer active?
    */
@@ -83,7 +41,6 @@ declare class Timer {
    * Get the timer's origin _(if debugging is enabled)_
    */
   get trace(): string | undefined;
-  constructor(type: TimerType, state: Pick<TimerState, 'callback' | 'trace'>, options: TimerOptions, start: boolean);
   /**
    * Continue running the timer _(if it's paused)_
    */
@@ -108,50 +65,15 @@ declare class Timer {
    * Stop the timer _(if it's running)_
    */
   stop(): Timer;
-}
-//#endregion
-//#region src/global.d.ts
-declare global {
-  var _oscarpalmer_timer_debug: boolean | undefined;
-  var _oscarpalmer_timers: Timer[] | undefined;
-}
-//#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
-   */
-  signal?: AbortSignal;
-  /**
-   * How long to wait for _(in milliseconds; defaults to `0`)_
-   */
-  time?: number;
 };
-//#endregion
-//#region node_modules/@oscarpalmer/atoms/dist/promise/delay.d.mts
-//#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
- */
-declare function delay(time?: number): Promise<void>; //#endregion
-//#endregion
-//#region src/when.d.ts
-declare class When {
-  private readonly $timer;
-  private readonly state;
+type TimerOptions = {
+  onAfter: ((finished: boolean) => void) | undefined;
+  onError: (() => void) | undefined;
+  count: number;
+  interval: number;
+  timeout: number;
+};
+type When = {
   /**
    * Is the timer active?
    */
@@ -168,7 +90,6 @@ declare class When {
    * Get the timer's origin _(if debugging is enabled)_
    */
   get trace(): string | undefined;
-  constructor(condition: () => boolean, options?: Partial<WhenOptions>);
   /**
    * Continues the timer _(if it was paused)_
    */
@@ -192,14 +113,62 @@ declare class When {
    * Stops the timer _(if it was running)_
    */
   stop(): When;
+};
+/**
+ * Options for a conditional timer
+ */
+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 _(any value above `0` will enable the timeout)_
+   */
+  timeout: number;
+};
+//#endregion
+//#region src/global.d.ts
+declare global {
+  var _oscarpalmer_timer_debug: boolean | undefined;
+  var _oscarpalmer_timers: Timer[] | undefined;
 }
+//#endregion
+//#region node_modules/@oscarpalmer/atoms/dist/promise/models.d.mts
 /**
- * Create a conditional timer
- * @param condition Condition to check
- * @param options Timer options
- * @returns Timer instance
+ * Options for a _Promise_-handling function
  */
-declare function when(condition: () => boolean, options?: Partial<WhenOptions>): When;
+type PromiseOptions = {
+  /**
+   * 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`)_
+   */
+  time?: number;
+};
+//#endregion
+//#region node_modules/@oscarpalmer/atoms/dist/promise/delay.d.mts
+//#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
+ */
+declare function delay(time?: number): Promise<void>;
 //#endregion
 //#region src/is.d.ts
 /**
@@ -246,4 +215,13 @@ declare function repeat(callback: (index: number) => void, options?: Partial<Rep
  */
 declare function wait(callback: () => void, time?: number): Timer;
 //#endregion
-export { type PromiseOptions, type RepeatOptions, type Timer, type When, delay, isRepeated, isTimer, isWaited, isWhen, repeat, wait, when };
+//#region src/when.d.ts
+/**
+ * Create a conditional timer
+ * @param condition Condition to check
+ * @param options Timer options
+ * @returns Timer instance
+ */
+declare function when(condition: () => boolean, options?: Partial<WhenOptions>): When;
+//#endregion
+export { type RepeatOptions, type Timer, type TimerOptions, type When, type WhenOptions, delay, isRepeated, isTimer, isWaited, isWhen, repeat, wait, when };

package/dist/index.mjs

@@ -199,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) {
@@ -274,99 +274,67 @@ function work(type, timer, state, options) {
 }
 //#endregion
 //#region src/timer.ts
-var Timer = class {
-	options;
-	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
 /**
@@ -377,7 +345,7 @@ var Timer = class {
 * @returns Timer instance
 */
 function repeat(callback, options) {
-	return new Timer(TYPE_REPEAT, {
+	return createTimer(TYPE_REPEAT, {
 		callback: getCallback(callback),
 		trace: new TimerTrace().stack
 	}, {
@@ -397,7 +365,7 @@ function repeat(callback, options) {
 * @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
 	}, {
@@ -410,120 +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
-	* @returns Promise that resolves when the condition is met
-	*/
-	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);
-	}
-	/**
-	* Stops the timer _(if it was running)_
-	*/
-	stop() {
-		this.state.timer?.stop();
-		return this;
+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
@@ -531,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?