@oscarpalmer/atoms 0.41.3 → 0.42.0

package/dist/js/index.js

@@ -681,20 +681,26 @@ function getRandomHex() {
   return "0123456789ABCDEF"[getRandomInteger(0, 16)];
 }
 // src/js/timer.ts
+var is = function(value, pattern) {
+  return pattern.test(value?.$timer);
+};
 function isRepeated(value) {
-  return /^repeat$/.test(value?.$timer ?? "");
+  return is(value, /^repeat$/);
 }
 function isTimer(value) {
-  return /^repeat|wait$/.test(value?.$timer ?? "");
+  return is(value, /^repeat|wait$/);
 }
 function isWaited(value) {
-  return /^wait$/.test(value?.$timer ?? "");
+  return is(value, /^wait$/);
+}
+function isWhen(value) {
+  return is(value, /^when$/) && typeof value.then === "function";
 }
 function repeat(callback, options) {
   return timer("repeat", callback, {
     ...options ?? {},
     ...{
-      count: typeof options?.count === "number" ? options.count : Number.POSITIVE_INFINITY
+      count: typeof options?.count === "number" ? options.count > 0 ? options.count : 1 : Number.POSITIVE_INFINITY
     }
   }).start();
 }
@@ -775,16 +781,28 @@ function when(condition, options) {
       return promise.then(resolve, reject);
     }
   });
