es-toolkit 1.26.1-dev.858 → 1.26.1-dev.860

package/dist/compat/array/forEach.d.mts

@@ -0,0 +1,106 @@
+/**
+ * Iterates over each element of the array invoking the provided callback function for each element.
+ *
+ * @template K - The type of elements in the array.
+ * @template T - The type of the array.
+ * @param {T | null | undefined} array - The array to iterate over.
+ * @param {(value: K, index: number, array: T) => unknown} [callback] - The function invoked for each element.
+ * The callback function receives three arguments:
+ *  - 'value': The current element being processed in the array.
+ *  - 'index': The index of the current element being processed in the array.
+ *  - 'array': The array 'forEach' was called upon.
+ * @returns {T} Returns the original array.
+ *
+ * @example
+ * forEach([1, 2, 3], (value, index, array) => console.log(value, index));
+ * // Output:
+ * // 1 0
+ * // 2 1
+ * // 3 2
+ *
+ */
+declare function forEach<T>(array: T[], callback?: (value: T, index: number, array: T[]) => unknown): T[];
+/**
+ * Iterates over each element of the array invoking the provided callback function for each element.
+ *
+ * @template K - The type of elements in the array.
+ * @template T - The type of the array.
+ * @param {T | null | undefined} array - The array to iterate over.
+ * @param {(value: K, index: number, array: T) => unknown} [callback] - The function invoked for each element.
+ * The callback function receives three arguments:
+ *  - 'value': The current element being processed in the array.
+ *  - 'index': The index of the current element being processed in the array.
+ *  - 'array': The array 'forEach' was called upon.
+ * @returns {T} Returns the original array.
+ *
+ * @example
+ * forEach([1, 2, 3], (value, index, array) => console.log(value, index));
+ * // Output:
+ * // 1 0
+ * // 2 1
+ * // 3 2
+ *
+ */
+declare function forEach<T>(array: readonly T[], callback?: (value: T, index: number, array: T[]) => unknown): readonly T[];
+/**
+ * Iterates over each element of the array invoking the provided callback function for each element.
+ *
+ * @template T - The type of string.
+ * @param {T | null | undefined} string - The string to iterate over
+ * @param {(value: T, index: number, string: T) => unknown} [callback] - The function invoked for each char.
+ * The callback function receives three arguments:
+ *  - 'char': The current char being processed in the string.
+ *  - 'index': The index of the current char being processed in the string.
+ *  - 'string': The string 'forEach' was called upon.
+ * @returns {T} Returns the original string.
+ *
+ * @example
+ * forEach('abc', (char, index, string) => console.log(char, index));
+ * // Output:
+ * // 'a' 0
+ * // 'b' 1
+ * // 'c' 2
+ */
+declare function forEach<T extends string | null | undefined>(string: T, callback?: (char: string, index: number, string: string) => unknown): T;
+/**
+ * Iterates over each element of the array invoking the provided callback function for each element.
+ *
+ * @template T - The type of elements in the array.
+ * @param { ArrayLike<T> } array - The array to iterate over.
+ * @param {(value: T, index: number, array: ArrayLike<T>) => unknown} [callback] - The function invoked for each element.
+ * The callback function receives three arguments:
+ *  - 'value': The current element being processed in the array.
+ *  - 'index': The index of the current element being processed in the array.
+ *  - 'array': The array 'forEach' was called upon.
+ * @returns {T} Returns the original array.
+ *
+ * @example
+ * forEach([1, 2, 3], (value, index, array) => console.log(value, index));
+ * // Output:
+ * // 1 0
+ * // 2 1
+ * // 3 2
+ *
+ */
+declare function forEach<T>(array: ArrayLike<T>, callback?: (value: T, index: number, array: ArrayLike<T>) => unknown): ArrayLike<T>;
+/**
+ * Iterates over each element of the object invoking the provided callback function for each property.
+ *
+ * @template T - The type of object.
+ * @param {T} object - The object to iterate over
+ * @param {(value: T[keyof T], key: keyof T, object: T) => unknown} [callback] - The function invoked for each property.
+ * The callback function receives three arguments:
+ *  - 'value': The current property being processed in the object.
+ *  - 'key': The key of the current property being processed in the object.
+ *  - 'object': The object 'forEach' was called upon.
+ * @returns {T} Returns the original object.
+ *
+ * @example
+ * forEach({'a': 1, 'b': 2 }, (value, key, object) => console.log(value, key));
+ * // Output:
+ * // 1 'a'
+ * // 2 'b'
+ */
+declare function forEach<T extends object | null | undefined>(object: T, callback?: (value: T[keyof T], key: keyof T, object: T) => unknown): T;
+
+export { forEach };

