@oscarpalmer/timer 0.44.0 → 0.45.0

package/dist/constants.d.mts

@@ -1,26 +1,15 @@
-import { Timer, TimerName, 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 STATES: TimerStates;
 declare const TYPE_REPEAT: TimerName;
 declare const TYPE_WAIT: TimerName;
 declare const TYPE_WHEN: TimerName;
@@ -30,4 +19,4 @@ 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

@@ -2,5 +2,8 @@ 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

@@ -31,6 +31,8 @@ type Timer = {
   get active(): boolean;
   /**
    * Is the timer destroyed?
+   *
+   * @deprecated Timers take care of their own cleanup; this always returns `false`
    */
   get destroyed(): boolean;
   /**
@@ -47,6 +49,8 @@ type Timer = {
   continue(): Timer;
   /**
    * Destroy the timer
+   *
+   * @deprecated Timers take care of their own cleanup
    */
   destroy(): void;
   /**
@@ -80,6 +84,8 @@ type When = {
   get active(): boolean;
   /**
    * Is the timer destroyed?
+   *
+   * @deprecated Timers take care of their own cleanup; this always returns `false`
    */
   get destroyed(): boolean;
   /**
@@ -96,6 +102,8 @@ type When = {
   continue(): When;
   /**
    * Destroys the timer _(and stops it,if it was running)_
+   *
+   * @deprecated Timers take care of their own cleanup
    */
   destroy(): void;
   /**
@@ -135,40 +143,11 @@ type WhenOptions = {
 //#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`)_
+   * All active timers _(or `undefined` if debugging is not enabled)_
    */
-  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>;
+  var _oscarpalmer_timers: Timer[] | undefined;
+}
 //#endregion
 //#region src/is.d.ts
 /**
@@ -224,4 +203,4 @@ declare function wait(callback: () => void, time?: number): Timer;
  */
 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 };
+export { type RepeatOptions, type Timer, type TimerOptions, type When, type WhenOptions, isRepeated, isTimer, isWaited, isWhen, repeat, wait, when };