@oscarpalmer/timer 0.37.0 → 0.38.1

package/README.md

@@ -36,24 +36,24 @@ const repeated = new Timer(repeatedCallback, 10);
 
 When creating a _Timer_, either with the new `new`-keyword or using the functions, you can configure the timer with a few parameters:
 
-|Parameter|Description|
-|--------:|:----------|
-|`callback`|Callback function to be invoked for each run that are __required__ for all timers.<br>For more information on callbacks, please read [the callbacks section](#callbacks).|
-|`count`|How many times the timer should run.<br>If no value is provided, it will default to `1` when using the `new`-keyword and the `wait`-method, but throws an error for the `repeat`-method.|
-|`time`|How many milliseconds between each invokations of the provided callback.<br>Defaults to `0`, which is not really _0_ milliseconds, but close enough :wink:|
-|`after`|A callback to run after the timer finishes, both when cancelled and completed.<br>If _count_ is greater than `1` and _after_ __is not__ `undefined`, a function is expected.|
+|  Parameter | Description                                                                                                                                                                              |
+| ---------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `callback` | Callback function to be invoked for each run that are **required** for all timers.<br>For more information on callbacks, please read [the callbacks section](#callbacks).                |
+|    `count` | How many times the timer should run.<br>If no value is provided, it will default to `1` when using the `new`-keyword and the `wait`-method, but throws an error for the `repeat`-method. |
+|     `time` | How many milliseconds between each invokations of the provided callback.<br>Defaults to `0`, which is not really _0_ milliseconds, but close enough :wink:                               |
+|    `after` | A callback to run after the timer finishes, both when cancelled and completed.<br>If _count_ is greater than `1` and _after_ **is not** `undefined`, a function is expected.             |
 
 ## Methods and properties
 
 An instance of _Timer_ also has a few helpful methods and properties:
 
-|Name|Type|Description|
-|---:|----|:----------|
-|`active`|_Property_|A `boolean` value to check if the timer is running|
-|`finished`|_Property_|A `boolean` value to check if the timer was able to finish|
-|`start()`|_Method_|Starts the timer.<br>Necessary when creating a timer using the class syntax _(e.g. `new Waited...`)_, but helpful when the timer needs to be started at other times, as well.|
-|`stop()`|_Method_|Stops the timer|
-|`restart()`|_Method_|Restarts the timer|
+|        Name | Type       | Description                                                                                                                                                                   |
+| ----------: | ---------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+|    `active` | _Property_ | A `boolean` value to check if the timer is running                                                                                                                            |
+|  `finished` | _Property_ | A `boolean` value to check if the timer was able to finish                                                                                                                    |
+|   `start()` | _Method_   | Starts the timer.<br>Necessary when creating a timer using the class syntax _(e.g. `new Waited...`)_, but helpful when the timer needs to be started at other times, as well. |
+|    `stop()` | _Method_   | Stops the timer                                                                                                                                                               |
+| `restart()` | _Method_   | Restarts the timer                                                                                                                                                            |
 
 ## Callbacks
 

package/dist/constants.js

@@ -5,20 +5,18 @@ function calculate() {
 		function step(now) {
 			if (last != null) values.push(now - last);
 			last = now;
-			if (values.length >= 10) {
-				const median = values.sort().slice(2, -2).reduce((first, second) => first + second, 0) / (values.length - 4);
-				resolve(median);
-			} else requestAnimationFrame(step);
+			if (values.length >= 10) resolve(values.sort().slice(2, -2).reduce((first, second) => first + second, 0) / (values.length - 4));
+			else requestAnimationFrame(step);
 		}
 		requestAnimationFrame(step);
 	});
 }
-const defaultTimeout = 3e4;
-const activeTimers = /* @__PURE__ */ new Set();
-const intervalBuffer = 5;
-const destroyedMessage = "Timer has already been destroyed";
-const hiddenTimers = /* @__PURE__ */ new Set();
-const startedMessage = "Timer has already been started";
+const BUFFER_INTERVAL = 5;
+const DEFAULT_TIMEOUT = 3e4;
+const MESSAGE_DESTROYED = "Timer has already been destroyed";
+const MESSAGE_STARTED = "Timer has already been started";
+const TIMERS_ACTIVE = /* @__PURE__ */ new Set();
+const TIMERS_HIDDEN = /* @__PURE__ */ new Set();
 const TYPE_REPEAT = "repeat";
 const TYPE_WAIT = "wait";
 const TYPE_WHEN = "when";
@@ -27,8 +25,8 @@ const WORK_PAUSE = "pause";
 const WORK_RESTART = "restart";
 const WORK_START = "start";
 const WORK_STOP = "stop";
-let milliseconds = 1e3 / 60;
+let MILLISECONDS = 1e3 / 60;
 calculate().then((value) => {
-	milliseconds = value;
+	MILLISECONDS = value;
 });
