@oscarpalmer/timer 0.27.1 → 0.29.0

package/types/when.d.cts

@@ -1,112 +1,89 @@
 // Generated by dts-bundle-generator v9.5.1
 
-declare abstract class BasicTimer<State> {
-	protected readonly $timer: string;
-	protected readonly state: State;
-	constructor(type: "repeat" | "wait" | "when", state: State);
+declare class Timer {
+	#private;
+	protected readonly worker: WorkHandler;
+	protected readonly options: TimerOptions;
+	private readonly $timer;
+	protected readonly state: TimerState;
 	/**
-	 * Is the timer running?
+	 * Is the timer active?
 	 */
-	abstract readonly active: boolean;
+	get active(): boolean;
 	/**
 	 * Is the timer destroyed?
 	 */
-	abstract readonly destroyed: boolean;
+	get destroyed(): boolean;
 	/**
 	 * Is the timer paused?
 	 */
-	abstract readonly paused: boolean;
+	get paused(): boolean;
 	/**
-	 * Gets the traced location of the timer
+	 * Get the timer's origin _(if debugging is enabled)_
 	 */
-	abstract readonly trace: string | undefined;
-}
-declare class Timer extends BasicTimer<TimerState> {
-	private readonly options;
-	get active(): boolean;
-	get destroyed(): boolean;
-	get paused(): boolean;
 	get trace(): string | undefined;
-	constructor(type: "repeat" | "wait", state: TimerState, options: TimerOptions);
+	constructor(type: TimerType, worker: WorkHandler, state: Pick<TimerState, "callback" | "trace">, options: TimerOptions, start: boolean);
 	/**
-	 * Continues the timer _(if it was paused)_
+	 * Continue running the timer _(if it's paused)_
 	 */
 	continue(): Timer;
 	/**
-	 * Destroys the timer _(after stopping it, if it was running)_
+	 * Destroy the timer
 	 */
 	destroy(): void;
 	/**
-	 * Pauses the timer _(if it was running)_
+	 * Pause the timer _(if it's running)_
 	 */
 	pause(): Timer;
 	/**
-	 * Restarts the timer _(if it was running)_
+	 * Restart the timer _(or start it, if it's not running)_
 	 */
 	restart(): Timer;
 	/**
-	 * Starts the timer _(if it was stopped)_
+	 * Start the timer _(if it's not running)_
 	 */
 	start(): Timer;
 	/**
-	 * Stops the timer _(if it was running)_
+	 * Stop the timer _(if it's running)_
 	 */
 	stop(): Timer;
 }
-/**
- * Callback that runs after the timer has finished (or is stopped)
- * - `finished` is `true` if the timer was allowed to finish, and `false` if it was stopped
- */
-export type AfterCallback = (finished: boolean) => void;
-export type AnyCallback = (() => void) | IndexedCallback;
-/**
- * Callback that runs for each iteration of the timer
- */
-export type IndexedCallback = (index: number) => void;
-export type BaseOptions = {
-	/**
-	 * Interval between each callback
-	 */
+export type TimerOptions = {
+	onAfter: ((finished: boolean) => void) | undefined;
+	onError: (() => void) | undefined;
+	count: number;
 	interval: number;
-	/**
-	 * Maximum amount of time the timer may run for
-	 */
 	timeout: number;
 };
-export type OptionsWithCount = {
+export type TimerState = {
+	active: boolean;
+	callback: () => void;
+	destroyed: boolean;
+	elapsed: number;
+	frame: number | undefined;
+	index: number;
+	paused: boolean;
+	total: number;
+	trace: string | undefined;
+};
+export type TimerType = "repeat" | "wait" | "when";
+/**
+ * Options for a conditional timer
+ */
+export type WhenOptions = {
 	/**
-	 * How many times the timer should repeat
+	 * How many times the timer should check the condition
 	 */
 	count: number;
-} & BaseOptions;
-export type OptionsWithError = {
 	/**
-	 * Callback to run when an error occurs _(usually a timeout)_
+	 * Then interval between each condtional check
 	 */
-	errorCallback?: () => void;
-};
-export type RepeatOptions = {
+	interval: number;
 	/**
-	 * Callback to run after the timer has finished (or is stopped)
-	 * - `finished` is `true` if the timer was allowed to finish, and `false` if it was stopped
+	 * The timeout for the timer
 	 */
-	afterCallback?: AfterCallback;
-} & OptionsWithCount & OptionsWithError;
-export type TimerOptions = {} & RepeatOptions;
-export type TimerState = {
-	active: boolean;
-	callback: AnyCallback;
-	destroyed: boolean;
-	count?: number;
-	elapsed?: number;
-	frame?: number;
-	index?: number;
-	isRepeated: boolean;
-	minimum: number;
-	paused: boolean;
-	trace?: string;
+	timeout: number;
 };
-export type WhenOptions = {} & OptionsWithCount;
 export type WhenState = {
 	promise: Promise<void>;
 	rejecter?: () => void;
@@ -114,10 +91,30 @@ export type WhenState = {
 	started: boolean;
 	timer: Timer;
 };
-export declare class When extends BasicTimer<WhenState> {
+export type WorkHandler = (type: WorkHandlerType, timer: WorkHandlerTimer, state: TimerState, options: TimerOptions) => Timer;
+export type WorkHandlerTimer = {
+	instance: Timer;
+	type: TimerType;
+};
+export type WorkHandlerType = "continue" | "pause" | "restart" | "start" | "stop";
+export declare class When {
+	private readonly $timer;
+	private readonly state;
+	/**
+	 * Is the timer active?
+	 */
 	get active(): boolean;
+	/**
+	 * Is the timer destroyed?
+	 */
 	get destroyed(): boolean;
+	/**
+	 * Is the timer paused?
+	 */
 	get paused(): boolean;
+	/**
+	 * Get the timer's origin _(if debugging is enabled)_
+	 */
 	get trace(): string | undefined;
 	constructor(state: WhenState);
 	/**
@@ -142,8 +139,7 @@ export declare class When extends BasicTimer<WhenState> {
 	then(resolve?: (() => void) | null, reject?: (() => void) | null): Promise<void>;
 }
 /**
- * - Creates a promise that resolves when a condition is met
- * - If the condition is never met in a timely manner, the promise will reject
+ * Create a conditional timer
  */
 export declare function when(condition: () => boolean, options?: Partial<WhenOptions>): When;
 

package/types/when.d.ts

@@ -1,9 +1,22 @@
-import type { WhenOptions, WhenState } from './models';
-import { BasicTimer } from './timer';
-export declare class When extends BasicTimer<WhenState> {
+import { type WhenOptions, type WhenState } from './models';
+declare class When {
+    private readonly $timer;
+    private readonly state;
+    /**
+     * Is the timer active?
+     */
     get active(): boolean;
+    /**
+     * Is the timer destroyed?
+     */
     get destroyed(): boolean;
+    /**
+     * Is the timer paused?
+     */
     get paused(): boolean;
+    /**
+     * Get the timer's origin _(if debugging is enabled)_
+     */
     get trace(): string | undefined;
     constructor(state: WhenState);
     /**
@@ -28,7 +41,7 @@ export declare class When extends BasicTimer<WhenState> {
     then(resolve?: (() => void) | null, reject?: (() => void) | null): Promise<void>;
 }
 /**
- * - Creates a promise that resolves when a condition is met
- * - If the condition is never met in a timely manner, the promise will reject
+ * Create a conditional timer
  */
 export declare function when(condition: () => boolean, options?: Partial<WhenOptions>): When;
+export type { When };

package/types/work.d.cts

@@ -0,0 +1,78 @@
+// Generated by dts-bundle-generator v9.5.1
+
+declare class Timer {
+	#private;
+	protected readonly worker: WorkHandler;
+	protected readonly options: TimerOptions;
+	private readonly $timer;
+	protected readonly state: TimerState;
+	/**
+	 * Is the timer active?
+	 */
+	get active(): boolean;
+	/**
+	 * Is the timer destroyed?
+	 */
+	get destroyed(): boolean;
+	/**
+	 * Is the timer paused?
+	 */
+	get paused(): boolean;
+	/**
+	 * Get the timer's origin _(if debugging is enabled)_
+	 */
+	get trace(): string | undefined;
+	constructor(type: TimerType, worker: WorkHandler, state: Pick<TimerState, "callback" | "trace">, options: TimerOptions, start: boolean);
+	/**
+	 * Continue running the timer _(if it's paused)_
+	 */
+	continue(): Timer;
+	/**
+	 * Destroy the timer
+	 */
+	destroy(): void;
+	/**
+	 * Pause the timer _(if it's running)_
+	 */
+	pause(): Timer;
+	/**
+	 * Restart the timer _(or start it, if it's not running)_
+	 */
+	restart(): Timer;
+	/**
+	 * Start the timer _(if it's not running)_
+	 */
+	start(): Timer;
+	/**
+	 * Stop the timer _(if it's running)_
+	 */
+	stop(): Timer;
+}
+export type TimerOptions = {
+	onAfter: ((finished: boolean) => void) | undefined;
+	onError: (() => void) | undefined;
+	count: number;
+	interval: number;
+	timeout: number;
+};
+export type TimerState = {
+	active: boolean;
+	callback: () => void;
+	destroyed: boolean;
+	elapsed: number;
+	frame: number | undefined;
+	index: number;
+	paused: boolean;
+	total: number;
+	trace: string | undefined;
+};
+export type TimerType = "repeat" | "wait" | "when";
+export type WorkHandler = (type: WorkHandlerType, timer: WorkHandlerTimer, state: TimerState, options: TimerOptions) => Timer;
+export type WorkHandlerTimer = {
+	instance: Timer;
+	type: TimerType;
+};
+export type WorkHandlerType = "continue" | "pause" | "restart" | "start" | "stop";
+export declare function work(type: WorkHandlerType, timer: WorkHandlerTimer, state: TimerState, options: TimerOptions): Timer;
+
+export {};

package/types/work.d.ts

@@ -0,0 +1,3 @@
+import type { TimerOptions, TimerState, WorkHandlerTimer, WorkHandlerType } from './models';
+import type { Timer } from './timer';
+export declare function work(type: WorkHandlerType, timer: WorkHandlerTimer, state: TimerState, options: TimerOptions): Timer;

package/dist/functions.cjs

@@ -1,100 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const constants = require("./constants.cjs");
-function getOptions(options, isRepeated) {
-  return {
-    afterCallback: options.afterCallback,
-    count: getValueOrDefault(
-      options.count,
-      isRepeated ? Number.POSITIVE_INFINITY : 1
-    ),
-    errorCallback: options.errorCallback,
-    interval: getValueOrDefault(options.interval, constants.milliseconds, constants.milliseconds),
-    timeout: getValueOrDefault(
-      options.timeout,
-      isRepeated ? Number.POSITIVE_INFINITY : 3e4
-    )
-  };
-}
-function getValueOrDefault(value, defaultValue, minimum) {
-  return typeof value === "number" && value > (minimum ?? 0) ? value : defaultValue;
-}
-function work(type, timer, state, options) {
-  var _a;
-  if (state.destroyed && type !== "stop" || constants.beginTypes.has(type) && state.active || constants.endTypes.has(type) && !state.active) {
-    return timer;
-  }
-  const { count, interval, timeout } = options;
-  const { isRepeated, minimum } = state;
-  if (constants.endOrRestartTypes.has(type)) {
-    const isStop = type === "stop";
-    constants.activeTimers.delete(timer);
-    cancelAnimationFrame(state.frame);
-    if (isStop) {
-      (_a = options.afterCallback) == null ? void 0 : _a.call(options, false);
-    }
-    state.active = false;
-    state.frame = void 0;
-    state.paused = !isStop;
-    if (isStop) {
-      state.elapsed = void 0;
-      state.index = void 0;
-    }
-    return type === "restart" ? work("start", timer, state, options) : timer;
-  }
-  state.active = true;
-  state.paused = false;
-  const elapsed = type === "continue" ? +(state.elapsed ?? 0) : 0;
-  let index = type === "continue" ? +(state.index ?? 0) : 0;
-  state.elapsed = elapsed;
-  state.index = index;
-  const total = (count === Number.POSITIVE_INFINITY ? Number.POSITIVE_INFINITY : (count - index) * (interval > 0 ? interval : constants.milliseconds)) - elapsed;
-  let current;
-  let start;
-  function finish(finished, error) {
-    var _a2, _b;
-    constants.activeTimers.delete(timer);
-    state.active = false;
-    state.elapsed = void 0;
-    state.frame = void 0;
-    state.index = void 0;
-    if (error) {
-      (_a2 = options.errorCallback) == null ? void 0 : _a2.call(options);
-    }
-    (_b = options.afterCallback) == null ? void 0 : _b.call(options, finished);
-  }
-  function step(timestamp) {
-    if (!state.active) {
-      return;
-    }
-    current ?? (current = timestamp);
-    start ?? (start = timestamp);
-    const time = timestamp - current;
-    state.elapsed = elapsed + (current - start);
-    const finished = time - elapsed >= total;
-    if (timestamp - start >= timeout - elapsed) {
-      finish(finished, !finished);
-      return;
-    }
-    if (finished || time >= minimum) {
-      if (state.active) {
-        state.callback(isRepeated ? index : void 0);
-      }
-      index += 1;
-      state.index = index;
-      if (!finished && index < count) {
-        current = null;
-      } else {
-        finish(true, false);
-        return;
-      }
-    }
-    state.frame = requestAnimationFrame(step);
-  }
-  constants.activeTimers.add(timer);
-  state.frame = requestAnimationFrame(step);
-  return timer;
-}
-exports.getOptions = getOptions;
-exports.getValueOrDefault = getValueOrDefault;
-exports.work = work;

package/dist/functions.js

@@ -1,100 +0,0 @@
-import { beginTypes, endTypes, endOrRestartTypes, activeTimers, milliseconds } from "./constants.js";
-function getOptions(options, isRepeated) {
-  return {
-    afterCallback: options.afterCallback,
-    count: getValueOrDefault(
-      options.count,
-      isRepeated ? Number.POSITIVE_INFINITY : 1
-    ),
-    errorCallback: options.errorCallback,
-    interval: getValueOrDefault(options.interval, milliseconds, milliseconds),
-    timeout: getValueOrDefault(
-      options.timeout,
-      isRepeated ? Number.POSITIVE_INFINITY : 3e4
-    )
-  };
-}
-function getValueOrDefault(value, defaultValue, minimum) {
-  return typeof value === "number" && value > (minimum ?? 0) ? value : defaultValue;
-}
-function work(type, timer, state, options) {
-  var _a;
-  if (state.destroyed && type !== "stop" || beginTypes.has(type) && state.active || endTypes.has(type) && !state.active) {
-    return timer;
-  }
-  const { count, interval, timeout } = options;
-  const { isRepeated, minimum } = state;
-  if (endOrRestartTypes.has(type)) {
-    const isStop = type === "stop";
-    activeTimers.delete(timer);
-    cancelAnimationFrame(state.frame);
-    if (isStop) {
-      (_a = options.afterCallback) == null ? void 0 : _a.call(options, false);
-    }
-    state.active = false;
-    state.frame = void 0;
-    state.paused = !isStop;
-    if (isStop) {
-      state.elapsed = void 0;
-      state.index = void 0;
-    }
-    return type === "restart" ? work("start", timer, state, options) : timer;
-  }
-  state.active = true;
-  state.paused = false;
-  const elapsed = type === "continue" ? +(state.elapsed ?? 0) : 0;
-  let index = type === "continue" ? +(state.index ?? 0) : 0;
-  state.elapsed = elapsed;
-  state.index = index;
-  const total = (count === Number.POSITIVE_INFINITY ? Number.POSITIVE_INFINITY : (count - index) * (interval > 0 ? interval : milliseconds)) - elapsed;
-  let current;
-  let start;
-  function finish(finished, error) {
-    var _a2, _b;
-    activeTimers.delete(timer);
-    state.active = false;
-    state.elapsed = void 0;
-    state.frame = void 0;
-    state.index = void 0;
-    if (error) {
-      (_a2 = options.errorCallback) == null ? void 0 : _a2.call(options);
-    }
-    (_b = options.afterCallback) == null ? void 0 : _b.call(options, finished);
-  }
-  function step(timestamp) {
-    if (!state.active) {
-      return;
-    }
-    current ?? (current = timestamp);
-    start ?? (start = timestamp);
-    const time = timestamp - current;
-    state.elapsed = elapsed + (current - start);
-    const finished = time - elapsed >= total;
-    if (timestamp - start >= timeout - elapsed) {
-      finish(finished, !finished);
-      return;
-    }
-    if (finished || time >= minimum) {
-      if (state.active) {
-        state.callback(isRepeated ? index : void 0);
-      }
-      index += 1;
-      state.index = index;
-      if (!finished && index < count) {
-        current = null;
-      } else {
-        finish(true, false);
-        return;
-      }
-    }
-    state.frame = requestAnimationFrame(step);
-  }
-  activeTimers.add(timer);
-  state.frame = requestAnimationFrame(step);
-  return timer;
-}
-export {
-  getOptions,
-  getValueOrDefault,
-  work
-};