package/dist/compat/array/forEach.d.ts

@@ -0,0 +1,106 @@
+/**
+ * Iterates over each element of the array invoking the provided callback function for each element.
+ *
+ * @template K - The type of elements in the array.
+ * @template T - The type of the array.
+ * @param {T | null | undefined} array - The array to iterate over.
+ * @param {(value: K, index: number, array: T) => unknown} [callback] - The function invoked for each element.
+ * The callback function receives three arguments:
+ *  - 'value': The current element being processed in the array.
+ *  - 'index': The index of the current element being processed in the array.
+ *  - 'array': The array 'forEach' was called upon.
+ * @returns {T} Returns the original array.
+ *
+ * @example
+ * forEach([1, 2, 3], (value, index, array) => console.log(value, index));
+ * // Output:
+ * // 1 0
+ * // 2 1
+ * // 3 2
+ *
+ */
+declare function forEach<T>(array: T[], callback?: (value: T, index: number, array: T[]) => unknown): T[];
+/**
+ * Iterates over each element of the array invoking the provided callback function for each element.
+ *
+ * @template K - The type of elements in the array.
+ * @template T - The type of the array.
+ * @param {T | null | undefined} array - The array to iterate over.
+ * @param {(value: K, index: number, array: T) => unknown} [callback] - The function invoked for each element.
+ * The callback function receives three arguments:
+ *  - 'value': The current element being processed in the array.
+ *  - 'index': The index of the current element being processed in the array.
+ *  - 'array': The array 'forEach' was called upon.
+ * @returns {T} Returns the original array.
+ *
+ * @example
+ * forEach([1, 2, 3], (value, index, array) => console.log(value, index));
+ * // Output:
+ * // 1 0
+ * // 2 1
+ * // 3 2
+ *
+ */
+declare function forEach<T>(array: readonly T[], callback?: (value: T, index: number, array: T[]) => unknown): readonly T[];
+/**
+ * Iterates over each element of the array invoking the provided callback function for each element.
+ *
+ * @template T - The type of string.
+ * @param {T | null | undefined} string - The string to iterate over
+ * @param {(value: T, index: number, string: T) => unknown} [callback] - The function invoked for each char.
+ * The callback function receives three arguments:
+ *  - 'char': The current char being processed in the string.
+ *  - 'index': The index of the current char being processed in the string.
+ *  - 'string': The string 'forEach' was called upon.
+ * @returns {T} Returns the original string.
+ *
+ * @example
+ * forEach('abc', (char, index, string) => console.log(char, index));
+ * // Output:
+ * // 'a' 0
+ * // 'b' 1
+ * // 'c' 2
+ */
+declare function forEach<T extends string | null | undefined>(string: T, callback?: (char: string, index: number, string: string) => unknown): T;
+/**
+ * Iterates over each element of the array invoking the provided callback function for each element.
+ *
+ * @template T - The type of elements in the array.
+ * @param { ArrayLike<T> } array - The array to iterate over.
+ * @param {(value: T, index: number, array: ArrayLike<T>) => unknown} [callback] - The function invoked for each element.
+ * The callback function receives three arguments:
+ *  - 'value': The current element being processed in the array.
+ *  - 'index': The index of the current element being processed in the array.
+ *  - 'array': The array 'forEach' was called upon.
+ * @returns {T} Returns the original array.
+ *
+ * @example
+ * forEach([1, 2, 3], (value, index, array) => console.log(value, index));
+ * // Output:
+ * // 1 0
+ * // 2 1
+ * // 3 2
+ *
+ */
+declare function forEach<T>(array: ArrayLike<T>, callback?: (value: T, index: number, array: ArrayLike<T>) => unknown): ArrayLike<T>;
+/**
+ * Iterates over each element of the object invoking the provided callback function for each property.
+ *
+ * @template T - The type of object.
+ * @param {T} object - The object to iterate over
+ * @param {(value: T[keyof T], key: keyof T, object: T) => unknown} [callback] - The function invoked for each property.
+ * The callback function receives three arguments:
+ *  - 'value': The current property being processed in the object.
+ *  - 'key': The key of the current property being processed in the object.
+ *  - 'object': The object 'forEach' was called upon.
+ * @returns {T} Returns the original object.
+ *
+ * @example
+ * forEach({'a': 1, 'b': 2 }, (value, key, object) => console.log(value, key));
+ * // Output:
+ * // 1 'a'
+ * // 2 'b'
+ */
+declare function forEach<T extends object | null | undefined>(object: T, callback?: (value: T[keyof T], key: keyof T, object: T) => unknown): T;
+
+export { forEach };

