@tempots/std 0.22.1 → 0.24.0

package/async-result.d.ts

@@ -44,6 +44,16 @@ export type AsyncFailure<E> = {
  * @public
  */
 export type AsyncResult<V, E> = NotAsked | Loading<V> | AsyncSuccess<V> | AsyncFailure<E>;
+/**
+ * Represents a settled state in an asynchronous result.
+ * @public
+ */
+export type Settled<V, E> = AsyncSuccess<V> | AsyncFailure<E>;
+/**
+ * Represents a state in an asynchronous result that is not loading.
+ * @public
+ */
+export type NonLoading<V, E> = NotAsked | Settled<V, E>;
 /**
  * A set of utility functions for working with `AsyncResult`.
  * @public

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tempots/std",
-  "version": "0.22.1",
+  "version": "0.24.0",
   "priority": 8,
   "description": "Std library for TypeScript. Natural complement to the Tempo libraries.",
   "keywords": [

package/timer.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const p=(n,e)=>{const t=setTimeout(n,e);return()=>clearTimeout(t)},b=(n,e)=>{const t=setInterval(n,e);return()=>clearInterval(t)},F=(n,e,t={})=>{const{noTrailing:o=!1,noLeading:l=!1,debounceMode:i}=t;let a,m=!1,c=0;function f(){a&&clearTimeout(a)}function T(u){const{upcomingOnly:s=!1}=u||{};f(),m=!s}function d(...u){if(m)return;const s=this,v=Date.now()-c;function r(){c=Date.now(),e.apply(s,u)}function A(){a=void 0}!l&&i&&!a&&r(),f(),i===void 0&&v>n?l?(c=Date.now(),o||(a=setTimeout(i?A:r,n))):r():o||(a=setTimeout(i?A:r,i===void 0?n-v:n))}return d.cancel=T,d},g=(n,e,{atBegin:t=!1}={})=>F(n,e,{debounceMode:t!==!1}),y=n=>{let e=null;const t=l=>{e=null,n(l)};return(()=>{e==null&&(e=requestAnimationFrame(t))})(),()=>{e!=null&&(cancelAnimationFrame(e),e=null)}},I=n=>{let e=null;const t=l=>{e=requestAnimationFrame(t),n(l)};return(()=>{e==null&&(e=requestAnimationFrame(t))})(),()=>{e!=null&&(cancelAnimationFrame(e),e=null)}};exports.debounce=g;exports.delayed=p;exports.delayedAnimationFrame=y;exports.interval=b;exports.intervalAnimationFrame=I;exports.throttle=F;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const p=(n,e)=>{const t=setTimeout(n,e);return()=>clearTimeout(t)},b=(n,e)=>{const t=setInterval(n,e);return()=>clearInterval(t)};function F(n,e,t={}){const{noTrailing:o=!1,noLeading:l=!1,debounceMode:i}=t;let a,f=!1,c=0;function m(){a&&clearTimeout(a)}function T(u){const{upcomingOnly:s=!1}=u||{};m(),f=!s}function d(...u){if(f)return;const s=this,v=Date.now()-c;function r(){c=Date.now(),e.apply(s,u)}function A(){a=void 0}!l&&i&&!a&&r(),m(),i===void 0&&v>n?l?(c=Date.now(),o||(a=setTimeout(i?A:r,n))):r():o||(a=setTimeout(i?A:r,i===void 0?Math.max(0,n-v):n))}return d.cancel=T,d}function g(n,e,{atBegin:t=!1}={}){return F(n,e,{debounceMode:t!==!1})}const y=n=>{let e=null;const t=l=>{e=null,n(l)};return(()=>{e==null&&(e=requestAnimationFrame(t))})(),()=>{e!=null&&(cancelAnimationFrame(e),e=null)}},I=n=>{let e=null;const t=l=>{e=requestAnimationFrame(t),n(l)};return(()=>{e==null&&(e=requestAnimationFrame(t))})(),()=>{e!=null&&(cancelAnimationFrame(e),e=null)}};exports.debounce=g;exports.delayed=p;exports.delayedAnimationFrame=y;exports.interval=b;exports.intervalAnimationFrame=I;exports.throttle=F;

package/timer.d.ts

@@ -69,10 +69,26 @@ export interface CancelOptions {
  * Represents a throttled function with a cancel method.
  * @public
  */
-export interface ThrottledFunction<T extends unknown[]> {
-    (...args: T): void;
+export interface ThrottledFunction<TArgs extends any[], This = unknown> {
+    (this: This, ...args: TArgs): void;
     cancel: (options?: CancelOptions) => void;
 }
+export interface ThrottleOptions {
+    noTrailing?: boolean;
+    noLeading?: boolean;
+    debounceMode?: boolean;
+}
+/**
+ * Options for debouncing a function.
+ * @public
+ */
+export type DebounceOptions = {
+    /**
+     * If true, the callback is executed immediately before the delay.
+     * @default false
+     */
+    atBegin?: boolean;
+};
 /**
  * Copyright (c) Ivan Nikolić http://ivannikolic.com
  *
@@ -117,18 +133,7 @@ export interface ThrottledFunction<T extends unknown[]> {
  * Common delay values are 100-250ms for UI updates and 1000ms+ for API calls.
  * @public
  */
-export declare const throttle: <FN extends (...args: unknown[]) => void>(delay: number, callback: FN, options?: ThrottleOptions) => ThrottledFunction<Parameters<FN>>;
-/**
- * Options for debouncing a function.
- * @public
- */
-export type DebounceOptions = {
-    /**
-     * If true, the callback is executed immediately before the delay.
-     * @default false
-     */
-    atBegin?: boolean;
-};
+export declare function throttle<This, F extends (this: This, ...args: any[]) => any>(delay: number, callback: F, options?: ThrottleOptions): ThrottledFunction<Parameters<F>, This>;
 /**
  * Copyright (c) Ivan Nikolić http://ivannikolic.com
  *
@@ -153,16 +158,16 @@ export type DebounceOptions = {
  *
  * @param {number} delay -               A zero-or-greater delay in milliseconds. For event callbacks, values around 100 or 250 (or even higher) are most useful.
  * @param {Function} callback -          A function to be executed after delay milliseconds. The `this` context and all arguments are passed through, as-is,
- *                                        to `callback` when the debounced-function is executed.
+ *                                       to `callback` when the debounced-function is executed.
  * @param {object} [options] -           An object to configure options.
  * @param {boolean} [options.atBegin] -  Optional, defaults to false. If atBegin is false or unspecified, callback will only be executed `delay` milliseconds
- *                                        after the last debounced-function call. If atBegin is true, callback will be executed only at the first debounced-function call.
- *                                        (After the throttled-function has not been called for `delay` milliseconds, the internal counter is reset).
+ *                                       after the last debounced-function call. If atBegin is true, callback will be executed only at the first debounced-function call.
+ *                                       (After the throttled-function has not been called for `delay` milliseconds, the internal counter is reset).
  *
  * @returns {Function} A new, debounced function.
  * @public
  */
-export declare const debounce: <FN extends (...args: unknown[]) => void>(delay: number, callback: FN, { atBegin }?: DebounceOptions) => ThrottledFunction<Parameters<FN>>;
+export declare function debounce<This, F extends (this: This, ...args: any[]) => any>(delay: number, callback: F, { atBegin }?: DebounceOptions): ThrottledFunction<Parameters<F>, This>;
 /**
  * Delays the execution of a function using requestAnimationFrame.
  *

package/timer.js

@@ -1,14 +1,15 @@
 const T = (n, e) => {
   const t = setTimeout(n, e);
   return () => clearTimeout(t);
-}, I = (n, e) => {
+}, x = (n, e) => {
   const t = setInterval(n, e);
   return () => clearInterval(t);
-}, F = (n, e, t = {}) => {
-  const { noTrailing: a = !1, noLeading: l = !1, debounceMode: i } = t;
-  let o, f = !1, c = 0;
+};
+function F(n, e, t = {}) {
+  const { noTrailing: a = !1, noLeading: l = !1, debounceMode: o } = t;
+  let i, f = !1, c = 0;
   function m() {
-    o && clearTimeout(o);
+    i && clearTimeout(i);
   }
   function A(u) {
     const { upcomingOnly: s = !1 } = u || {};
@@ -21,15 +22,19 @@ const T = (n, e) => {
       c = Date.now(), e.apply(s, u);
     }
     function v() {
-      o = void 0;
+      i = void 0;
     }
-    !l && i && !o && r(), m(), i === void 0 && p > n ? l ? (c = Date.now(), a || (o = setTimeout(i ? v : r, n))) : r() : a || (o = setTimeout(
-      i ? v : r,
-      i === void 0 ? n - p : n
+    !l && o && !i && r(), m(), o === void 0 && p > n ? l ? (c = Date.now(), a || (i = setTimeout(o ? v : r, n))) : r() : a || (i = setTimeout(
+      o ? v : r,
+      o === void 0 ? Math.max(0, n - p) : n
     ));
   }
   return d.cancel = A, d;
-}, g = (n, e, { atBegin: t = !1 } = {}) => F(n, e, { debounceMode: t !== !1 }), w = (n) => {
+}
+function I(n, e, { atBegin: t = !1 } = {}) {
+  return F(n, e, { debounceMode: t !== !1 });
+}
+const g = (n) => {
   let e = null;
   const t = (l) => {
     e = null, n(l);
@@ -39,7 +44,7 @@ const T = (n, e) => {
   })(), () => {
     e != null && (cancelAnimationFrame(e), e = null);
   };
-}, x = (n) => {
+}, w = (n) => {
   let e = null;
   const t = (l) => {
     e = requestAnimationFrame(t), n(l);
@@ -51,10 +56,10 @@ const T = (n, e) => {
   };
 };
 export {
-  g as debounce,
+  I as debounce,
   T as delayed,
-  w as delayedAnimationFrame,
-  I as interval,
-  x as intervalAnimationFrame,
+  g as delayedAnimationFrame,
+  x as interval,
+  w as intervalAnimationFrame,
   F as throttle
 };