+  Object.defineProperties(instance, {
+    $timer: {
+      get() {
+        return "when";
+      }
+    },
+    active: {
+      get() {
+        return repeated.active;
+      }
+    }
+  });
   return instance;
 }
 var work = function(type, timer2, state, options) {
   if (type === "start" && state.active || type === "stop" && !state.active) {
     return timer2;
   }
-  const { afterCallback, count, errorCallback, interval, timeout } = options;
+  const { count, interval, timeout } = options;
   if (typeof state.frame === "number") {
     cancelAnimationFrame(state.frame);
-    afterCallback?.(false);
+    options.afterCallback?.(false);
   }
   if (type === "stop") {
     state.active = false;
@@ -793,20 +811,17 @@ var work = function(type, timer2, state, options) {
   }
   state.active = true;
   const isRepeated2 = count > 0;
-  let index = 0;
-  let total = count * (interval > 0 ? interval : 1);
-  if (total < 16.66667) {
-    total = 16.66667;
-  }
+  const total = count === Number.POSITIVE_INFINITY ? timeout : count * (interval > 0 ? interval : 17);
   let current;
   let start;
+  let index = 0;
   function finish(finished, error) {
     state.active = false;
     state.frame = undefined;
     if (error) {
-      errorCallback?.();
+      options.errorCallback?.();
     }
-    afterCallback?.(finished);
+    options.afterCallback?.(finished);
   }
   function step(timestamp) {
     if (!state.active) {
@@ -1060,6 +1075,7 @@ export {
   queue,
   push,
   merge,
+  isWhen,
   isWaited,
   isTimer,
   isTabbableElement,

package/dist/js/timer.js

@@ -1,18 +1,24 @@
 // src/js/timer.ts
+var is = function(value, pattern) {
+  return pattern.test(value?.$timer);
+};
 function isRepeated(value) {
-  return /^repeat$/.test(value?.$timer ?? "");
+  return is(value, /^repeat$/);
 }
 function isTimer(value) {
-  return /^repeat|wait$/.test(value?.$timer ?? "");
+  return is(value, /^repeat|wait$/);
 }
 function isWaited(value) {
-  return /^wait$/.test(value?.$timer ?? "");
+  return is(value, /^wait$/);
+}
+function isWhen(value) {
+  return is(value, /^when$/) && typeof value.then === "function";
 }
 function repeat(callback, options) {
   return timer("repeat", callback, {
     ...options ?? {},
     ...{
-      count: typeof options?.count === "number" ? options.count : Number.POSITIVE_INFINITY
+      count: typeof options?.count === "number" ? options.count > 0 ? options.count : 1 : Number.POSITIVE_INFINITY
     }
   }).start();
 }
@@ -93,16 +99,28 @@ function when(condition, options) {
       return promise.then(resolve, reject);
     }
   });
+  Object.defineProperties(instance, {
+    $timer: {
+      get() {
+        return "when";
+      }
+    },
+    active: {
+      get() {
+        return repeated.active;
+      }
+    }
+  });
   return instance;
 }
 var work = function(type, timer2, state, options) {
   if (type === "start" && state.active || type === "stop" && !state.active) {
     return timer2;
   }
-  const { afterCallback, count, errorCallback, interval, timeout } = options;
+  const { count, interval, timeout } = options;
   if (typeof state.frame === "number") {
     cancelAnimationFrame(state.frame);
-    afterCallback?.(false);
+    options.afterCallback?.(false);
   }
   if (type === "stop") {
     state.active = false;
@@ -111,20 +129,17 @@ var work = function(type, timer2, state, options) {
   }
   state.active = true;
   const isRepeated2 = count > 0;
-  let index = 0;
-  let total = count * (interval > 0 ? interval : 1);
-  if (total < 16.66667) {
-    total = 16.66667;
-  }
+  const total = count === Number.POSITIVE_INFINITY ? timeout : count * (interval > 0 ? interval : 17);
   let current;
   let start;
+  let index = 0;
   function finish(finished, error) {
     state.active = false;
     state.frame = undefined;
     if (error) {
-      errorCallback?.();
+      options.errorCallback?.();
     }
-    afterCallback?.(finished);
+    options.afterCallback?.(finished);
   }
   function step(timestamp) {
     if (!state.active) {
@@ -160,6 +175,7 @@ export {
   when,
   wait,
   repeat,
+  isWhen,
   isWaited,
   isTimer,
   isRepeated

package/dist/js/timer.mjs

@@ -1,18 +1,24 @@
 // src/js/timer.ts
+var is = function(value, pattern) {
+  return pattern.test(value?.$timer);
+};
 function isRepeated(value) {
-  return /^repeat$/.test(value?.$timer ?? "");
+  return is(value, /^repeat$/);
 }
 function isTimer(value) {
-  return /^repeat|wait$/.test(value?.$timer ?? "");
+  return is(value, /^repeat|wait$/);
 }
 function isWaited(value) {
-  return /^wait$/.test(value?.$timer ?? "");
+  return is(value, /^wait$/);
+}
+function isWhen(value) {
+  return is(value, /^when$/) && typeof value.then === "function";
 }
 function repeat(callback, options) {
   return timer("repeat", callback, {
     ...options ?? {},
     ...{
-      count: typeof options?.count === "number" ? options.count : Number.POSITIVE_INFINITY
+      count: typeof options?.count === "number" ? options.count > 0 ? options.count : 1 : Number.POSITIVE_INFINITY
     }
   }).start();
 }
@@ -93,16 +99,28 @@ function when(condition, options) {
       return promise.then(resolve, reject);
     }
   });
+  Object.defineProperties(instance, {
+    $timer: {
+      get() {
+        return "when";
+      }
+    },
+    active: {
+      get() {
+        return repeated.active;
+      }
+    }
+  });
   return instance;
 }
 var work = function(type, timer2, state, options) {
   if (type === "start" && state.active || type === "stop" && !state.active) {
     return timer2;
   }
-  const { afterCallback, count, errorCallback, interval, timeout } = options;
+  const { count, interval, timeout } = options;
   if (typeof state.frame === "number") {
     cancelAnimationFrame(state.frame);
-    afterCallback?.(false);
+    options.afterCallback?.(false);
   }
   if (type === "stop") {
     state.active = false;
@@ -111,20 +129,17 @@ var work = function(type, timer2, state, options) {
   }
   state.active = true;
   const isRepeated2 = count > 0;
-  let index = 0;
-  let total = count * (interval > 0 ? interval : 1);
-  if (total < 16.66667) {
-    total = 16.66667;
-  }
+  const total = count === Number.POSITIVE_INFINITY ? timeout : count * (interval > 0 ? interval : 17);
   let current;
   let start;
+  let index = 0;
   function finish(finished, error) {
     state.active = false;
     state.frame = undefined;
     if (error) {
-      errorCallback?.();
+      options.errorCallback?.();
     }
-    afterCallback?.(finished);
+    options.afterCallback?.(finished);
   }
   function step(timestamp) {
     if (!state.active) {
@@ -160,6 +175,7 @@ export {
   when,
   wait,
   repeat,
+  isWhen,
   isWaited,
   isTimer,
   isRepeated

package/package.json

@@ -130,5 +130,5 @@
 	},
 	"type": "module",
 	"types": "./types/index.d.ts",
-	"version": "0.41.3"
+	"version": "0.42.0"
 }

package/src/js/timer.ts

@@ -94,25 +94,36 @@ type WhenOptions = {} & OptionsWithCount;
 
 type WorkType = 'restart' | 'start' | 'stop';
 
+function is(value: unknown, pattern: RegExp) {
+	return pattern.test((value as PlainObject)?.$timer as string);
+}
+
 /**
  * Is the value a repeating timer?
  */
 export function isRepeated(value: unknown): value is Timer {
-	return /^repeat$/.test(((value as PlainObject)?.$timer as string) ?? '');
+	return is(value, /^repeat$/);
 }
 
 /**
  * Is the value a timer?
  */
 export function isTimer(value: unknown): value is Timer {
-	return /^repeat|wait$/.test(((value as PlainObject)?.$timer as string) ?? '');
+	return is(value, /^repeat|wait$/);
 }
 
 /**
  * Is the value a waiting timer?
  */
 export function isWaited(value: unknown): value is Timer {
-	return /^wait$/.test(((value as PlainObject)?.$timer as string) ?? '');
+	return is(value, /^wait$/);
+}
+
+/**
+ * Is the value a conditional timer?
+ */
+export function isWhen(value: unknown): value is When {
+	return is(value, /^when$/) && typeof (value as When).then === 'function';
 }
 
 /**
@@ -120,8 +131,9 @@ export function isWaited(value: unknown): value is Timer {
  * - calls a callback after a certain amount of time...
  * - ... and repeats it a certain amount of times
  * ---
- * - `options.count` defaults to `Infinity`
- * - `options.time` defaults to `0`
+ * - `options.count` defaults to `Infinity` _(minimum `1`)_
+ * - `options.interval` defaults to `0`
+ * - `options.timeout` defaults to `30_000` _(30 seconds)_
  */
 export function repeat(
 	callback: IndexedCallback,
@@ -132,7 +144,9 @@ export function repeat(
 		...{
 			count:
 				typeof options?.count === 'number'
-					? options.count
+					? options.count > 0
+						? options.count
+						: 1
 					: Number.POSITIVE_INFINITY,
 		},
 	}).start();
@@ -268,7 +282,7 @@ export function when(
 				rejecter?.();
 			}
 		},
-		// biome-ignore lint/suspicious/noThenProperty: <explanation>
+		// biome-ignore lint/suspicious/noThenProperty: returning a promise-like object, so it's ok ;)
 		then(resolve?: () => void, reject?: () => void) {
 			repeated.start();
 
@@ -276,6 +290,19 @@ export function when(
 		},
 	});
 
+	Object.defineProperties(instance, {
+		$timer: {
+			get() {
+				return 'when';
+			},
+		},
+		active: {
+			get() {
+				return repeated.active;
+			},
+		},
+	});
+
 	return instance;
 }
 
@@ -292,12 +319,12 @@ function work(
 		return timer;
 	}
 
-	const {afterCallback, count, errorCallback, interval, timeout} = options;
+	const {count, interval, timeout} = options;
 
 	if (typeof state.frame === 'number') {
 		cancelAnimationFrame(state.frame);
 
-		afterCallback?.(false);
+		options.afterCallback?.(false);
 	}
 
 	if (type === 'stop') {
@@ -311,25 +338,25 @@ function work(
 
 	const isRepeated = count > 0;
 
-	let index = 0;
-	let total = count * (interval > 0 ? interval : 1);
-
-	if (total < 16.66667) {
-		total = 16.66667;
-	}
+	const total =
+		count === Number.POSITIVE_INFINITY
+			? timeout
+			: count * (interval > 0 ? interval : 17);
 
 	let current: DOMHighResTimeStamp | null;
 	let start: DOMHighResTimeStamp | null;
 
+	let index = 0;
+
 	function finish(finished: boolean, error: boolean) {
 		state.active = false;
 		state.frame = undefined;
 
 		if (error) {
-			errorCallback?.();
+			options.errorCallback?.();
 		}
 
-		afterCallback?.(finished);
+		options.afterCallback?.(finished);
 	}
 
 	function step(timestamp: DOMHighResTimeStamp): void {

package/types/timer.d.ts

@@ -78,13 +78,18 @@ 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;
 /**
  * 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.time` defaults to `0`
+ * - `options.count` defaults to `Infinity` _(minimum `1`)_
+ * - `options.interval` defaults to `0`
+ * - `options.timeout` defaults to `30_000` _(30 seconds)_
  */
 export declare function repeat(callback: IndexedCallback, options?: Partial<RepeatOptions>): Timer;
 /**