package/dist/compat/array/forEach.mjs

@@ -0,0 +1,21 @@
+import { identity } from '../../function/identity.mjs';
+import { range } from '../../math/range.mjs';
+import { isArrayLike } from '../predicate/isArrayLike.mjs';
+
+function forEach(collection, callback = identity) {
+    if (!collection) {
+        return collection;
+    }
+    const keys = isArrayLike(collection) || Array.isArray(collection) ? range(0, collection.length) : Object.keys(collection);
+    for (let i = 0; i < keys.length; i++) {
+        const key = keys[i];
+        const value = collection[key];
+        const result = callback(value, key, collection);
+        if (result === false) {
+            break;
+        }
+    }
+    return collection;
+}
+
+export { forEach };

package/dist/compat/index.d.mts

@@ -96,6 +96,7 @@ export { findLastIndex } from './array/findLastIndex.mjs';
 export { flatten } from './array/flatten.mjs';
 export { flattenDeep } from './array/flattenDeep.mjs';
 export { flattenDepth } from './array/flattenDepth.mjs';
+export { forEach as each, forEach } from './array/forEach.mjs';
 export { head as first, head } from './array/head.mjs';
 export { includes } from './array/includes.mjs';
 export { indexOf } from './array/indexOf.mjs';

package/dist/compat/index.d.ts

@@ -96,6 +96,7 @@ export { findLastIndex } from './array/findLastIndex.js';
 export { flatten } from './array/flatten.js';
 export { flattenDeep } from './array/flattenDeep.js';
 export { flattenDepth } from './array/flattenDepth.js';
+export { forEach as each, forEach } from './array/forEach.js';
 export { head as first, head } from './array/head.js';
 export { includes } from './array/includes.js';
 export { indexOf } from './array/indexOf.js';

package/dist/compat/index.js

@@ -785,6 +785,22 @@ function flattenDepth(value, depth = 1) {
     return flatten(value, depth);
 }
 
+function forEach(collection, callback = unary.identity) {
+    if (!collection) {
+        return collection;
+    }
+    const keys = isArrayLike(collection) || Array.isArray(collection) ? rangeRight.range(0, collection.length) : Object.keys(collection);
+    for (let i = 0; i < keys.length; i++) {
+        const key = keys[i];
+        const value = collection[key];
+        const result = callback(value, key, collection);
+        if (result === false) {
+            break;
+        }
+    }
+    return collection;
+}
+
 function head(arr) {
     if (!isArrayLike(arr)) {
         return undefined;
@@ -2585,6 +2601,7 @@ exports.drop = drop;
 exports.dropRight = dropRight;
 exports.dropRightWhile = dropRightWhile;
 exports.dropWhile = dropWhile;
+exports.each = forEach;
 exports.endsWith = endsWith;
 exports.escape = escape;
 exports.every = every;
@@ -2601,6 +2618,7 @@ exports.flip = flip;
 exports.floor = floor;
 exports.flow = flow;
 exports.flowRight = flowRight;
+exports.forEach = forEach;
 exports.fromPairs = fromPairs;
 exports.get = get;
 exports.has = has;

package/dist/compat/index.mjs

@@ -98,6 +98,7 @@ export { findLastIndex } from './array/findLastIndex.mjs';
 export { flatten } from './array/flatten.mjs';
 export { flattenDeep } from './array/flattenDeep.mjs';
 export { flattenDepth } from './array/flattenDepth.mjs';
+export { forEach as each, forEach } from './array/forEach.mjs';
 export { head as first, head } from './array/head.mjs';
 export { includes } from './array/includes.mjs';
 export { indexOf } from './array/indexOf.mjs';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "es-toolkit",
   "description": "A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.",
-  "version": "1.26.1-dev.858+cbecb215",
+  "version": "1.26.1-dev.860+67ea6bfe",
   "homepage": "https://es-toolkit.slash.page",
   "bugs": "https://github.com/toss/es-toolkit/issues",
   "repository": {