es-toolkit 1.33.0 → 1.34.0

package/dist/compat/math/minBy.d.mts

@@ -0,0 +1,31 @@
+/**
+ * Finds the element in an array that has the minium value when applying
+ * the `iteratee` to each element.
+ *
+ * @template T - The type of elements in the array.
+ * @param {T[]} items The array of elements to search.
+ * @param {((element: T) => number) | keyof T | [keyof T, unknown] | Partial<T>} iteratee
+ * The criteria used to determine the minium value.
+ *  - If a **function** is provided, it extracts a numeric value from each element.
+ *  - If a **string** is provided, it is treated as a key to extract values from the objects.
+ *  - If a **[key, value]** pair is provided, it matches elements with the specified key-value pair.
+ *  - If an **object** is provided, it matches elements that contain the specified properties.
+ * @returns {T | undefined} The element with the minium value as determined by the `iteratee`.
+ * @example
+ * minBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: { a: 1 }
+ * minBy([], x => x.a); // Returns: undefined
+ * minBy(
+ *   [
+ *     { name: 'john', age: 30 },
+ *     { name: 'jane', age: 28 },
+ *     { name: 'joe', age: 26 },
+ *   ],
+ *   x => x.age
+ * ); // Returns: { name: 'joe', age: 26 }
+ * minBy([{ a: 1 }, { a: 2 }], 'a'); // Returns: { a: 1 }
+ * minBy([{ a: 1 }, { a: 2 }], ['a', 1]); // Returns: { a: 2 }
+ * minBy([{ a: 1 }, { a: 2 }], { a: 1 }); // Returns: { a: 2 }
+ */
+declare function minBy<T>(items: ArrayLike<T> | null | undefined, iteratee: ((element: T) => number) | keyof T | [keyof T, unknown] | Partial<T>): T | undefined;
+
+export { minBy };

package/dist/compat/math/minBy.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Finds the element in an array that has the minium value when applying
+ * the `iteratee` to each element.
+ *
+ * @template T - The type of elements in the array.
+ * @param {T[]} items The array of elements to search.
+ * @param {((element: T) => number) | keyof T | [keyof T, unknown] | Partial<T>} iteratee
+ * The criteria used to determine the minium value.
+ *  - If a **function** is provided, it extracts a numeric value from each element.
+ *  - If a **string** is provided, it is treated as a key to extract values from the objects.
+ *  - If a **[key, value]** pair is provided, it matches elements with the specified key-value pair.
+ *  - If an **object** is provided, it matches elements that contain the specified properties.
+ * @returns {T | undefined} The element with the minium value as determined by the `iteratee`.
+ * @example
+ * minBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: { a: 1 }
+ * minBy([], x => x.a); // Returns: undefined
+ * minBy(
+ *   [
+ *     { name: 'john', age: 30 },
+ *     { name: 'jane', age: 28 },
+ *     { name: 'joe', age: 26 },
+ *   ],
+ *   x => x.age
+ * ); // Returns: { name: 'joe', age: 26 }
+ * minBy([{ a: 1 }, { a: 2 }], 'a'); // Returns: { a: 1 }
+ * minBy([{ a: 1 }, { a: 2 }], ['a', 1]); // Returns: { a: 2 }
+ * minBy([{ a: 1 }, { a: 2 }], { a: 1 }); // Returns: { a: 2 }
+ */
+declare function minBy<T>(items: ArrayLike<T> | null | undefined, iteratee: ((element: T) => number) | keyof T | [keyof T, unknown] | Partial<T>): T | undefined;
+
+export { minBy };

package/dist/compat/math/minBy.mjs

@@ -0,0 +1,11 @@
+import { minBy as minBy$1 } from '../../array/minBy.mjs';
+import { iteratee } from '../util/iteratee.mjs';
+
+function minBy(items, iteratee$1) {
+    if (items == null) {
+        return undefined;
+    }
+    return minBy$1(Array.from(items), iteratee(iteratee$1));
+}
+
+export { minBy };