-export { TYPE_REPEAT, TYPE_WAIT, TYPE_WHEN, WORK_CONTINUE, WORK_PAUSE, WORK_RESTART, WORK_START, WORK_STOP, activeTimers, defaultTimeout, destroyedMessage, hiddenTimers, intervalBuffer, milliseconds, startedMessage };
+export { BUFFER_INTERVAL, DEFAULT_TIMEOUT, MESSAGE_DESTROYED, MESSAGE_STARTED, MILLISECONDS, TIMERS_ACTIVE, TIMERS_HIDDEN, TYPE_REPEAT, TYPE_WAIT, TYPE_WHEN, WORK_CONTINUE, WORK_PAUSE, WORK_RESTART, WORK_START, WORK_STOP };

package/dist/delay.js

@@ -1,12 +1,12 @@
-import { intervalBuffer, milliseconds } from "./constants.js";
+import { BUFFER_INTERVAL, MILLISECONDS } from "./constants.js";
 import { getValidNumber } from "./get.js";
 function delay(time) {
 	return new Promise((resolve) => {
-		const interval = getValidNumber(time, milliseconds);
+		const interval = getValidNumber(time, MILLISECONDS);
 		let start;
 		function step(now) {
 			start ??= now;
-			if (interval === milliseconds || now - start >= interval - 5) resolve();
+			if (interval === MILLISECONDS || now - start >= interval - 5) resolve();
 			else requestAnimationFrame(step);
 		}
 		requestAnimationFrame(step);

package/dist/get.js

@@ -1,10 +1,10 @@
-import { defaultTimeout } from "./constants.js";
+import { DEFAULT_TIMEOUT } from "./constants.js";
 import { noop } from "@oscarpalmer/atoms/function";
 function getCallback(value) {
 	return typeof value === "function" ? value : noop;
 }
 function getValidTimeout(value) {
-	return typeof value === "number" && value > 0 ? value : defaultTimeout;
+	return typeof value === "number" && value > 0 ? value : DEFAULT_TIMEOUT;
 }
 function getValidNumber(value, defaultValue) {
 	const actualDefault = defaultValue ?? 0;

package/dist/global.js

@@ -1,12 +1,12 @@
-import { WORK_CONTINUE, WORK_PAUSE, activeTimers, hiddenTimers } from "./constants.js";
+import { TIMERS_ACTIVE, TIMERS_HIDDEN, WORK_CONTINUE, WORK_PAUSE } from "./constants.js";
 if (globalThis._oscarpalmer_timers == null) Object.defineProperty(globalThis, "_oscarpalmer_timers", { get() {
-	return globalThis._oscarpalmer_timer_debug ? [...activeTimers] : [];
+	return globalThis._oscarpalmer_timer_debug ? [...TIMERS_ACTIVE] : [];
 } });
 /* istanbul ignore next */
 document.addEventListener("visibilitychange", () => {
-	const from = document.hidden ? activeTimers : hiddenTimers;
+	const from = document.hidden ? TIMERS_ACTIVE : TIMERS_HIDDEN;
 	const method = document.hidden ? WORK_PAUSE : WORK_CONTINUE;
-	const to = document.hidden ? hiddenTimers : activeTimers;
+	const to = document.hidden ? TIMERS_HIDDEN : TIMERS_ACTIVE;
 	for (const timer of from) {
 		timer[method]();
 		to.add(timer);

package/dist/index.js

@@ -1,7 +1,7 @@
+import { delay } from "./delay.js";
 import "./global.js";
-import { when } from "./when.js";
-import { wait } from "./wait.js";
-import { repeat } from "./repeat.js";
 import { isRepeated, isTimer, isWaited, isWhen } from "./is.js";
-import { delay } from "./delay.js";
+import { repeat } from "./repeat.js";
+import { wait } from "./wait.js";
+import { when } from "./when.js";
 export { delay, isRepeated, isTimer, isWaited, isWhen, repeat, wait, when };

package/dist/repeat.js

@@ -1,4 +1,4 @@
-import { TYPE_REPEAT, milliseconds } from "./constants.js";
+import { MILLISECONDS, TYPE_REPEAT } from "./constants.js";
 import { getCallback, getValidNumber } from "./get.js";
 import "./global.js";
 import { TimerTrace } from "./models.js";
@@ -11,7 +11,7 @@ function repeat(callback, options) {
 		onAfter: getCallback(options?.onAfter),
 		onError: getCallback(options?.onTimeout),
 		count: getValidNumber(options?.count),
-		interval: getValidNumber(options?.interval, milliseconds),
+		interval: getValidNumber(options?.interval, MILLISECONDS),
 		timeout: getValidNumber(options?.timeout)
 	}, true);
 }