@oscarpalmer/timer 0.27.1 → 0.29.0

package/types/index.d.cts

@@ -1,140 +1,106 @@
 // 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);
+export 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;
-}
-/**
- * A timer that can be started, stopped, and restarted as neeeded
- */
-export 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;
 }
 /**
- * Creates a timer which:
- * - calls a callback after a certain amount of time...
- * - ... and repeats it a certain amount of times
- * ---
- * - `options.count` defaults to `Infinity`
- * - `options.interval` defaults to `1000/60` _(1 frame)_
- * - `options.timeout` defaults to `Infinity`
- */
-export declare function repeat(callback: IndexedCallback, options?: Partial<RepeatOptions>): Timer;
-/**
- * Creates a timer which calls a callback after a certain amount of time
- */
-export declare function wait(callback: () => void): Timer;
-/**
- * Creates a timer which calls a callback after a certain amount of time
+ * Options for a repeating timer
  */
-export declare function wait(callback: () => void, time: number): Timer;
-/**
- * Creates a timer which calls a callback after a certain amount of time
- * - `options.interval` defaults to `1000/60` _(1 frame)_
- * - `options.timeout` defaults to `30_000` _(30 seconds)_
- */
-export declare function wait(callback: () => void, options: Partial<WaitOptions>): 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
-	 */
-	interval: number;
+export type RepeatOptions = {
 	/**
-	 * Maximum amount of time the timer may run for
+	 * Callback to be called when the timer has stopped, either manually or by completing its work
 	 */
-	timeout: number;
-};
-export type OptionsWithCount = {
+	onAfter: ((finished: boolean) => void) | undefined;
 	/**
 	 * How many times the timer should repeat
 	 */
 	count: number;
-} & BaseOptions;
-export type OptionsWithError = {
 	/**
-	 * Callback to run when an error occurs _(usually a timeout)_
+	 * The interval between each repeat
 	 */
-	errorCallback?: () => void;
+	interval: number;
+};
+export type TimerOptions = {
+	onAfter: ((finished: boolean) => void) | undefined;
+	onError: (() => void) | undefined;
+	count: number;
+	interval: number;
+	timeout: number;
 };
-export type RepeatOptions = {
-	/**
-	 * 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
-	 */
-	afterCallback?: AfterCallback;
-} & OptionsWithCount & OptionsWithError;
-export type TimerOptions = {} & RepeatOptions;
 export type TimerState = {
 	active: boolean;
-	callback: AnyCallback;
+	callback: () => void;
 	destroyed: boolean;
-	count?: number;
-	elapsed?: number;
-	frame?: number;
-	index?: number;
-	isRepeated: boolean;
-	minimum: number;
+	elapsed: number;
+	frame: number | undefined;
+	index: number;
 	paused: boolean;
-	trace?: string;
+	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 check the condition
+	 */
+	count: number;
+	/**
+	 * Then interval between each condtional check
+	 */
+	interval: number;
+	/**
+	 * The timeout for the timer
+	 */
+	timeout: number;
 };
-export type WaitOptions = {} & BaseOptions & OptionsWithError;
-export type WhenOptions = {} & OptionsWithCount;
 export type WhenState = {
 	promise: Promise<void>;
 	rejecter?: () => void;
@@ -142,10 +108,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);
 	/**
@@ -170,10 +156,19 @@ 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;
+/**
+ * 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)_
+ */
+export declare function wait(callback: () => void, time?: number): Timer;
+/**
+ * Create a repeating timer
+ */
+export declare function repeat(callback: (index: number) => void, options?: Partial<RepeatOptions>): Timer;
 /**
  * Is the value a repeating timer?
  */
@@ -191,8 +186,8 @@ export declare function isWaited(value: unknown): value is Timer;
  */
 export declare function isWhen(value: unknown): value is When;
 /**
- * Creates a delayed promise that resolves after a certain amount of time _(or rejects when timed out)_
+ * Create a delayed promise that resolves after a certain amount of time _(in milliseconds; defaults to screen refresh rate)_
  */
-export declare function delay(time: number, timeout?: number): Promise<void>;
+export declare function delay(time?: number): Promise<void>;
 
 export {};

package/types/index.d.ts

