@oscarpalmer/timer 0.41.3 → 0.42.0

package/types/index.d.ts

@@ -1,230 +0,0 @@
-// Generated by dts-bundle-generator v9.5.1
-
-/**
- * Options for a repeating timer
- */
-export type RepeatOptions = {
-	/**
-	 * Callback to be called when the timer has stopped, either manually or by completing its work
-	 */
-	onAfter: (finished: boolean) => void;
-	/**
-	 * Callback to be called after the timer has timed out
-	 */
-	onTimeout: () => void;
-	/**
-	 * How many times the timer should repeat
-	 */
-	count: number;
-	/**
-	 * The interval between each repeat
-	 */
-	interval: number;
-	/**
-	 * The timeout for the timer _(any value above `0` will enable the timeout)_
-	 */
-	timeout: number;
-};
-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
- */
-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 _(any value above `0` will enable the timeout)_
-	 */
-	timeout: number;
-};
-export declare class Timer {
-	#private;
-	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, 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 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;
-};
-/**
- * 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
- */
-export 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
- */
-export declare function delay(time?: number): Promise<void>;
-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(condition: () => boolean, options?: Partial<WhenOptions>);
-	/**
-	 * Continues the timer _(if it was paused)_
-	 */
-	continue(): When;
-	/**
-	 * Destroys the timer _(and stops it,if it was running)_
-	 */
-	destroy(): void;
-	/**
-	 * Pauses the timer _(if it was running)_
-	 */
-	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>;
-	/**
-	 * Stops the timer _(if it was running)_
-	 */
-	stop(): When;
-	/**
-	 * 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
-	 */
-	then(resolve?: (() => void) | null, reject?: (() => void) | null): Promise<void>;
-}
-/**
- * Create a conditional timer
- * @param condition Condition to check
- * @param options Timer options
- * @returns Timer instance
- */
-export declare function when(condition: () => boolean, options?: Partial<WhenOptions>): When;
-/**
- * Is the value a repeating timer?
- * @param value Value to check
- * @returns `true` if the value is a repeating timer
- */
-export declare function isRepeated(value: unknown): value is Timer;
-/**
- * Is the value a timer?
- * @param value Value to check
- * @returns `true` if the value is a timer
- */
-export declare function isTimer(value: unknown): value is Timer;
-/**
- * Is the value a waiting timer?
- * @param value Value to check
- * @returns `true` if the value is a waiting timer
- */
-export declare function isWaited(value: unknown): value is Timer;
-/**
- * Is the value a conditional timer?
- * @param value Value to check
- * @returns `true` if the value is a conditional timer
- */
-export declare function isWhen(value: unknown): value is When;
-/**
- * Create a repeating timer
- * @param callback Callback to run on each interval
- * @param options Timer options
- * @returns Timer instance
- */
-export declare function repeat(callback: (index: number) => void, options?: Partial<RepeatOptions>): Timer;
-/**
- * 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;
-
-export {};

package/types/models.d.ts

@@ -1,78 +0,0 @@
-import type { Timer } from './timer';
-/**
- * Options for a repeating timer
- */
-export type RepeatOptions = {
-    /**
-     * Callback to be called when the timer has stopped, either manually or by completing its work
-     */
-    onAfter: (finished: boolean) => void;
-    /**
-     * Callback to be called after the timer has timed out
-     */
-    onTimeout: () => void;
-    /**
-     * How many times the timer should repeat
-     */
-    count: number;
-    /**
-     * The interval between each repeat
-     */
-    interval: number;
-    /**
-     * The timeout for the timer _(any value above `0` will enable the timeout)_
-     */
-    timeout: number;
-};
-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 declare class TimerTrace extends Error {
-    constructor();
-}
-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 _(any value above `0` will enable the timeout)_
-     */
-    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';

package/types/repeat.d.ts

@@ -1,11 +0,0 @@
-import './global';
-import { type RepeatOptions } from './models';
-import { Timer } from './timer';
-/**
- * Create a repeating timer
- * @param callback Callback to run on each interval
- * @param options Timer options
- * @returns Timer instance
- */
-export declare function repeat(callback: (index: number) => void, options?: Partial<RepeatOptions>): Timer;
-export type { RepeatOptions, Timer };

package/types/timer.d.ts

@@ -1,48 +0,0 @@
-import type { TimerOptions, TimerState, TimerType } from './models';
-export declare class Timer {
-    #private;
-    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, 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;
-}

package/types/when.d.ts

@@ -1,62 +0,0 @@
-import './global';
-import { type WhenOptions } from './models';
-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(condition: () => boolean, options?: Partial<WhenOptions>);
-    /**
-     * Continues the timer _(if it was paused)_
-     */
-    continue(): When;
-    /**
-     * Destroys the timer _(and stops it,if it was running)_
-     */
-    destroy(): void;
-    /**
-     * Pauses the timer _(if it was running)_
-     */
-    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>;
-    /**
-     * Stops the timer _(if it was running)_
-     */
-    stop(): When;
-    /**
-     * 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
-     */
-    then(resolve?: (() => void) | null, reject?: (() => void) | null): Promise<void>;
-}
-/**
- * Create a conditional timer
- * @param condition Condition to check
- * @param options Timer options
- * @returns Timer instance
- */
-export declare function when(condition: () => boolean, options?: Partial<WhenOptions>): When;
-export type { When };

package/types/work.d.ts

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