@oscarpalmer/timer 0.46.0 → 0.47.0

package/dist/index.d.mts

@@ -152,26 +152,30 @@ declare global {
 //#region src/is.d.ts
 /**
  * Is the value a repeating timer?
+ *
  * @param value Value to check
- * @returns `true` if the value is a repeating timer
+ * @returns `true` if the value is a repeating timer, otherwise `false`
  */
 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
+ * @returns `true` if the value is a timer, otherwise `false`
  */
 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
+ * @returns `true` if the value is a waiting timer, otherwise `false`
  */
 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
+ * @returns `true` if the value is a conditional timer, otherwise `false`
  */
 declare function isWhen(value: unknown): value is When;
 //#endregion
@@ -181,7 +185,7 @@ declare function isWhen(value: unknown): value is When;
  *
  * @param callback Callback to run on each interval
  * @param options Timer options
- * @returns Timer instance
+ * @returns Repeating timer
  */
 declare function repeat(callback: (index: number) => void, options?: Partial<RepeatOptions>): Timer;
 //#endregion
@@ -191,6 +195,7 @@ declare function repeat(callback: (index: number) => void, options?: Partial<Rep
  *
  * @param callback Callback to run when the timer has finished
  * @param time How long to wait for _(in milliseconds; defaults to screen refresh rate)_
+ * @returns Waiting timer
  */
 declare function wait(callback: () => void, time?: number): Timer;
 //#endregion

package/dist/index.mjs

@@ -140,32 +140,36 @@ function is(names, value) {
 }
 /**
 * Is the value a repeating timer?
+* 
 * @param value Value to check
-* @returns `true` if the value is a repeating timer
+* @returns `true` if the value is a repeating timer, otherwise `false`
 */
 function isRepeated(value) {
 	return is([TYPE_REPEAT], value);
 }
 /**
 * Is the value a timer?
+* 
 * @param value Value to check
-* @returns `true` if the value is a timer
+* @returns `true` if the value is a timer, otherwise `false`
 */
 function isTimer(value) {
 	return is([TYPE_REPEAT, TYPE_WAIT], value);
 }
 /**
 * Is the value a waiting timer?
+* 
 * @param value Value to check
-* @returns `true` if the value is a waiting timer
+* @returns `true` if the value is a waiting timer, otherwise `false`
 */
 function isWaited(value) {
 	return is([TYPE_WAIT], value);
 }
 /**
 * Is the value a conditional timer?
+* 
 * @param value Value to check
-* @returns `true` if the value is a conditional timer
+* @returns `true` if the value is a conditional timer, otherwise `false`
 */
 function isWhen(value) {
 	return is(["when"], value) && typeof value.start === "function";
@@ -235,7 +239,7 @@ function createTimer(name, pick, options, start) {
 *
 * @param callback Callback to run on each interval
 * @param options Timer options
-* @returns Timer instance
+* @returns Repeating timer
 */
 function repeat(callback, options) {
 	return createTimer(TYPE_REPEAT, {
@@ -256,6 +260,7 @@ function repeat(callback, options) {
 *
 * @param callback Callback to run when the timer has finished
 * @param time How long to wait for _(in milliseconds; defaults to screen refresh rate)_
+* @returns Waiting timer
 */
 function wait(callback, time) {
 	return createTimer(TYPE_WAIT, {

package/dist/is.d.mts

@@ -2,26 +2,30 @@ import { Timer, When } from "./models.mjs";
 //#region src/is.d.ts
 /**
  * Is the value a repeating timer?
+ *
  * @param value Value to check
- * @returns `true` if the value is a repeating timer
+ * @returns `true` if the value is a repeating timer, otherwise `false`
  */
 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
+ * @returns `true` if the value is a timer, otherwise `false`
  */
 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
+ * @returns `true` if the value is a waiting timer, otherwise `false`
  */
 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
+ * @returns `true` if the value is a conditional timer, otherwise `false`
  */
 declare function isWhen(value: unknown): value is When;
 //#endregion

package/dist/is.mjs

@@ -5,32 +5,36 @@ function is(names, value) {
 }
 /**
 * Is the value a repeating timer?
+* 
 * @param value Value to check
-* @returns `true` if the value is a repeating timer
+* @returns `true` if the value is a repeating timer, otherwise `false`
 */
 function isRepeated(value) {
 	return is([TYPE_REPEAT], value);
 }
 /**
 * Is the value a timer?
+* 
 * @param value Value to check
-* @returns `true` if the value is a timer
+* @returns `true` if the value is a timer, otherwise `false`
 */
 function isTimer(value) {
 	return is([TYPE_REPEAT, TYPE_WAIT], value);
 }
 /**
 * Is the value a waiting timer?
+* 
 * @param value Value to check
-* @returns `true` if the value is a waiting timer
+* @returns `true` if the value is a waiting timer, otherwise `false`
 */
 function isWaited(value) {
 	return is([TYPE_WAIT], value);
 }
 /**
 * Is the value a conditional timer?
+* 
 * @param value Value to check
-* @returns `true` if the value is a conditional timer
+* @returns `true` if the value is a conditional timer, otherwise `false`
 */
 function isWhen(value) {
 	return is(["when"], value) && typeof value.start === "function";

package/dist/repeat.d.mts

@@ -6,7 +6,7 @@ import "./global.mjs";
  *
  * @param callback Callback to run on each interval
  * @param options Timer options
- * @returns Timer instance
+ * @returns Repeating timer
  */
 declare function repeat(callback: (index: number) => void, options?: Partial<RepeatOptions>): Timer;
 //#endregion

package/dist/repeat.mjs

@@ -9,7 +9,7 @@ import { createTimer } from "./timer.mjs";
 *
 * @param callback Callback to run on each interval
 * @param options Timer options
-* @returns Timer instance
+* @returns Repeating timer
 */
 function repeat(callback, options) {
 	return createTimer(TYPE_REPEAT, {

package/dist/wait.d.mts

@@ -6,6 +6,7 @@ import "./global.mjs";
  *
  * @param callback Callback to run when the timer has finished
  * @param time How long to wait for _(in milliseconds; defaults to screen refresh rate)_
+ * @returns Waiting timer
  */
 declare function wait(callback: () => void, time?: number): Timer;
 //#endregion

package/dist/wait.mjs

@@ -9,6 +9,7 @@ import { createTimer } from "./timer.mjs";
 *
 * @param callback Callback to run when the timer has finished
 * @param time How long to wait for _(in milliseconds; defaults to screen refresh rate)_
+* @returns Waiting timer
 */
 function wait(callback, time) {
 	return createTimer(TYPE_WAIT, {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@oscarpalmer/timer",
-	"version": "0.46.0",
+	"version": "0.47.0",
 	"description": "A better solution for timeout- and interval-based timers.",
 	"keywords": [
 		"requestAnimationFrame",
@@ -30,6 +30,10 @@
 			"types": "./dist/index.d.mts",
 			"default": "./dist/index.mjs"
 		},
+		"./is": {
+			"types": "./dist/is.d.mts",
+			"default": "./dist/is.mjs"
+		},
 		"./models": {
 			"types": "./dist/models.d.mts",
 			"default": "./dist/models.mjs"
@@ -56,7 +60,7 @@
 		"watch": "npx vite build --watch"
 	},
 	"dependencies": {
-		"@oscarpalmer/atoms": "^0.193"
+		"@oscarpalmer/atoms": "^0.195"
 	},
 	"devDependencies": {
 		"@oxlint/plugins": "^1.80",

package/src/is.ts

@@ -8,8 +8,9 @@ function is(names: string[], value: unknown) {
 
 /**
  * Is the value a repeating timer?
+ * 
  * @param value Value to check
- * @returns `true` if the value is a repeating timer
+ * @returns `true` if the value is a repeating timer, otherwise `false`
  */
 export function isRepeated(value: unknown): value is Timer {
 	return is([TYPE_REPEAT], value);
@@ -17,8 +18,9 @@ export 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
+ * @returns `true` if the value is a timer, otherwise `false`
  */
 export function isTimer(value: unknown): value is Timer {
 	return is([TYPE_REPEAT, TYPE_WAIT], value);
@@ -26,8 +28,9 @@ export 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
+ * @returns `true` if the value is a waiting timer, otherwise `false`
  */
 export function isWaited(value: unknown): value is Timer {
 	return is([TYPE_WAIT], value);
@@ -35,8 +38,9 @@ export 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
+ * @returns `true` if the value is a conditional timer, otherwise `false`
  */
 export function isWhen(value: unknown): value is When {
 	return is([TYPE_WHEN], value) && typeof (value as When).start === 'function';

package/src/repeat.ts

@@ -9,7 +9,7 @@ import {createTimer} from './timer';
  *
  * @param callback Callback to run on each interval
  * @param options Timer options
- * @returns Timer instance
+ * @returns Repeating timer
  */
 export function repeat(callback: (index: number) => void, options?: Partial<RepeatOptions>): Timer {
 	return createTimer(

package/src/wait.ts

@@ -9,6 +9,7 @@ import {createTimer} from './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)_
+ * @returns Waiting timer
  */
 export function wait(callback: () => void, time?: number): Timer {
 	return createTimer(