foxts 4.0.0 → 4.2.0

package/dist/abort-error/index.d.ts

@@ -0,0 +1,15 @@
+import { ErrorLikeObject } from '../extract-error-message/index.js';
+
+interface AbortErrorLike extends Omit<ErrorLikeObject, 'name'> {
+    name: 'AbortError';
+    code?: 'ABORT_ERR';
+}
+declare class AbortError extends Error implements AbortErrorLike {
+    readonly name = "AbortError";
+    readonly code = "ABORT_ERR";
+    constructor(message?: string, options?: ErrorOptions);
+}
+declare function isAbortErrorLike(error: unknown): error is AbortErrorLike;
+
+export { AbortError, isAbortErrorLike };
+export type { AbortErrorLike };

package/dist/abort-error/index.js

@@ -0,0 +1 @@
+"use strict";var r=require("../extract-error-message/index.js");exports.AbortError=class extends Error{name="AbortError";code="ABORT_ERR";constructor(r="The operation was aborted",e){super(r,e)}},exports.isAbortErrorLike=function(e){return!!r.isErrorLikeObject(e)&&("AbortError"===e.name||"code"in e&&"string"==typeof e.code&&"ABORT_ERR"===e.code)};

package/dist/abort-error/index.mjs

@@ -0,0 +1 @@
+import{isErrorLikeObject as r}from"../extract-error-message/index.mjs";class o extends Error{name="AbortError";code="ABORT_ERR";constructor(r="The operation was aborted",o){super(r,o)}}function e(o){return!!r(o)&&("AbortError"===o.name||"code"in o&&"string"==typeof o.code&&"ABORT_ERR"===o.code)}export{o as AbortError,e as isAbortErrorLike};

package/dist/async-retry/index.d.ts

@@ -0,0 +1,82 @@
+interface AsyncRetryContext {
+    readonly error: unknown;
+    readonly attemptNumber: number;
+    readonly retriesLeft: number;
+}
+interface AsyncRetryOptions {
+    /**
+      Callback invoked on each retry. Receives a context object containing the error and retry state information.
+  
+      The `onFailedAttempt` function can return a promise. For example, to add extra delay, especially useful reading `Retry-After` header.
+  
+      If the `onFailedAttempt` function throws, all retries will be aborted and the original promise will reject with the thrown error.
+      */
+    onFailedAttempt?: (context: AsyncRetryContext) => void | Promise<void>;
+    /**
+     * @deprecated Use `onFailedAttempt` instead. This is added only to be compatible with `async-retry`
+     */
+    onRetry?: (error: unknown, attemptNumber: number) => void | Promise<void>;
+    /**
+      Decide if a retry should occur based on the context. Returning true triggers a retry, false aborts with the error.
+  
+      It is only called if `retries` and `maxRetryTime` have not been exhausted.
+      It is not called for `TypeError` (except network errors) and `AbortError`.
+  
+      In the example above, the operation will be retried unless the error is an instance of `CustomError`.
+      */
+    shouldRetry?: (context: AsyncRetryContext) => boolean | Promise<boolean>;
+    /**
+     * @deprecated Use `retries` w/ `Number.POSITIVE_INFINITY` instead
+     */
+    forever?: boolean;
+    /**
+      The maximum amount of times to retry the operation.
+      @default 10
+      */
+    retries?: number;
+    /**
+      The exponential factor to use.
+      @default 2
+      */
+    factor?: number;
+    /**
+      The number of milliseconds before starting the first retry.
+      @default 1000
+      */
+    minTimeout?: number;
+    /**
+      The maximum number of milliseconds between two retries.
+      @default Infinity
+      */
+    maxTimeout?: number;
+    /**
+      Randomizes the timeouts by multiplying with a factor between 1 and 2.
+      @default true
+      */
+    randomize?: boolean;
+    /**
+      The maximum time (in milliseconds) that the retried operation is allowed to run.
+      @default Infinity
+      */
+    maxRetryTime?: number;
+    /**
+      You can abort retrying using [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+      */
+    signal?: AbortSignal;
+    /**
+      Prevents retry timeouts from keeping the process alive.
+      Only affects platforms with a `.unref()` method on timeouts, such as Node.js.
+      @default false
+      */
+    unref?: boolean;
+}
+declare class AsyncRetryAbortError extends Error {
+    name: string;
+    cause: unknown;
+    constructor(message: string | Error | unknown);
+}
+declare function asyncRetry<T>(callback: (bail: (reason?: unknown) => void, attemptNumber: number) => PromiseLike<T> | T, retryOptions?: AsyncRetryOptions): Promise<T>;
+declare function makeRetriable<Args extends unknown[], Result>(fn: (...args: Args) => PromiseLike<Result> | Result, options?: AsyncRetryOptions): (this: unknown, ...args: Args) => Promise<Result>;
+
+export { AsyncRetryAbortError, asyncRetry, makeRetriable };
+export type { AsyncRetryContext, AsyncRetryOptions };

