@oscarpalmer/timer 0.36.0 → 0.38.0

package/dist/work.cjs

@@ -1,82 +0,0 @@
-const require_constants = require("./constants.cjs");
-function finish(timer, state, options, success) {
-	cancelAnimationFrame(state.frame);
-	require_constants.activeTimers.delete(timer.instance);
-	state.active = false;
-	state.elapsed = 0;
-	state.frame = void 0;
-	if (timer.type === require_constants.TYPE_WAIT) state.callback();
-	else options.onAfter?.(success);
-}
-function ignore(type, state) {
-	if (state.destroyed) return type !== require_constants.WORK_STOP;
-	if (state.paused) return type === require_constants.WORK_PAUSE || type === require_constants.WORK_START;
-	return state.active && type === require_constants.WORK_START;
-}
-function pause(timer, state) {
-	cancelAnimationFrame(state.frame);
-	state.frame = void 0;
-	return timer.instance;
-}
-function run(timer, state, options) {
-	let last;
-	let start;
-	return function step(now) {
-		if (!state.active) return;
-		last ??= now;
-		start ??= now;
-		const difference = now - last;
-		state.elapsed += difference;
-		state.total += difference;
-		last = now;
-		if (options.timeout > 0 && state.total >= options.timeout) {
-			options.onError?.();
-			finish(timer, state, options, false);
-			return;
-		}
-		if (options.interval === require_constants.milliseconds || state.elapsed >= options.interval - require_constants.intervalBuffer) {
-			if (options.count > -1) state.callback(state.index);
-			start = now;
-			state.elapsed = 0;
-			state.index += 1;
-			if (options.count === -1 || options.count > 0 && state.index >= options.count) {
-				finish(timer, state, options, true);
-				return;
-			}
-		}
-		state.frame = requestAnimationFrame(step);
-	};
-}
-function setState(type, state) {
-	const pausable = type === require_constants.WORK_CONTINUE || type === require_constants.WORK_PAUSE;
-	state.elapsed = pausable ? state.elapsed : 0;
-	state.index = pausable ? state.index : 0;
-	state.total = pausable ? state.total : 0;
-}
-function stop(timer, state, options) {
-	cancelAnimationFrame(state.frame);
-	require_constants.activeTimers.delete(timer.instance);
-	options.onAfter?.(false);
-	state.active = !stop;
-	state.frame = void 0;
-	state.paused = false;
-	return timer.instance;
-}
-function work(type, timer, state, options) {
-	if (ignore(type, state)) return timer.instance;
-	setState(type, state);
-	if (type === require_constants.WORK_STOP) return stop(timer, state, options);
-	if (type === require_constants.WORK_PAUSE || type === require_constants.WORK_RESTART) {
-		cancelAnimationFrame(state.frame);
-		state.frame = void 0;
-	}
-	state.active = true;
-	state.paused = type === require_constants.WORK_PAUSE;
-	if (state.paused) return pause(timer, state);
-	require_constants.activeTimers.add(timer.instance);
-	const runner = run(timer, state, options);
-	state.frame = requestAnimationFrame(runner);
-	return timer.instance;
-}
-exports.stop = stop;
-exports.work = work;

package/types/constants.d.cts

@@ -1,104 +0,0 @@
-// Generated by dts-bundle-generator v9.5.1
-
-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 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";
-export type WorkHandlerType = "continue" | "pause" | "restart" | "start" | "stop";
-export declare const defaultTimeout = 30000;
-/**
- * A set of all active timers
- */
-export declare const activeTimers: Set<Timer>;
-/**
- * Buffer value to use when evaluating if a specific time is within a certain range
- */
-export declare const intervalBuffer = 5;
-/**
- * Message to show when a when-timer is destroyed
- */
-export declare const destroyedMessage = "Timer has already been destroyed";
-/**
- * A set of timers that were paused due to the document being hidden
- */
-export declare const hiddenTimers: Set<Timer>;
-/**
- * Message to show when a when-timer is started
- */
-export declare const startedMessage = "Timer has already been started";
-export declare const TYPE_REPEAT: TimerType;
-export declare const TYPE_WAIT: TimerType;
-export declare const TYPE_WHEN: TimerType;
-export declare const WORK_CONTINUE: WorkHandlerType;
-export declare const WORK_PAUSE: WorkHandlerType;
-export declare const WORK_RESTART: WorkHandlerType;
-export declare const WORK_START: WorkHandlerType;
-export declare const WORK_STOP: WorkHandlerType;
-/**
- * A calculated average of the refresh rate of the display _(in milliseconds)_
- */
-export declare let milliseconds: number;
-
-export {};

package/types/delay.d.cts

@@ -1,8 +0,0 @@
-// Generated by dts-bundle-generator v9.5.1
-
-/**
- * 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): Promise<void>;
-
-export {};

package/types/get.d.cts

@@ -1,11 +0,0 @@
-// Generated by dts-bundle-generator v9.5.1
-
-/**
- * A generic callback function
- */
-export type GenericCallback = (...args: any[]) => any;
-export declare function getCallback(value: unknown): GenericCallback;
-export declare function getValidTimeout(value: unknown): number;
-export declare function getValidNumber(value: unknown, defaultValue?: number): number;
-
-export {};

package/types/global.d.cts

@@ -1,3 +0,0 @@
-// Generated by dts-bundle-generator v9.5.1
-
-export {};

package/types/index.d.cts

@@ -1,187 +0,0 @@
-// Generated by dts-bundle-generator v9.5.1
-
-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;
-}
-/**
- * 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 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;
-	/**
-	 * Stops the timer _(if it was running)_
-	 */
-	stop(): When;
-	/**
-	 * Starts the timer and returns a promise that resolves when the condition is met
-	 */
-	then(resolve?: (() => void) | null, reject?: (() => void) | null): Promise<void>;
-}
-/**
- * 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?
- */
-export declare function isRepeated(value: unknown): value is Timer;
-/**
- * Is the value a timer?
- */
-export declare function isTimer(value: unknown): value is Timer;
-/**
- * Is the value a waiting timer?
- */
-export declare function isWaited(value: unknown): value is Timer;
-/**
- * Is the value a conditional timer?
- */
-export declare function isWhen(value: unknown): value is When;
-/**
- * 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): Promise<void>;
-
-export {};

package/types/is.d.cts

@@ -1,144 +0,0 @@
-// Generated by dts-bundle-generator v9.5.1
-
-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 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;
-};
-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;
-	/**
-	 * Stops the timer _(if it was running)_
-	 */
-	stop(): When;
-	/**
-	 * Starts the timer and returns a promise that resolves when the condition is met
-	 */
-	then(resolve?: (() => void) | null, reject?: (() => void) | null): Promise<void>;
-}
-/**
- * Is the value a repeating timer?
- */
-export declare function isRepeated(value: unknown): value is Timer;
-/**
- * Is the value a timer?
- */
-export declare function isTimer(value: unknown): value is Timer;
-/**
- * Is the value a waiting timer?
- */
-export declare function isWaited(value: unknown): value is Timer;
-/**
- * Is the value a conditional timer?
- */
-export declare function isWhen(value: unknown): value is When;
-
-export {};

package/types/models.d.cts

@@ -1,128 +0,0 @@
-// Generated by dts-bundle-generator v9.5.1
-
-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;
-}
-/**
- * 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";
-
-export {};