@oscarpalmer/timer 0.43.0 → 0.45.0

package/dist/constants.d.mts

@@ -1,35 +1,22 @@
-import { Timer } from "./timer.mjs";
-import { TimerType, WorkHandlerType } from "./models.mjs";
-
+import { TimerName, TimerStates, WorkHandlerType } from "./models.mjs";
 //#region src/constants.d.ts
 /**
  * Buffer value to use when evaluating if a specific time is within a certain range
  */
 declare const BUFFER_INTERVAL = 5;
 declare const DEFAULT_TIMEOUT = 30000;
-/**
- * Message to show when a when-timer is destroyed
- */
-declare const MESSAGE_DESTROYED = "Timer has already been destroyed";
 /**
  * Message to show when a when-timer is started
  */
 declare const MESSAGE_STARTED = "Timer has already been started";
-/**
- * A set of all active timers
- */
-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 STATES: TimerStates;
+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;
 declare const WORK_START: WorkHandlerType;
 declare const WORK_STOP: WorkHandlerType;
 //#endregion
-export { BUFFER_INTERVAL, DEFAULT_TIMEOUT, MESSAGE_DESTROYED, MESSAGE_STARTED, TIMERS_ACTIVE, TIMERS_HIDDEN, TYPE_REPEAT, TYPE_WAIT, TYPE_WHEN, WORK_CONTINUE, WORK_PAUSE, WORK_RESTART, WORK_START, WORK_STOP };
+export { BUFFER_INTERVAL, DEFAULT_TIMEOUT, MESSAGE_STARTED, STATES, TYPE_REPEAT, TYPE_WAIT, TYPE_WHEN, WORK_CONTINUE, WORK_PAUSE, WORK_RESTART, WORK_START, WORK_STOP };

package/dist/constants.mjs

@@ -5,21 +5,13 @@
 const BUFFER_INTERVAL = 5;
 const DEFAULT_TIMEOUT = 3e4;
 /**
-* Message to show when a when-timer is destroyed
-*/
-const MESSAGE_DESTROYED = "Timer has already been destroyed";
-/**
 * Message to show when a when-timer is started
 */
 const MESSAGE_STARTED = "Timer has already been started";
-/**
-* A set of all active timers
-*/
-const TIMERS_ACTIVE = /* @__PURE__ */ new Set();
-/**
-* A set of timers that were paused due to the document being hidden
-*/
-const TIMERS_HIDDEN = /* @__PURE__ */ new Set();
+const STATES = {
+	active: /* @__PURE__ */ new Set(),
+	hidden: /* @__PURE__ */ new Set()
+};
 const TYPE_REPEAT = "repeat";
 const TYPE_WAIT = "wait";
 const TYPE_WHEN = "when";
@@ -29,4 +21,4 @@ const WORK_RESTART = "restart";
 const WORK_START = "start";
 const WORK_STOP = "stop";
 //#endregion
-export { BUFFER_INTERVAL, DEFAULT_TIMEOUT, MESSAGE_DESTROYED, MESSAGE_STARTED, TIMERS_ACTIVE, TIMERS_HIDDEN, TYPE_REPEAT, TYPE_WAIT, TYPE_WHEN, WORK_CONTINUE, WORK_PAUSE, WORK_RESTART, WORK_START, WORK_STOP };
+export { BUFFER_INTERVAL, DEFAULT_TIMEOUT, MESSAGE_STARTED, STATES, TYPE_REPEAT, TYPE_WAIT, TYPE_WHEN, WORK_CONTINUE, WORK_PAUSE, WORK_RESTART, WORK_START, WORK_STOP };

package/dist/global.d.mts

@@ -1,7 +1,9 @@
-import { Timer } from "./timer.mjs";
-
+import { Timer } from "./models.mjs";
 //#region src/global.d.ts
 declare global {
   var _oscarpalmer_timer_debug: boolean | undefined;
+  /**
+   * All active timers _(or `undefined` if debugging is not enabled)_
+   */
   var _oscarpalmer_timers: Timer[] | undefined;
 }

package/dist/global.mjs

@@ -1,18 +1,9 @@
-import { TIMERS_ACTIVE, TIMERS_HIDDEN, WORK_CONTINUE, WORK_PAUSE } from "./constants.mjs";
+import { STATES } from "./constants.mjs";
+import { onVisibilityChange } from "./misc.mjs";
 //#region src/global.ts
-if (globalThis._oscarpalmer_timers == null) Object.defineProperty(globalThis, "_oscarpalmer_timers", { get() {
-	return globalThis._oscarpalmer_timer_debug ? [...TIMERS_ACTIVE] : [];
+Object.defineProperty(globalThis, "_oscarpalmer_timers", { get() {
+	return globalThis._oscarpalmer_timer_debug ? [...STATES.active].map((state) => state.timer) : [];
 } });
-/* istanbul ignore next */
-document.addEventListener("visibilitychange", () => {
-	const from = document.hidden ? TIMERS_ACTIVE : TIMERS_HIDDEN;
-	const method = document.hidden ? WORK_PAUSE : WORK_CONTINUE;
-	const to = document.hidden ? TIMERS_HIDDEN : TIMERS_ACTIVE;
-	for (const timer of from) {
-		timer[method]();
-		to.add(timer);
-	}
-	from.clear();
-});
+document.addEventListener("visibilitychange", onVisibilityChange);
 //#endregion
 export {};

package/dist/index.d.mts

@@ -24,55 +24,15 @@ 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?
    */
   get active(): boolean;
   /**
    * Is the timer destroyed?
+   *
+   * @deprecated Timers take care of their own cleanup; this always returns `false`
    */
   get destroyed(): boolean;
   /**
@@ -83,13 +43,14 @@ 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)_
    */
   continue(): Timer;
   /**
    * Destroy the timer
+   *
+   * @deprecated Timers take care of their own cleanup
    */
   destroy(): void;
   /**
@@ -108,56 +69,23 @@ 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?
    */
   get active(): boolean;
   /**
    * Is the timer destroyed?
+   *
+   * @deprecated Timers take care of their own cleanup; this always returns `false`
    */
   get destroyed(): boolean;
   /**
@@ -168,13 +96,14 @@ 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)_
    */
   continue(): When;
   /**
    * Destroys the timer _(and stops it,if it was running)_
+   *
+   * @deprecated Timers take care of their own cleanup
    */
   destroy(): void;
   /**
@@ -192,14 +121,33 @@ declare class When {
    * Stops the timer _(if it was running)_
    */
   stop(): When;
-}
+};
 /**
- * Create a conditional timer
- * @param condition Condition to check
- * @param options Timer options
- * @returns Timer instance
+ * Options for a conditional timer
  */
-declare function when(condition: () => boolean, options?: Partial<WhenOptions>): When;
+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;
+  /**
+   * All active timers _(or `undefined` if debugging is not enabled)_
+   */
+  var _oscarpalmer_timers: Timer[] | undefined;
+}
 //#endregion
 //#region src/is.d.ts
 /**
@@ -246,4 +194,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, isRepeated, isTimer, isWaited, isWhen, repeat, wait, when };