@oscarpalmer/timer 0.42.0 → 0.44.0

package/README.md

@@ -64,7 +64,7 @@ function callback(index) {
 	// 'index' is the current step
 	// starts at 0, goes up to a maximum of count - 1
 	// for this example: 0 → 9
-};
+}
 ```
 
 When you create a repeated timer, you can also provide a callback to run when the timer stops, as below:

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,45 +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
-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?
    */
@@ -163,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)_
    */
@@ -178,31 +104,71 @@ declare class When {
   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>;
+  start(resolve?: (() => void) | null): Promise<void>;
   /**
    * Stops the timer _(if it was running)_
    */
   stop(): When;
+};
+/**
+ * Options for a conditional timer
+ */
+type WhenOptions = {
   /**
-   * 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
+   * 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)_
    */
-  then(resolve?: (() => void) | null, reject?: (() => void) | null): Promise<void>;
+  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
 /**
@@ -233,6 +199,7 @@ declare function isWhen(value: unknown): value is When;
 //#region src/repeat.d.ts
 /**
  * Create a repeating timer
+ *
  * @param callback Callback to run on each interval
  * @param options Timer options
  * @returns Timer instance
@@ -242,9 +209,19 @@ declare function repeat(callback: (index: number) => void, options?: Partial<Rep
 //#region src/wait.d.ts
 /**
  * Create a waiting timer
+ *
  * @param callback Callback to run when the timer has finished
  * @param time How long to wait for _(in milliseconds; defaults to screen refresh rate)_
  */
 declare function wait(callback: () => void, time?: number): Timer;
 //#endregion
-export { 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 };