es-toolkit 1.10.1-dev.250 → 1.10.1-dev.252

package/dist/chunk-J3GE7DEU.mjs

@@ -0,0 +1,22 @@
+import {
+  delay
+} from "./chunk-O64NE2P4.mjs";
+import {
+  TimeoutError
+} from "./chunk-KIOYQRMQ.mjs";
+import {
+  __async
+} from "./chunk-424M7IR7.mjs";
+
+// src/promise/timeout.ts
+function timeout(ms) {
+  return __async(this, null, function* () {
+    yield delay(ms);
+    throw new TimeoutError();
+  });
+}
+
+export {
+  timeout
+};
+//# sourceMappingURL=chunk-J3GE7DEU.mjs.map

package/dist/chunk-J3GE7DEU.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/promise/timeout.ts"],"sourcesContent":["import { delay } from './delay.ts';\nimport { TimeoutError } from '../error/TimeoutError.ts';\n\n/**\n * Returns a promise that rejects with a `TimeoutError` after a specified delay.\n *\n * @param {number} ms - The delay duration in milliseconds.\n * @returns {Promise<void>} A promise that rejects with a `TimeoutError` after the specified delay.\n * @throws {TimeoutError} Throws a `TimeoutError` after the specified delay.\n */\nexport async function timeout(ms: number): Promise<never> {\n  await delay(ms);\n  throw new TimeoutError();\n}\n"],"mappings":";;;;;;;;;;;AAUA,SAAsB,QAAQ,IAA4B;AAAA;AACxD,UAAM,MAAM,EAAE;AACd,UAAM,IAAI,aAAa;AAAA,EACzB;AAAA;","names":[]}

package/dist/chunk-KIOYQRMQ.mjs

@@ -0,0 +1,12 @@
+// src/error/TimeoutError.ts
+var TimeoutError = class extends Error {
+  constructor(message = "The operation was timed out") {
+    super(message);
+    this.name = "TimeoutError";
+  }
+};
+
+export {
+  TimeoutError
+};
+//# sourceMappingURL=chunk-KIOYQRMQ.mjs.map

package/dist/chunk-KIOYQRMQ.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/error/TimeoutError.ts"],"sourcesContent":["/**\n * An error class representing an timeout operation.\n * @augments Error\n */\nexport class TimeoutError extends Error {\n  constructor(message = 'The operation was timed out') {\n    super(message);\n    this.name = 'TimeoutError';\n  }\n}\n"],"mappings":";AAIO,IAAM,eAAN,cAA2B,MAAM;AAAA,EACtC,YAAY,UAAU,+BAA+B;AACnD,UAAM,OAAO;AACb,SAAK,OAAO;AAAA,EACd;AACF;","names":[]}

package/dist/{chunk-QZITBKWX.mjs → chunk-U7V3G7CR.mjs}