package/dist/async-retry/index.js

@@ -0,0 +1 @@
+"use strict";var r=require("../abort-error/index.js"),t=require("../extract-error-message/index.js"),e=require("../is-network-error/index.js"),o=require("../noop/index.js");function i(r,t,{min:e=0,allowInfinity:o=!1}={}){if(Number.isNaN(t))throw TypeError(`Expected \`${r}\` to be a valid number${o?" or Infinity":""}, got NaN.`);if(!o&&!Number.isFinite(t))throw TypeError(`Expected \`${r}\` to be a finite number.`);if(t<e)throw TypeError(`Expected \`${r}\` to be \u2265 ${e}.`)}class n extends Error{name="AsyncRetryAbortError";cause;constructor(r){if(super("string"==typeof r?r:t.extractErrorMessage(r,!1)??"Aborted"),"string"==typeof r){const t=Error(r);t.stack=this.stack,this.cause=t}else r instanceof Error?(this.cause=r,this.message=r.message):this.cause=r}}async function a(t,o,i,a,s){if(t instanceof n)throw t.cause;if(t instanceof TypeError&&!e.isNetworkError(t)||r.isAbortErrorLike(t))throw t;const c=i.retries-(o-1),m={error:t,attemptNumber:o,retriesLeft:c};await i.onFailedAttempt(m),o>1&&await i.onRetry(t,o-1);const u=Date.now();if(u-a>=s||o>=i.retries+1||!await i.shouldRetry(m))throw t;let f=Math.round((i.randomize?Math.random()+1:1)*i.minTimeout*i.factor**(o-1));f=Math.min(f,i.maxTimeout);const l=s-(u-a);if(l<=0)throw t;const w=Math.min(f,l);w>0&&await new Promise((r,t)=>{const e=setTimeout(()=>{i.signal?.removeEventListener("abort",o),r()},w);function o(){clearTimeout(e),i.signal?.removeEventListener("abort",o),t(i.signal?.reason)}i.unref&&"object"==typeof e&&"unref"in e&&"function"==typeof e.unref&&e.unref(),i.signal?.addEventListener("abort",o,{once:!0})}),i.signal?.throwIfAborted()}function s(r){throw new n(r??"Aborted")}async function c(r,t={}){const e={...t};e.retries??=10,e.forever??=!1,e.factor??=2,e.minTimeout??=1e3,e.maxTimeout??=1/0,e.randomize??=!0,e.onFailedAttempt??=o.noop,e.onRetry??=o.noop,e.shouldRetry??=o.trueFn,e.forever&&(e.retries=1/0),i("retries",e.retries,{min:0,allowInfinity:!0}),i("factor",e.factor,{min:0,allowInfinity:!1}),i("minTimeout",e.minTimeout,{min:0,allowInfinity:!1}),i("maxTimeout",e.maxTimeout,{min:0,allowInfinity:!0});const m=e.maxRetryTime??1/0;i("maxRetryTime",m,{min:0,allowInfinity:!0}),e.minTimeout=Math.max(e.minTimeout,1),e.factor<=0&&(e.factor=1),e.signal?.throwIfAborted();let u=0;const f=Date.now();for(;u<e.retries+1;){u++;try{e.signal?.throwIfAborted();const t=await r(s,u);return e.signal?.throwIfAborted(),t}catch(t){let r=t;"object"==typeof t&&t&&"bail"in t&&t.bail&&(r=new n(t)),await a(r,u,e,f,m)}}throw Error("Retry attempts exhausted without throwing an error.")}exports.AsyncRetryAbortError=n,exports.asyncRetry=c,exports.makeRetriable=function(r,t){return function(...e){return c(()=>r.apply(this,e),t)}};

package/dist/async-retry/index.mjs

