es-toolkit 1.26.1-dev.834 → 1.26.1-dev.835

package/dist/compat/index.d.mts

@@ -210,6 +210,7 @@ export { upperCase } from './string/upperCase.mjs';
 export { constant } from './util/constant.mjs';
 export { defaultTo } from './util/defaultTo.mjs';
 export { eq } from './util/eq.mjs';
+export { iteratee } from './util/iteratee.mjs';
 export { times } from './util/times.mjs';
 export { toFinite } from './util/toFinite.mjs';
 export { toInteger } from './util/toInteger.mjs';

package/dist/compat/index.d.ts

@@ -210,6 +210,7 @@ export { upperCase } from './string/upperCase.js';
 export { constant } from './util/constant.js';
 export { defaultTo } from './util/defaultTo.js';
 export { eq } from './util/eq.js';
+export { iteratee } from './util/iteratee.js';
 export { times } from './util/times.js';
 export { toFinite } from './util/toFinite.js';
 export { toInteger } from './util/toInteger.js';

package/dist/compat/index.js

@@ -2329,6 +2329,21 @@ function defaultTo(value, defaultValue) {
     return value;
 }
 
+function iteratee(value) {
+    if (value == null) {
+        return (value) => value;
+    }
+    switch (typeof value) {
+        case 'function': {
+            return value;
+        }
+        case 'object': {
+            return Array.isArray(value) ? matchesProperty(value[0], value[1]) : matches(value);
+        }
+    }
+    return property(value);
+}
+
 function times(n, getValue) {
     n = toInteger(n);
     if (n < 1 || !Number.isSafeInteger(n)) {
@@ -2531,6 +2546,7 @@ exports.isSymbol = isSymbol;
 exports.isTypedArray = isTypedArray;
 exports.isWeakMap = isWeakMap;
 exports.isWeakSet = isWeakSet;
+exports.iteratee = iteratee;
 exports.join = join;
 exports.kebabCase = kebabCase;
 exports.last = last;

package/dist/compat/index.mjs

@@ -210,6 +210,7 @@ export { trimStart } from './string/trimStart.mjs';
 export { upperCase } from './string/upperCase.mjs';
 export { constant } from './util/constant.mjs';
 export { defaultTo } from './util/defaultTo.mjs';
+export { iteratee } from './util/iteratee.mjs';
 export { times } from './util/times.mjs';
 export { toFinite } from './util/toFinite.mjs';
 export { toInteger } from './util/toInteger.mjs';

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

@@ -0,0 +1,41 @@
+/**
+ * Returns a `identity` function when `value` is `null` or `undefined`.
+ *
+ * @param {null} [value] - The value to convert to an iteratee.
+ * @returns {(value: unknown) => unknown} - Returns a `identity` function.
+ *
+ * @example
+ * const func = iteratee();
+ *
+ * [{ a: 1 }, { a: 2 }, { a: 3 }].map(func) // => [{ a: 1 }, { a: 2 }, { a: 3 }]
+ */
+declare function iteratee(value?: null): (value: unknown) => unknown;
+/**
+ * Returns a given `func` function when `value` is a `function`.
+ *
+ * @template {(...args: any[]) => unknown} F - The function type.
+ * @param {F} func - The function to return.
+ * @returns {F} - Returns the given function.
+ *
+ * @example
+ * const func = iteratee((object) => object.a);
+ *
+ * [{ a: 1 }, { a: 2 }, { a: 3 }].map(func) // => [1, 2, 3]
+ */
+declare function iteratee<F extends (...args: any[]) => unknown>(func: F): F;
+/**
+ * Creates a function that invokes `value` with the arguments of the created function.
+ *
+ * The created function returns the property value for a given element.
+ *
+ * @param {symbol | number | string | object} value - The value to convert to an iteratee.
+ * @returns {(...args: any[]) => unknown} - Returns the new iteratee function.
+ *
+ * @example
+ * const func = iteratee('a');
+ *
+ * [{ a: 1 }, { a: 2 }, { a: 3 }].map(func) // => [1, 2, 3]
+ */
+declare function iteratee(value: symbol | number | string | object): (...args: any[]) => unknown;
+
+export { iteratee };

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

@@ -0,0 +1,41 @@
+/**
+ * Returns a `identity` function when `value` is `null` or `undefined`.
+ *
+ * @param {null} [value] - The value to convert to an iteratee.
+ * @returns {(value: unknown) => unknown} - Returns a `identity` function.
+ *
+ * @example
+ * const func = iteratee();
+ *
+ * [{ a: 1 }, { a: 2 }, { a: 3 }].map(func) // => [{ a: 1 }, { a: 2 }, { a: 3 }]
+ */
+declare function iteratee(value?: null): (value: unknown) => unknown;
+/**
+ * Returns a given `func` function when `value` is a `function`.
+ *
+ * @template {(...args: any[]) => unknown} F - The function type.
+ * @param {F} func - The function to return.
+ * @returns {F} - Returns the given function.
+ *
+ * @example
+ * const func = iteratee((object) => object.a);
+ *
+ * [{ a: 1 }, { a: 2 }, { a: 3 }].map(func) // => [1, 2, 3]
+ */
+declare function iteratee<F extends (...args: any[]) => unknown>(func: F): F;
+/**
+ * Creates a function that invokes `value` with the arguments of the created function.
+ *
+ * The created function returns the property value for a given element.
+ *
+ * @param {symbol | number | string | object} value - The value to convert to an iteratee.
+ * @returns {(...args: any[]) => unknown} - Returns the new iteratee function.
+ *
+ * @example
+ * const func = iteratee('a');
+ *
+ * [{ a: 1 }, { a: 2 }, { a: 3 }].map(func) // => [1, 2, 3]
+ */
+declare function iteratee(value: symbol | number | string | object): (...args: any[]) => unknown;
+
+export { iteratee };

package/dist/compat/util/iteratee.mjs

@@ -0,0 +1,20 @@
+import { property } from '../object/property.mjs';
+import { matches } from '../predicate/matches.mjs';
+import { matchesProperty } from '../predicate/matchesProperty.mjs';
+
+function iteratee(value) {
+    if (value == null) {
+        return (value) => value;
+    }
+    switch (typeof value) {
+        case 'function': {
+            return value;
+        }
+        case 'object': {
+            return Array.isArray(value) ? matchesProperty(value[0], value[1]) : matches(value);
+        }
+    }
+    return property(value);
+}
+
+export { iteratee };

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.834+10205c01",
+  "version": "1.26.1-dev.835+62fe7e03",
   "homepage": "https://es-toolkit.slash.page",
   "bugs": "https://github.com/toss/es-toolkit/issues",
   "repository": {