@@ -1,6 +1,6 @@
 import {
   __spreadValues
-} from "./chunk-2MM5EJJX.mjs";
+} from "./chunk-424M7IR7.mjs";
 
 // src/object/omit.ts
 function omit(obj, keys) {
@@ -14,4 +14,4 @@ function omit(obj, keys) {
 export {
   omit
 };
-//# sourceMappingURL=chunk-QZITBKWX.mjs.map
+//# sourceMappingURL=chunk-U7V3G7CR.mjs.map

package/dist/chunk-XT74R35S.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=chunk-XT74R35S.mjs.map

package/dist/chunk-XWPCDIFC.mjs

@@ -0,0 +1,18 @@
+import {
+  timeout
+} from "./chunk-J3GE7DEU.mjs";
+import {
+  __async
+} from "./chunk-424M7IR7.mjs";
+
+// src/promise/withTimeout.ts
+function withTimeout(run, ms) {
+  return __async(this, null, function* () {
+    return Promise.race([run(), timeout(ms)]);
+  });
+}
+
+export {
+  withTimeout
+};
+//# sourceMappingURL=chunk-XWPCDIFC.mjs.map

package/dist/chunk-XWPCDIFC.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/promise/withTimeout.ts"],"sourcesContent":["import { timeout } from './timeout.ts';\n\n/**\n * Executes an async function and enforces a timeout. \n * \n * If the promise does not resolve within the specified time,\n * the timeout will trigger and the returned promise will be rejected.\n *\n *\n * @template T \n * @param {() => Promise<T>} run - A function that returns a promise to be executed.\n * @param {number} ms - The timeout duration in milliseconds.\n * @returns {Promise<T>} A promise that resolves with the result of the `run` function or rejects if the timeout is reached.\n *\n * @example\n * try {\n *   await withTimeout(() => {}, 1000); // Timeout exception after 1 second\n * } catch (error) {\n *   console.error(error); // Will log 'TimeoutError'\n * }\n */\nexport async function withTimeout<T>(run: () => Promise<T>, ms: number): Promise<T> {\n  return Promise.race([run(), timeout(ms) as T]);\n}\n"],"mappings":";;;;;;;;AAqBA,SAAsB,YAAe,KAAuB,IAAwB;AAAA;AAClF,WAAO,QAAQ,KAAK,CAAC,IAAI,GAAG,QAAQ,EAAE,CAAM,CAAC;AAAA,EAC/C;AAAA;","names":[]}

package/dist/compat/index.d.mts

@@ -49,6 +49,7 @@ export { toFilled } from '../array/toFilled.mjs';
 export { last } from '../array/last.mjs';
 export { initial } from '../array/initial.mjs';
 export { AbortError } from '../error/AbortError.mjs';
+export { TimeoutError } from '../error/TimeoutError.mjs';
 export { debounce } from '../function/debounce.mjs';
 export { noop } from '../function/noop.mjs';
 export { once } from '../function/once.mjs';
@@ -77,13 +78,12 @@ export { isNotNil } from '../predicate/isNotNil.mjs';
 export { isNull } from '../predicate/isNull.mjs';
 export { isUndefined } from '../predicate/isUndefined.mjs';
 export { delay } from '../promise/delay.mjs';
+export { withTimeout } from '../promise/withTimeout.mjs';
 export { camelCase } from '../string/camelCase.mjs';
 export { snakeCase } from '../string/snakeCase.mjs';
 export { kebabCase } from '../string/kebabCase.mjs';
 export { lowerCase } from '../string/lowerCase.mjs';
 export { startCase } from '../string/startCase.mjs';
-export { startsWith } from '../string/startsWith.mjs';
-export { endsWith } from '../string/endsWith.mjs';
 export { capitalize } from '../string/capitalize.mjs';
 
 /**
@@ -176,4 +176,42 @@ declare function zipObjectDeep<P extends string | number | symbol, V>(keys: P[],
  */
 declare function set<T>(obj: object, path: PropertyKey | readonly PropertyKey[], value: unknown): T;
 
-export { chunk, set, zipObjectDeep };
+/**
+ * Checks if a string contains another string at the beginning of the string.
+ *
+ * Checks if one string startsWith another string. Optional position parameter to start searching from a certain index.
+ *
+ * @param {string} str - The string that might contain the target string.
+ * @param {string} target - The string to search for.
+ * @param {number} position - An optional offset to start searching in the str string
+ * @returns {boolean} - True if the str string starts with the target string.
+ *
+ * @example
+ * const isPrefix = startsWith('fooBar', 'foo') // returns true
+ * const isPrefix = startsWith('fooBar', 'bar') // returns false
+ * const isPrefix = startsWith('fooBar', 'abc') // returns false
+ * const isPrefix = startsWith('fooBar', 'Bar', 2) // returns true
+ * const isPrefix = startsWith('fooBar', 'Bar', 5) // returns false
+ */
+declare const startsWith: (str: string, target: string, position?: number) => boolean;
+
+/**
+ * Checks if a string contains another string at the end of the string.
+ *
+ * Checks if one string endsWith another string. Optional position parameter to offset searching before a certain index.
+ *
+ * @param {string} str - The string that might contain the target string.
+ * @param {string} target - The string to search for.
+ * @param {number} position - An optional position from the start to search up to this index
+ * @returns {boolean} - True if the str string ends with the target string.
+ *
+ * @example
+ * const isPrefix = endsWith('fooBar', 'foo') // returns true
+ * const isPrefix = endsWith('fooBar', 'bar') // returns false
+ * const isPrefix = endsWith('fooBar', 'abc') // returns false
+ * const isPrefix = endsWith('fooBar', 'foo', 3) // returns true
+ * const isPrefix = endsWith('fooBar', 'abc', 5) // returns false
+ */
+declare const endsWith: (str: string, target: string, position?: number) => boolean;
+
+export { chunk, endsWith, set, startsWith, zipObjectDeep };

package/dist/compat/index.d.ts

@@ -49,6 +49,7 @@ export { toFilled } from '../array/toFilled.js';
 export { last } from '../array/last.js';
 export { initial } from '../array/initial.js';
 export { AbortError } from '../error/AbortError.js';
+export { TimeoutError } from '../error/TimeoutError.js';
 export { debounce } from '../function/debounce.js';
 export { noop } from '../function/noop.js';
 export { once } from '../function/once.js';
@@ -77,13 +78,12 @@ export { isNotNil } from '../predicate/isNotNil.js';
 export { isNull } from '../predicate/isNull.js';
 export { isUndefined } from '../predicate/isUndefined.js';
 export { delay } from '../promise/delay.js';
+export { withTimeout } from '../promise/withTimeout.js';
 export { camelCase } from '../string/camelCase.js';
 export { snakeCase } from '../string/snakeCase.js';
 export { kebabCase } from '../string/kebabCase.js';
 export { lowerCase } from '../string/lowerCase.js';
 export { startCase } from '../string/startCase.js';
-export { startsWith } from '../string/startsWith.js';
-export { endsWith } from '../string/endsWith.js';
 export { capitalize } from '../string/capitalize.js';
 
 /**
@@ -176,4 +176,42 @@ declare function zipObjectDeep<P extends string | number | symbol, V>(keys: P[],
  */
 declare function set<T>(obj: object, path: PropertyKey | readonly PropertyKey[], value: unknown): T;
 
-export { chunk, set, zipObjectDeep };
+/**
+ * Checks if a string contains another string at the beginning of the string.
+ *
+ * Checks if one string startsWith another string. Optional position parameter to start searching from a certain index.
+ *
+ * @param {string} str - The string that might contain the target string.
+ * @param {string} target - The string to search for.
+ * @param {number} position - An optional offset to start searching in the str string
+ * @returns {boolean} - True if the str string starts with the target string.
+ *
+ * @example
+ * const isPrefix = startsWith('fooBar', 'foo') // returns true
+ * const isPrefix = startsWith('fooBar', 'bar') // returns false
+ * const isPrefix = startsWith('fooBar', 'abc') // returns false
+ * const isPrefix = startsWith('fooBar', 'Bar', 2) // returns true
+ * const isPrefix = startsWith('fooBar', 'Bar', 5) // returns false
+ */
+declare const startsWith: (str: string, target: string, position?: number) => boolean;
+
+/**
+ * Checks if a string contains another string at the end of the string.
+ *
+ * Checks if one string endsWith another string. Optional position parameter to offset searching before a certain index.
+ *
+ * @param {string} str - The string that might contain the target string.
+ * @param {string} target - The string to search for.
+ * @param {number} position - An optional position from the start to search up to this index
+ * @returns {boolean} - True if the str string ends with the target string.
+ *
+ * @example
+ * const isPrefix = endsWith('fooBar', 'foo') // returns true
+ * const isPrefix = endsWith('fooBar', 'bar') // returns false
+ * const isPrefix = endsWith('fooBar', 'abc') // returns false
+ * const isPrefix = endsWith('fooBar', 'foo', 3) // returns true
+ * const isPrefix = endsWith('fooBar', 'abc', 5) // returns false
+ */
+declare const endsWith: (str: string, target: string, position?: number) => boolean;
+
+export { chunk, endsWith, set, startsWith, zipObjectDeep };

package/dist/compat/index.js

@@ -30,11 +30,32 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
 
 // src/compat/index.ts
 var compat_exports = {};
 __export(compat_exports, {
   AbortError: () => AbortError,
+  TimeoutError: () => TimeoutError,
   camelCase: () => camelCase,
   capitalize: () => capitalize,
   chunk: () => chunk2,
@@ -116,6 +137,7 @@ __export(compat_exports, {
   uniqWith: () => uniqWith,
   unzip: () => unzip,
   unzipWith: () => unzipWith,
+  withTimeout: () => withTimeout,
   without: () => without,
   xor: () => xor,
   xorBy: () => xorBy,
@@ -656,6 +678,14 @@ var AbortError = class extends Error {
   }
 };
 
+// src/error/TimeoutError.ts
+var TimeoutError = class extends Error {
+  constructor(message = "The operation was timed out") {
+    super(message);
+    this.name = "TimeoutError";
+  }
+};
+
 // src/function/debounce.ts
 function debounce(func, debounceMs, { signal } = {}) {
   let timeoutId = null;
@@ -988,6 +1018,21 @@ function delay(ms, { signal } = {}) {
   });
 }
 
+// src/promise/timeout.ts
+function timeout(ms) {
+  return __async(this, null, function* () {
+    yield delay(ms);
+    throw new TimeoutError();
+  });
+}
+
+// src/promise/withTimeout.ts
+function withTimeout(run, ms) {
+  return __async(this, null, function* () {
+    return Promise.race([run(), timeout(ms)]);
+  });
+}
+
 // src/string/capitalize.ts
 var capitalize = (str) => {
   return str.charAt(0).toUpperCase() + str.slice(1).toLowerCase();
@@ -1045,16 +1090,6 @@ function startCase(str) {
   return result;
 }
 
-// src/string/startsWith.ts
-var startsWith = (str, target, position = 0) => {
-  return str.startsWith(target, position);
-};
-
-// src/string/endsWith.ts
-var endsWith = (str, target, position = str.length) => {
-  return str.endsWith(target, position);
-};
-
 // src/compat/array/chunk.ts
 function chunk2(arr, size = 1) {
   size = Math.max(Math.floor(size), 0);
@@ -1134,9 +1169,20 @@ function zipObjectDeep(keys, values) {
   }
   return result;
 }
+
+// src/compat/string/startsWith.ts
+var startsWith = (str, target, position = 0) => {
+  return str.startsWith(target, position);
+};
+
+// src/compat/string/endsWith.ts
+var endsWith = (str, target, position = str.length) => {
+  return str.endsWith(target, position);
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AbortError,
+  TimeoutError,
   camelCase,
   capitalize,
   chunk,
@@ -1218,6 +1264,7 @@ function zipObjectDeep(keys, values) {
   uniqWith,
   unzip,
   unzipWith,
+  withTimeout,
   without,
   xor,
   xorBy,