@@ -0,0 +1 @@
+import{isAbortErrorLike as t}from"../abort-error/index.mjs";import{extractErrorMessage as r}from"../extract-error-message/index.mjs";import{isNetworkError as e}from"../is-network-error/index.mjs";import{noop as o,trueFn as i}from"../noop/index.mjs";function n(t,r,{min:e=0,allowInfinity:o=!1}={}){if(Number.isNaN(r))throw TypeError(`Expected \`${t}\` to be a valid number${o?" or Infinity":""}, got NaN.`);if(!o&&!Number.isFinite(r))throw TypeError(`Expected \`${t}\` to be a finite number.`);if(r<e)throw TypeError(`Expected \`${t}\` to be \u2265 ${e}.`)}class a extends Error{name="AsyncRetryAbortError";cause;constructor(t){if(super("string"==typeof t?t:r(t,!1)??"Aborted"),"string"==typeof t){const r=Error(t);r.stack=this.stack,this.cause=r}else t instanceof Error?(this.cause=t,this.message=t.message):this.cause=t}}async function s(r,o,i,n,s){if(r instanceof a)throw r.cause;if(r instanceof TypeError&&!e(r)||t(r))throw r;const m=i.retries-(o-1),c={error:r,attemptNumber:o,retriesLeft:m};await i.onFailedAttempt(c),o>1&&await i.onRetry(r,o-1);const f=Date.now();if(f-n>=s||o>=i.retries+1||!await i.shouldRetry(c))throw r;let u=Math.round((i.randomize?Math.random()+1:1)*i.minTimeout*i.factor**(o-1));u=Math.min(u,i.maxTimeout);const l=s-(f-n);if(l<=0)throw r;const w=Math.min(u,l);w>0&&await new Promise((t,r)=>{const e=setTimeout(()=>{i.signal?.removeEventListener("abort",o),t()},w);function o(){clearTimeout(e),i.signal?.removeEventListener("abort",o),r(i.signal?.reason)}i.unref&&"object"==typeof e&&"unref"in e&&"function"==typeof e.unref&&e.unref(),i.signal?.addEventListener("abort",o,{once:!0})}),i.signal?.throwIfAborted()}function m(t){throw new a(t??"Aborted")}async function c(t,r={}){const e={...r};e.retries??=10,e.forever??=!1,e.factor??=2,e.minTimeout??=1e3,e.maxTimeout??=1/0,e.randomize??=!0,e.onFailedAttempt??=o,e.onRetry??=o,e.shouldRetry??=i,e.forever&&(e.retries=1/0),n("retries",e.retries,{min:0,allowInfinity:!0}),n("factor",e.factor,{min:0,allowInfinity:!1}),n("minTimeout",e.minTimeout,{min:0,allowInfinity:!1}),n("maxTimeout",e.maxTimeout,{min:0,allowInfinity:!0});const f=e.maxRetryTime??1/0;n("maxRetryTime",f,{min:0,allowInfinity:!0}),e.minTimeout=Math.max(e.minTimeout,1),e.factor<=0&&(e.factor=1),e.signal?.throwIfAborted();let u=0;const l=Date.now();for(;u<e.retries+1;){u++;try{e.signal?.throwIfAborted();const r=await t(m,u);return e.signal?.throwIfAborted(),r}catch(r){let t=r;"object"==typeof r&&r&&"bail"in r&&r.bail&&(t=new a(r)),await s(t,u,e,l,f)}}throw Error("Retry attempts exhausted without throwing an error.")}function f(t,r){return function(...e){return c(()=>t.apply(this,e),r)}}export{a as AsyncRetryAbortError,c as asyncRetry,f as makeRetriable};

package/dist/is-network-error/index.d.ts

@@ -0,0 +1,3 @@
+declare function isNetworkError(error: unknown): boolean;
+
+export { isNetworkError };

package/dist/is-network-error/index.js

@@ -0,0 +1 @@
+"use strict";const e=Object.prototype.toString,r=new Set(["network error","Failed to fetch","NetworkError when attempting to fetch resource.","The Internet connection appears to be offline.","Network request failed","fetch failed","terminated"," A network error occurred.","Network connection lost"]),t=new Set(["ETIMEDOUT","ECONNRESET","ECONNREFUSED","ENOTFOUND","ENETDOWN","ENETUNREACH","EHOSTDOWN","EHOSTUNREACH","EPIPE","UND_ERR_SOCKET","UND_ERR_HEADERS_TIMEOUT"]);exports.isNetworkError=function(o){if("object"!=typeof o||null==o)return!1;if("code"in o&&"string"==typeof o.code){if("ERR_UNESCAPED_CHARACTERS"===o.code)return!1;if(t.has(o.code))return!0}if(!(o&&"[object Error]"===e.call(o)&&"TypeError"===o.name&&"string"==typeof o.message))return!1;const{message:n,stack:E}=o;return"Load failed"===n?void 0===E||"__sentry_captured__"in o:!!n.startsWith("error sending request for url")||r.has(n)};

