@oscarpalmer/timer 0.31.0 → 0.33.0

package/types/is.d.cts

@@ -2,7 +2,6 @@
 
 declare class Timer {
 	#private;
-	protected readonly worker: WorkHandler;
 	protected readonly options: TimerOptions;
 	private readonly $timer;
 	protected readonly state: TimerState;
@@ -22,7 +21,7 @@ declare class Timer {
 	 * 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);
+	constructor(type: TimerType, state: Pick<TimerState, "callback" | "trace">, options: TimerOptions, start: boolean);
 	/**
 	 * Continue running the timer _(if it's paused)_
 	 */
@@ -67,19 +66,23 @@ export type TimerState = {
 	trace: string | undefined;
 };
 export type TimerType = "repeat" | "wait" | "when";
-export type WhenState = {
-	promise: Promise<void>;
-	rejecter?: () => void;
-	resolver?: () => void;
-	started: boolean;
-	timer: Timer;
-};
-export type WorkHandler = (type: WorkHandlerType, timer: WorkHandlerTimer, state: TimerState, options: TimerOptions) => Timer;
-export type WorkHandlerTimer = {
-	instance: Timer;
-	type: TimerType;
+/**
+ * Options for a conditional timer
+ */
+export 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
+	 */
+	timeout: number;
 };
-export type WorkHandlerType = "continue" | "pause" | "restart" | "start" | "stop";
 declare class When {
 	private readonly $timer;
 	private readonly state;
@@ -99,7 +102,7 @@ declare class When {
 	 * Get the timer's origin _(if debugging is enabled)_
 	 */
 	get trace(): string | undefined;
-	constructor(state: WhenState);
+	constructor(condition: () => boolean, options?: Partial<WhenOptions>);
 	/**
 	 * Continues the timer _(if it was paused)_
 	 */

package/types/models.d.cts

@@ -2,7 +2,6 @@
 
 declare class Timer {
 	#private;
-	protected readonly worker: WorkHandler;
 	protected readonly options: TimerOptions;
 	private readonly $timer;
 	protected readonly state: TimerState;
@@ -22,7 +21,7 @@ declare class Timer {
 	 * 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);
+	constructor(type: TimerType, state: Pick<TimerState, "callback" | "trace">, options: TimerOptions, start: boolean);
 	/**
 	 * Continue running the timer _(if it's paused)_
 	 */

package/types/repeat.d.cts

@@ -2,7 +2,6 @@
 
 export declare class Timer {
 	#private;
-	protected readonly worker: WorkHandler;
 	protected readonly options: TimerOptions;
 	private readonly $timer;
 	protected readonly state: TimerState;
@@ -22,7 +21,7 @@ export declare class Timer {
 	 * 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);
+	constructor(type: TimerType, state: Pick<TimerState, "callback" | "trace">, options: TimerOptions, start: boolean);
 	/**
 	 * Continue running the timer _(if it's paused)_
 	 */
@@ -84,12 +83,6 @@ export type TimerState = {
 	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";
 /**
  * Create a repeating timer
  */

package/types/repeat.d.ts

@@ -1,3 +1,4 @@
+import './global';
 import { type RepeatOptions } from './models';
 import { Timer } from './timer';
 /**

package/types/timer.d.cts

@@ -2,7 +2,6 @@
 
 export declare class Timer {
 	#private;
-	protected readonly worker: WorkHandler;
 	protected readonly options: TimerOptions;
 	private readonly $timer;
 	protected readonly state: TimerState;
@@ -22,7 +21,7 @@ export declare class Timer {
 	 * 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);
+	constructor(type: TimerType, state: Pick<TimerState, "callback" | "trace">, options: TimerOptions, start: boolean);
 	/**
 	 * Continue running the timer _(if it's paused)_
 	 */
@@ -67,11 +66,5 @@ export type TimerState = {
 	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 {};

package/types/timer.d.ts

@@ -1,7 +1,6 @@
-import type { TimerOptions, TimerState, TimerType, WorkHandler } from './models';
+import type { TimerOptions, TimerState, TimerType } from './models';
 export declare class Timer {
     #private;
-    protected readonly worker: WorkHandler;
     protected readonly options: TimerOptions;
     private readonly $timer;
     protected readonly state: TimerState;
@@ -21,7 +20,7 @@ export declare class Timer {
      * 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);
+    constructor(type: TimerType, state: Pick<TimerState, 'callback' | 'trace'>, options: TimerOptions, start: boolean);
     /**
      * Continue running the timer _(if it's paused)_
      */

package/types/wait.d.cts

@@ -2,7 +2,6 @@
 
 export declare class Timer {
 	#private;
-	protected readonly worker: WorkHandler;
 	protected readonly options: TimerOptions;
 	private readonly $timer;
 	protected readonly state: TimerState;
@@ -22,7 +21,7 @@ export declare class Timer {
 	 * 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);
+	constructor(type: TimerType, state: Pick<TimerState, "callback" | "trace">, options: TimerOptions, start: boolean);
 	/**
 	 * Continue running the timer _(if it's paused)_
 	 */
@@ -67,12 +66,6 @@ export type TimerState = {
 	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";
 /**
  * Create a waiting timer
  * @param callback Callback to run when the timer has finished

package/types/wait.d.ts

@@ -1,3 +1,4 @@
+import './global';
 import { Timer } from './timer';
 /**
  * Create a waiting timer

package/types/when.d.cts

@@ -1,72 +1,5 @@
 // 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";
 /**
  * Options for a conditional timer
  */
@@ -84,19 +17,6 @@ export type WhenOptions = {
 	 */
 	timeout: number;
 };
-export type WhenState = {
-	promise: Promise<void>;
-	rejecter?: () => void;
-	resolver?: () => void;
-	started: boolean;
-	timer: Timer;
-};
-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;
@@ -116,7 +36,7 @@ export declare class When {
 	 * Get the timer's origin _(if debugging is enabled)_
 	 */
 	get trace(): string | undefined;
-	constructor(state: WhenState);
+	constructor(condition: () => boolean, options?: Partial<WhenOptions>);
 	/**
 	 * Continues the timer _(if it was paused)_
 	 */

package/types/when.d.ts

@@ -1,4 +1,5 @@
-import { type WhenOptions, type WhenState } from './models';
+import './global';
+import { type WhenOptions } from './models';
 declare class When {
     private readonly $timer;
     private readonly state;
@@ -18,7 +19,7 @@ declare class When {
      * Get the timer's origin _(if debugging is enabled)_
      */
     get trace(): string | undefined;
-    constructor(state: WhenState);
+    constructor(condition: () => boolean, options?: Partial<WhenOptions>);
     /**
      * Continues the timer _(if it was paused)_
      */

package/types/work.d.cts

@@ -2,7 +2,6 @@
 
 declare class Timer {
 	#private;
-	protected readonly worker: WorkHandler;
 	protected readonly options: TimerOptions;
 	private readonly $timer;
 	protected readonly state: TimerState;
@@ -22,7 +21,7 @@ declare class Timer {
 	 * 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);
+	constructor(type: TimerType, state: Pick<TimerState, "callback" | "trace">, options: TimerOptions, start: boolean);
 	/**
 	 * Continue running the timer _(if it's paused)_
 	 */
@@ -67,12 +66,16 @@ export type TimerState = {
 	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";
+declare function stop$1(timer: WorkHandlerTimer, state: TimerState, options: TimerOptions): void;
 export declare function work(type: WorkHandlerType, timer: WorkHandlerTimer, state: TimerState, options: TimerOptions): Timer;
 
+export {
+	stop$1 as stop,
+};
+
 export {};

package/types/work.d.ts

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