@@ -1,8 +1,7 @@
 import './global';
-/**
- * Creates a delayed promise that resolves after a certain amount of time _(or rejects when timed out)_
- */
-export declare function delay(time: number, timeout?: number): Promise<void>;
+export * from './delay';
 export { isRepeated, isTimer, isWaited, isWhen } from './is';
-export { repeat, wait, type Timer } from './timer';
-export { when, type When } from './when';
+export * from './repeat';
+export type { Timer } from './timer';
+export * from './wait';
+export * from './when';

package/types/is.d.cts

@@ -1,111 +1,72 @@
 // 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 = {
-	/**
-	 * How many times the timer should repeat
-	 */
-	count: number;
-} & BaseOptions;
-export type OptionsWithError = {
-	/**
-	 * Callback to run when an error occurs _(usually a timeout)_
-	 */
-	errorCallback?: () => void;
-};
-export type RepeatOptions = {
-	/**
-	 * 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
-	 */
-	afterCallback?: AfterCallback;
-} & OptionsWithCount & OptionsWithError;
-export type TimerOptions = {} & RepeatOptions;
 export type TimerState = {
 	active: boolean;
-	callback: AnyCallback;
+	callback: () => void;
 	destroyed: boolean;
-	count?: number;
-	elapsed?: number;
-	frame?: number;
-	index?: number;
-	isRepeated: boolean;
-	minimum: number;
+	elapsed: number;
+	frame: number | undefined;
+	index: number;
 	paused: boolean;
-	trace?: string;
+	total: number;
+	trace: string | undefined;
 };
+export type TimerType = "repeat" | "wait" | "when";
 export type WhenState = {
 	promise: Promise<void>;
 	rejecter?: () => void;
@@ -113,10 +74,30 @@ export type WhenState = {
 	started: boolean;
 	timer: Timer;
 };
-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";
+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);
 	/**

package/types/models.d.cts

@@ -1,116 +1,109 @@
 // 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
+ * Options for a repeating timer
  */
-export type IndexedCallback = (index: number) => void;
-export type BaseOptions = {
+export type RepeatOptions = {
 	/**
-	 * Interval between each callback
+	 * Callback to be called when the timer has stopped, either manually or by completing its work
 	 */
-	interval: number;
-	/**
-	 * Maximum amount of time the timer may run for
-	 */
-	timeout: number;
-};
-export type OptionsWithCount = {
+	onAfter: ((finished: boolean) => void) | undefined;
 	/**
 	 * How many times the timer should repeat
 	 */
 	count: number;
-} & BaseOptions;
-export type OptionsWithError = {
 	/**
-	 * Callback to run when an error occurs _(usually a timeout)_
+	 * The interval between each repeat
 	 */
-	errorCallback?: () => void;
+	interval: number;
+};
+export type TimerOptions = {
+	onAfter: ((finished: boolean) => void) | undefined;
+	onError: (() => void) | undefined;
+	count: number;
+	interval: number;
+	timeout: number;
 };
-export type RepeatOptions = {
-	/**
-	 * 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
-	 */
-	afterCallback?: AfterCallback;
-} & OptionsWithCount & OptionsWithError;
-export type TimerOptions = {} & RepeatOptions;
 export type TimerState = {
 	active: boolean;
-	callback: AnyCallback;
+	callback: () => void;
 	destroyed: boolean;
-	count?: number;
-	elapsed?: number;
-	frame?: number;
-	index?: number;
-	isRepeated: boolean;
-	minimum: number;
+	elapsed: number;
+	frame: number | undefined;
+	index: number;
 	paused: boolean;
-	trace?: string;
+	total: number;
+	trace: string | undefined;
 };
 export declare class TimerTrace extends Error {
 	constructor();
 }
-export type WaitOptions = {} & BaseOptions & OptionsWithError;
-export type WhenOptions = {} & OptionsWithCount;
+export type TimerType = "repeat" | "wait" | "when";
+/**
+ * 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 WhenState = {
 	promise: Promise<void>;
 	rejecter?: () => void;
@@ -118,6 +111,11 @@ export type WhenState = {
 	started: boolean;
 	timer: Timer;
 };
-export type WorkType = "continue" | "pause" | "restart" | "start" | "stop";
+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 {};