package/dist/is-network-error/index.mjs

@@ -0,0 +1 @@
+const e=Object.prototype.toString,r=new Set(["network error","Failed to fetch","NetworkError when attempting to fetch resource.","The Internet connection appears to be offline.","Network request failed","fetch failed","terminated"," A network error occurred.","Network connection lost"]),t=new Set(["ETIMEDOUT","ECONNRESET","ECONNREFUSED","ENOTFOUND","ENETDOWN","ENETUNREACH","EHOSTDOWN","EHOSTUNREACH","EPIPE","UND_ERR_SOCKET","UND_ERR_HEADERS_TIMEOUT"]);function o(o){if("object"!=typeof o||null==o)return!1;if("code"in o&&"string"==typeof o.code){if("ERR_UNESCAPED_CHARACTERS"===o.code)return!1;if(t.has(o.code))return!0}if(!(o&&"[object Error]"===e.call(o)&&"TypeError"===o.name&&"string"==typeof o.message))return!1;const{message:n,stack:E}=o;return"Load failed"===n?void 0===E||"__sentry_captured__"in o:!!n.startsWith("error sending request for url")||r.has(n)}export{o as isNetworkError};

package/dist/wait-until/index.d.ts

@@ -0,0 +1,12 @@
+type FalsyValue = null | undefined | false | '' | 0 | void;
+type TruthyValue = Record<string, unknown> | unknown[] | symbol | ((..._args: unknown[]) => unknown) | Exclude<number, 0> | Exclude<string, ''> | true;
+type CleanupFn = () => void;
+type OnCleanup = (cleanUpFn: CleanupFn) => void;
+type Scheduler = (callback: () => Promise<void>, onCleanup: OnCleanup) => void | CleanupFn;
+type Predicate<T extends TruthyValue | FalsyValue> = () => T | Promise<T>;
+declare function waitUntil<T extends TruthyValue | FalsyValue>(predicate: Predicate<T>, scheduler: Scheduler, abortSignal?: AbortSignal | null): Promise<T>;
+declare function waitUntil<T extends TruthyValue | FalsyValue>(predicate: Predicate<T>, checkInterval?: number, abortSignal?: AbortSignal | null): Promise<T>;
+declare function waitUntil<T extends TruthyValue | FalsyValue>(predicate: Predicate<T>, abortSignal: AbortSignal): Promise<T>;
+
+export { waitUntil };
+export type { CleanupFn, OnCleanup, Predicate, Scheduler };

package/dist/wait-until/index.js

@@ -0,0 +1 @@
+"use strict";exports.waitUntil=function(t,e=50,o=null){if("object"==typeof e&&"aborted"in e&&(o=e,e=50),"number"==typeof e){const t=e;e=(e,o)=>{const n=setTimeout(e,t);o(()=>clearTimeout(n))}}o??=AbortSignal.timeout(5e3);const n=new Set,r=t=>n.add(t);return new Promise((n,i)=>{const c=async()=>{try{o.throwIfAborted();const i=await t();if(i)return void n(i);e(c,r)}catch(t){i(t)}};c()}).finally(()=>{n.forEach(t=>t())})};

package/dist/wait-until/index.mjs