package/dist/compat/math/subtract.mjs

@@ -1,4 +1,21 @@
+import { toNumber } from '../util/toNumber.mjs';
+import { toString } from '../util/toString.mjs';
+
 function subtract(value, other) {
+    if (value === undefined && other === undefined) {
+        return 0;
+    }
+    if (value === undefined || other === undefined) {
+        return value ?? other;
+    }
+    if (typeof value === 'string' || typeof other === 'string') {
+        value = toString(value);
+        other = toString(other);
+    }
+    else {
+        value = toNumber(value);
+        other = toNumber(other);
+    }
     return value - other;
 }
 

package/dist/compat/object/functionsIn.d.mts

@@ -0,0 +1,20 @@
+/**
+ * Returns an array of property names whose values are functions, including inherited properties.
+ *
+ * @param {*} object The object to inspect.
+ * @returns {Array} Returns the function names.
+ * @example
+ *
+ * function Foo() {
+ *   this.a = function() { return 'a'; };
+ *   this.b = function() { return 'b'; };
+ * }
+ *
+ * Foo.prototype.c = function() { return 'c'; };
+ *
+ * functionsIn(new Foo);
+ * // => ['a', 'b', 'c']
+ */
+declare function functionsIn(object: any): string[];
+
+export { functionsIn };

package/dist/compat/object/functionsIn.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Returns an array of property names whose values are functions, including inherited properties.
+ *
+ * @param {*} object The object to inspect.
+ * @returns {Array} Returns the function names.
+ * @example
+ *
+ * function Foo() {
+ *   this.a = function() { return 'a'; };
+ *   this.b = function() { return 'b'; };
+ * }
+ *
+ * Foo.prototype.c = function() { return 'c'; };
+ *
+ * functionsIn(new Foo);
+ * // => ['a', 'b', 'c']
+ */
+declare function functionsIn(object: any): string[];
+
+export { functionsIn };

package/dist/compat/object/functionsIn.mjs

@@ -0,0 +1,16 @@
+import { isFunction } from '../../predicate/isFunction.mjs';
+
+function functionsIn(object) {
+    if (object == null) {
+        return [];
+    }
+    const result = [];
+    for (const key in object) {
+        if (isFunction(object[key])) {
+            result.push(key);
+        }
+    }
+    return result;
+}
+
+export { functionsIn };

package/dist/compat/object/set.mjs

@@ -1,19 +1,32 @@
+import { assignValue } from '../_internal/assignValue.mjs';
 import { isIndex } from '../_internal/isIndex.mjs';