@@ -0,0 +1 @@
+function t(e,o=50,n=null){if("object"==typeof o&&"aborted"in o&&(n=o,o=50),"number"==typeof o){const t=o;o=(e,o)=>{const n=setTimeout(e,t);o(()=>clearTimeout(n))}}n??=AbortSignal.timeout(5e3);const r=new Set,i=t=>r.add(t);return new Promise((t,r)=>{const c=async()=>{try{n.throwIfAborted();const r=await e();if(r)return void t(r);o(c,i)}catch(t){r(t)}};c()}).finally(()=>{r.forEach(t=>t())})}export{t as waitUntil};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "foxts",
-  "version": "4.0.0",
+  "version": "4.2.0",
   "description": "Opinionated collection of common TypeScript utils by @SukkaW",
   "repository": {
     "url": "https://github.com/SukkaW/foxts"
@@ -10,6 +10,12 @@
   ],
   "exports": {
     "./package.json": "./package.json",
+    "./abort-error": {
+      "types": "./dist/abort-error/index.d.ts",
+      "import": "./dist/abort-error/index.mjs",
+      "require": "./dist/abort-error/index.js",
+      "default": "./dist/abort-error/index.js"
+    },
     "./add-array-elements-to-set": {
       "types": "./dist/add-array-elements-to-set/index.d.ts",
       "import": "./dist/add-array-elements-to-set/index.mjs",
@@ -34,6 +40,12 @@
       "require": "./dist/append-set-elements-to-array/index.js",
       "default": "./dist/append-set-elements-to-array/index.js"
     },
+    "./async-retry": {
+      "types": "./dist/async-retry/index.d.ts",
+      "import": "./dist/async-retry/index.mjs",
+      "require": "./dist/async-retry/index.js",
+      "default": "./dist/async-retry/index.js"
+    },
     "./async-write-to-stream": {
       "types": "./dist/async-write-to-stream/index.d.ts",
       "import": "./dist/async-write-to-stream/index.mjs",
@@ -166,6 +178,12 @@
       "require": "./dist/is-function/index.js",
       "default": "./dist/is-function/index.js"
     },
+    "./is-network-error": {
+      "types": "./dist/is-network-error/index.d.ts",
+      "import": "./dist/is-network-error/index.mjs",
+      "require": "./dist/is-network-error/index.js",
+      "default": "./dist/is-network-error/index.js"
+    },
     "./is-probably-ip": {
       "types": "./dist/is-probably-ip/index.d.ts",
       "import": "./dist/is-probably-ip/index.mjs",
@@ -267,6 +285,12 @@
       "import": "./dist/wait/index.mjs",
       "require": "./dist/wait/index.js",
       "default": "./dist/wait/index.js"
+    },
+    "./wait-until": {
+      "types": "./dist/wait-until/index.d.ts",
+      "import": "./dist/wait-until/index.mjs",
+      "require": "./dist/wait-until/index.js",
+      "default": "./dist/wait-until/index.js"
     }
   },
   "sideEffects": false,
@@ -283,6 +307,7 @@
   },
   "devDependencies": {
     "@eslint-sukka/node": "^7.2.1",
+    "@happy-dom/global-registrator": "^19.0.2",
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
     "@mitata/counters": "^0.0.8",
     "@monyone/aho-corasick": "^1.0.4",
@@ -290,28 +315,32 @@
     "@swc-node/register": "^1.11.1",
     "@swc/core": "^1.13.20",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^22.18.6",
+    "@types/node": "^22.18.8",
     "@types/sinon": "^17.0.4",
     "bumpp": "^10.2.3",
     "devalue": "^5.3.2",
-    "eslint": "^9.36.0",
+    "eslint": "^9.37.0",
     "eslint-config-sukka": "^7.2.1",
     "eslint-formatter-sukka": "^7.2.1",
     "expect": "^30.2.0",
     "fastscan": "^1.0.6",
+    "happy-dom": "^19.0.2",
+    "is-ci": "^4.1.0",
+    "is-network-error": "^1.3.0",
     "mitata": "^1.0.34",
-    "mocha": "^11.7.2",
+    "mocha": "^11.7.4",
     "modern-ahocorasick": "^2.0.4",
     "nyc": "^17.1.0",
-    "rollup": "^4.52.3",
+    "rollup": "^4.52.4",
     "rollup-plugin-dts": "^6.2.3",
+    "rollup-plugin-oxc-resolve": "^0.0.4",
     "rollup-plugin-swc3": "^0.12.1",
     "sinon": "^21.0.0",
     "word-list": "3.0.0"
   },
   "scripts": {
     "lint": "eslint --format=sukka .",
-    "test": "SWC_NODE_IGNORE_DYNAMIC=1 SWC_NODE_INLINE_SOURCE_MAP=1 nyc mocha --require @swc-node/register --full-trace ./src/**/*.test.ts",
+    "test": "SWC_NODE_IGNORE_DYNAMIC=1 SWC_NODE_INLINE_SOURCE_MAP=1 nyc mocha --require @swc-node/register --parallel --full-trace ./src/**/*.test.ts",
     "bench": "SWC_NODE_IGNORE_DYNAMIC=1 node --require @swc-node/register",
     "bench:all": "SWC_NODE_IGNORE_DYNAMIC=1 node --require @swc-node/register ./src/**/*.bench.ts",
     "build": "rollup -c rollup.config.ts --bundleConfigAsCjs --configPlugin swc3",