+import { isKey } from '../_internal/isKey.mjs';
+import { toKey } from '../_internal/toKey.mjs';
+import { isObject } from '../predicate/isObject.mjs';
 import { toPath } from '../util/toPath.mjs';
 
 function set(obj, path, value) {
-    const resolvedPath = Array.isArray(path) ? path : typeof path === 'string' ? toPath(path) : [path];
+    if (obj == null && !isObject(obj)) {
+        return obj;
+    }
+    const resolvedPath = isKey(path, obj)
+        ? [path]
+        : Array.isArray(path)
+            ? path
+            : typeof path === 'string'
+                ? toPath(path)
+                : [path];
     let current = obj;
-    for (let i = 0; i < resolvedPath.length - 1; i++) {
-        const key = resolvedPath[i];
-        const nextKey = resolvedPath[i + 1];
-        if (current[key] == null) {
-            current[key] = isIndex(nextKey) ? [] : {};
+    for (let i = 0; i < resolvedPath.length && current != null; i++) {
+        const key = toKey(resolvedPath[i]);
+        let newValue = value;
+        if (i !== resolvedPath.length - 1) {
+            const objValue = current[key];
+            newValue = isObject(objValue) ? objValue : isIndex(resolvedPath[i + 1]) ? [] : {};
         }
+        assignValue(current, key, newValue);
         current = current[key];
     }
-    const lastKey = resolvedPath[resolvedPath.length - 1];
-    current[lastKey] = value;
     return obj;
 }
 

package/dist/compat/util/invoke.mjs

@@ -34,7 +34,7 @@ function invokeImpl(object, path, args) {
         return undefined;
     }
     let lastKey = last(path);
-    let lastValue = lastKey?.valueOf();
+    const lastValue = lastKey?.valueOf();
     if (typeof lastValue === 'number') {
         lastKey = toKey(lastValue);
     }

package/dist/compat/util/stubObject.d.mts

@@ -5,6 +5,6 @@
  * @example
  * stubObject() // Returns {}
  */
-declare function stubObject(): {};
+declare function stubObject(): object;
 
 export { stubObject };

package/dist/compat/util/stubObject.d.ts

@@ -5,6 +5,6 @@
  * @example
  * stubObject() // Returns {}
  */
-declare function stubObject(): {};
+declare function stubObject(): object;
 
 export { stubObject };

package/dist/index.d.mts

@@ -112,6 +112,7 @@ export { toMerged } from './object/toMerged.mjs';
 export { isArrayBuffer } from './predicate/isArrayBuffer.mjs';
 export { isBlob } from './predicate/isBlob.mjs';
 export { isBoolean } from './predicate/isBoolean.mjs';
+export { isBrowser } from './predicate/isBrowser.mjs';
 export { isBuffer } from './predicate/isBuffer.mjs';
 export { isDate } from './predicate/isDate.mjs';
 export { isEqual } from './predicate/isEqual.mjs';
@@ -124,6 +125,7 @@ export { isJSONArray, isJSONObject, isJSONValue } from './predicate/isJSONValue.
 export { isLength } from './predicate/isLength.mjs';
 export { isMap } from './predicate/isMap.mjs';
 export { isNil } from './predicate/isNil.mjs';
+export { isNode } from './predicate/isNode.mjs';
 export { isNotNil } from './predicate/isNotNil.mjs';
 export { isNull } from './predicate/isNull.mjs';
 export { isPlainObject } from './predicate/isPlainObject.mjs';
@@ -163,4 +165,6 @@ export { unescape } from './string/unescape.mjs';
 export { upperCase } from './string/upperCase.mjs';
 export { upperFirst } from './string/upperFirst.mjs';
 export { words } from './string/words.mjs';
+export { attempt } from './util/attempt.mjs';
+export { attemptAsync } from './util/attemptAsync.mjs';
 export { invariant } from './util/invariant.mjs';

package/dist/index.d.ts

@@ -112,6 +112,7 @@ export { toMerged } from './object/toMerged.js';
 export { isArrayBuffer } from './predicate/isArrayBuffer.js';
 export { isBlob } from './predicate/isBlob.js';
 export { isBoolean } from './predicate/isBoolean.js';
+export { isBrowser } from './predicate/isBrowser.js';
 export { isBuffer } from './predicate/isBuffer.js';
 export { isDate } from './predicate/isDate.js';
 export { isEqual } from './predicate/isEqual.js';
@@ -124,6 +125,7 @@ export { isJSONArray, isJSONObject, isJSONValue } from './predicate/isJSONValue.
 export { isLength } from './predicate/isLength.js';
 export { isMap } from './predicate/isMap.js';
 export { isNil } from './predicate/isNil.js';
+export { isNode } from './predicate/isNode.js';
 export { isNotNil } from './predicate/isNotNil.js';
 export { isNull } from './predicate/isNull.js';
 export { isPlainObject } from './predicate/isPlainObject.js';
@@ -163,4 +165,6 @@ export { unescape } from './string/unescape.js';
 export { upperCase } from './string/upperCase.js';
 export { upperFirst } from './string/upperFirst.js';
 export { words } from './string/words.js';
+export { attempt } from './util/attempt.js';
+export { attemptAsync } from './util/attemptAsync.js';
 export { invariant } from './util/invariant.js';

package/dist/index.js

@@ -14,7 +14,7 @@ const randomInt = require('./_chunk/randomInt-CF7bZK.js');
 const math_index = require('./math/index.js');
 const toMerged = require('./_chunk/toMerged-CwnQF6.js');
 const object_index = require('./object/index.js');
-const isWeakSet = require('./_chunk/isWeakSet-TIM260.js');
+const isWeakSet = require('./_chunk/isWeakSet-CQZSI-.js');
 const predicate_index = require('./predicate/index.js');
 const isPlainObject = require('./_chunk/isPlainObject-Xaozpc.js');
 const delay = require('./_chunk/delay-_VMfFa.js');
@@ -22,6 +22,7 @@ const promise_index = require('./promise/index.js');
 const upperFirst = require('./_chunk/upperFirst-nA5L7X.js');
 const string_index = require('./string/index.js');
 const util_index = require('./util/index.js');
+const invariant = require('./_chunk/invariant-BfGFfr.js');
 
 
 
@@ -138,6 +139,7 @@ exports.pick = object_index.pick;
 exports.pickBy = object_index.pickBy;
 exports.isArrayBuffer = isWeakSet.isArrayBuffer;
 exports.isBlob = isWeakSet.isBlob;
+exports.isBrowser = isWeakSet.isBrowser;
 exports.isBuffer = isWeakSet.isBuffer;
 exports.isDate = isWeakSet.isDate;
 exports.isEqual = isWeakSet.isEqual;
@@ -151,6 +153,7 @@ exports.isJSONValue = isWeakSet.isJSONValue;
 exports.isLength = isWeakSet.isLength;
 exports.isMap = isWeakSet.isMap;
 exports.isNil = isWeakSet.isNil;
+exports.isNode = isWeakSet.isNode;
 exports.isNotNil = isWeakSet.isNotNil;
 exports.isNull = isWeakSet.isNull;
 exports.isPromise = isWeakSet.isPromise;
@@ -192,4 +195,6 @@ exports.upperCase = upperFirst.upperCase;
 exports.upperFirst = upperFirst.upperFirst;
 exports.words = upperFirst.words;
 exports.startCase = string_index.startCase;
-exports.invariant = util_index.invariant;
+exports.attempt = util_index.attempt;
+exports.attemptAsync = invariant.attemptAsync;
+exports.invariant = invariant.invariant;

package/dist/index.mjs

@@ -112,6 +112,7 @@ export { toMerged } from './object/toMerged.mjs';
 export { isArrayBuffer } from './predicate/isArrayBuffer.mjs';
 export { isBlob } from './predicate/isBlob.mjs';
 export { isBoolean } from './predicate/isBoolean.mjs';
+export { isBrowser } from './predicate/isBrowser.mjs';
 export { isBuffer } from './predicate/isBuffer.mjs';
 export { isDate } from './predicate/isDate.mjs';
 export { isEqual } from './predicate/isEqual.mjs';
@@ -124,6 +125,7 @@ export { isJSONArray, isJSONObject, isJSONValue } from './predicate/isJSONValue.
 export { isLength } from './predicate/isLength.mjs';
 export { isMap } from './predicate/isMap.mjs';
 export { isNil } from './predicate/isNil.mjs';
+export { isNode } from './predicate/isNode.mjs';
 export { isNotNil } from './predicate/isNotNil.mjs';
 export { isNull } from './predicate/isNull.mjs';
 export { isPlainObject } from './predicate/isPlainObject.mjs';
@@ -163,4 +165,6 @@ export { unescape } from './string/unescape.mjs';
 export { upperCase } from './string/upperCase.mjs';
 export { upperFirst } from './string/upperFirst.mjs';
 export { words } from './string/words.mjs';
+export { attempt } from './util/attempt.mjs';
+export { attemptAsync } from './util/attemptAsync.mjs';
 export { invariant } from './util/invariant.mjs';

package/dist/predicate/index.d.mts

@@ -1,6 +1,7 @@
 export { isArrayBuffer } from './isArrayBuffer.mjs';
 export { isBlob } from './isBlob.mjs';
 export { isBoolean } from './isBoolean.mjs';
+export { isBrowser } from './isBrowser.mjs';
 export { isBuffer } from './isBuffer.mjs';
 export { isDate } from './isDate.mjs';
 export { isEqual } from './isEqual.mjs';
@@ -13,6 +14,7 @@ export { isJSONArray, isJSONObject, isJSONValue } from './isJSONValue.mjs';
 export { isLength } from './isLength.mjs';
 export { isMap } from './isMap.mjs';
 export { isNil } from './isNil.mjs';
+export { isNode } from './isNode.mjs';
 export { isNotNil } from './isNotNil.mjs';
 export { isNull } from './isNull.mjs';
 export { isPlainObject } from './isPlainObject.mjs';

package/dist/predicate/index.d.ts

@@ -1,6 +1,7 @@
 export { isArrayBuffer } from './isArrayBuffer.js';
 export { isBlob } from './isBlob.js';
 export { isBoolean } from './isBoolean.js';
+export { isBrowser } from './isBrowser.js';
 export { isBuffer } from './isBuffer.js';
 export { isDate } from './isDate.js';
 export { isEqual } from './isEqual.js';
@@ -13,6 +14,7 @@ export { isJSONArray, isJSONObject, isJSONValue } from './isJSONValue.js';
 export { isLength } from './isLength.js';
 export { isMap } from './isMap.js';
 export { isNil } from './isNil.js';
+export { isNode } from './isNode.js';
 export { isNotNil } from './isNotNil.js';
 export { isNull } from './isNull.js';
 export { isPlainObject } from './isPlainObject.js';

package/dist/predicate/index.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
-const isWeakSet = require('../_chunk/isWeakSet-TIM260.js');
+const isWeakSet = require('../_chunk/isWeakSet-CQZSI-.js');
 const isPlainObject = require('../_chunk/isPlainObject-Xaozpc.js');
 
 function isBoolean(x) {
@@ -19,6 +19,7 @@ function isString(value) {
 
 exports.isArrayBuffer = isWeakSet.isArrayBuffer;
 exports.isBlob = isWeakSet.isBlob;
+exports.isBrowser = isWeakSet.isBrowser;
 exports.isBuffer = isWeakSet.isBuffer;
 exports.isDate = isWeakSet.isDate;
 exports.isEqual = isWeakSet.isEqual;
@@ -32,6 +33,7 @@ exports.isJSONValue = isWeakSet.isJSONValue;
 exports.isLength = isWeakSet.isLength;
 exports.isMap = isWeakSet.isMap;
 exports.isNil = isWeakSet.isNil;
+exports.isNode = isWeakSet.isNode;
 exports.isNotNil = isWeakSet.isNotNil;
 exports.isNull = isWeakSet.isNull;
 exports.isPromise = isWeakSet.isPromise;

package/dist/predicate/index.mjs

@@ -1,6 +1,7 @@
 export { isArrayBuffer } from './isArrayBuffer.mjs';
 export { isBlob } from './isBlob.mjs';
 export { isBoolean } from './isBoolean.mjs';
+export { isBrowser } from './isBrowser.mjs';
 export { isBuffer } from './isBuffer.mjs';
 export { isDate } from './isDate.mjs';
 export { isEqual } from './isEqual.mjs';
@@ -13,6 +14,7 @@ export { isJSONArray, isJSONObject, isJSONValue } from './isJSONValue.mjs';
 export { isLength } from './isLength.mjs';
 export { isMap } from './isMap.mjs';
 export { isNil } from './isNil.mjs';
+export { isNode } from './isNode.mjs';
 export { isNotNil } from './isNotNil.mjs';
 export { isNull } from './isNull.mjs';
 export { isPlainObject } from './isPlainObject.mjs';

package/dist/predicate/isBrowser.d.mts

@@ -0,0 +1,17 @@
+/**
+ * Checks if the current environment is a browser.
+ *
+ * This function checks for the existence of the `window.document` property,
+ * which only exists in browser environments.
+ *
+ * @returns {boolean} `true` if the current environment is a browser, otherwise `false`.
+ *
+ * @example
+ * if (isBrowser()) {
+ *   console.log("This is running in a browser");
+ *   document.getElementById('app').innerHTML = 'Hello World';
+ * }
+ */
+declare function isBrowser(): boolean;
+
+export { isBrowser };

package/dist/predicate/isBrowser.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Checks if the current environment is a browser.
+ *
+ * This function checks for the existence of the `window.document` property,
+ * which only exists in browser environments.
+ *
+ * @returns {boolean} `true` if the current environment is a browser, otherwise `false`.
+ *
+ * @example
+ * if (isBrowser()) {
+ *   console.log("This is running in a browser");
+ *   document.getElementById('app').innerHTML = 'Hello World';
+ * }
+ */
+declare function isBrowser(): boolean;
+
+export { isBrowser };

package/dist/predicate/isBrowser.mjs

@@ -0,0 +1,5 @@
+function isBrowser() {
+    return globalThis.window?.document != null;
+}
+
+export { isBrowser };

package/dist/predicate/isNode.d.mts

@@ -0,0 +1,17 @@
+/**
+ * Checks if the current environment is Node.js.
+ *
+ * This function checks for the existence of the `process.versions.node` property,
+ * which only exists in Node.js environments.
+ *
+ * @returns {boolean} `true` if the current environment is Node.js, otherwise `false`.
+ *
+ * @example
+ *if (isNode()) {
+ *   console.log('This is running in Node.js');
+ *   const fs = import('node:fs');
+ * }
+ */
+declare function isNode(): boolean;
+
+export { isNode };

package/dist/predicate/isNode.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Checks if the current environment is Node.js.
+ *
+ * This function checks for the existence of the `process.versions.node` property,
+ * which only exists in Node.js environments.
+ *
+ * @returns {boolean} `true` if the current environment is Node.js, otherwise `false`.
+ *
+ * @example
+ *if (isNode()) {
+ *   console.log('This is running in Node.js');
+ *   const fs = import('node:fs');
+ * }
+ */
+declare function isNode(): boolean;
+
+export { isNode };

package/dist/predicate/isNode.mjs

@@ -0,0 +1,5 @@
+function isNode() {
+    return globalThis.process?.versions?.node != null;
+}
+
+export { isNode };

package/dist/util/attempt.d.mts

@@ -0,0 +1,42 @@
+/**
+ * Attempt to execute a function and return the result or error.
+ * Returns a tuple where:
+ * - On success: [null, Result] - First element is null, second is the result
+ * - On error: [Error, null] - First element is the caught error, second is null
+ *
+ * @template {unknown} T - The type of the result of the function.
+ * @template {unknown} E - The type of the error that can be thrown by the function.
+ * @param {() => T} func - The function to execute.
+ * @returns {[null, T] | [E, null]} A tuple containing either [null, result] or [error, null].
+ *
+ * @example
+ * // Successful execution
+ * const [error, result] = attempt(() => 42);
+ * // [null, 42]
+ *
+ * // Failed execution
+ * const [error, result] = attempt(() => {
+ *   throw new Error('Something went wrong');
+ * });
+ * // [Error, null]
+ *
+ * // With type parameter
+ * const [error, names] = attempt<string[]>(() => ['Alice', 'Bob']);
+ * // [null, ['Alice', 'Bob']]
+ *
+ * @note
+ * Important: This function is not suitable for async functions (functions that return a `Promise`).
+ * When passing an async function, it will return `[null, Promise<Result>]`, but won't catch any
+ * errors if the Promise is rejected later.
+ *
+ * For handling async functions, use the `attemptAsync` function instead:
+ * ```
+ * const [error, data] = await attemptAsync(async () => {
+ *   const response = await fetch('https://api.example.com/data');
+ *   return response.json();
+ * });
+ * ```
+ */
+declare function attempt<T, E>(func: () => T): [null, T] | [E, null];
+
+export { attempt };

package/dist/util/attempt.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Attempt to execute a function and return the result or error.
+ * Returns a tuple where:
+ * - On success: [null, Result] - First element is null, second is the result
+ * - On error: [Error, null] - First element is the caught error, second is null
+ *
+ * @template {unknown} T - The type of the result of the function.
+ * @template {unknown} E - The type of the error that can be thrown by the function.
+ * @param {() => T} func - The function to execute.
+ * @returns {[null, T] | [E, null]} A tuple containing either [null, result] or [error, null].
+ *
+ * @example
+ * // Successful execution
+ * const [error, result] = attempt(() => 42);
+ * // [null, 42]
+ *
+ * // Failed execution
+ * const [error, result] = attempt(() => {
+ *   throw new Error('Something went wrong');
+ * });
+ * // [Error, null]
+ *
+ * // With type parameter
+ * const [error, names] = attempt<string[]>(() => ['Alice', 'Bob']);
+ * // [null, ['Alice', 'Bob']]
+ *
+ * @note
+ * Important: This function is not suitable for async functions (functions that return a `Promise`).
+ * When passing an async function, it will return `[null, Promise<Result>]`, but won't catch any
+ * errors if the Promise is rejected later.
+ *
+ * For handling async functions, use the `attemptAsync` function instead:
+ * ```
+ * const [error, data] = await attemptAsync(async () => {
+ *   const response = await fetch('https://api.example.com/data');
+ *   return response.json();
+ * });
+ * ```
+ */
+declare function attempt<T, E>(func: () => T): [null, T] | [E, null];
+
+export { attempt };

package/dist/util/attempt.mjs

@@ -0,0 +1,10 @@
+function attempt(func) {
+    try {
+        return [null, func()];
+    }
+    catch (error) {
+        return [error, null];
+    }
+}
+
+export { attempt };

package/dist/util/attemptAsync.d.mts

@@ -0,0 +1,35 @@
+/**
+ * Attempt to execute an async function and return the result or error.
+ * Returns a Promise that resolves to a tuple where:
+ * - On success: [null, Result] - First element is null, second is the result
+ * - On error: [Error, null] - First element is the caught error, second is null
+ *
+ * @template {unknown} T - The type of the result of the async function.
+ * @template {unknown} E - The type of the error that can be thrown by the async function.
+ * @param {() => Promise<T>} func - The async function to execute.
+ * @returns {Promise<[null, T] | [E, null]>} A Promise that resolves to a tuple containing either [null, result] or [error, null].
+ *
+ * @example
+ * // Successful execution
+ * const [error, data] = await attemptAsync(async () => {
+ *   const response = await fetch('https://api.example.com/data');
+ *   return response.json();
+ * });
+ * // If successful: [null, { ... data ... }]
+ *
+ * // Failed execution
+ * const [error, data] = await attemptAsync(async () => {
+ *   throw new Error('Network error');
+ * });
+ * // [Error, null]
+ *
+ * // With type parameter
+ * const [error, users] = await attemptAsync<User[]>(async () => {
+ *   const response = await fetch('https://api.example.com/users');
+ *   return response.json();
+ * });
+ * // users is typed as User[]
+ */
+declare function attemptAsync<T, E>(func: () => Promise<T>): Promise<[null, T] | [E, null]>;
+
+export { attemptAsync };