docs(iteratee): Update docs (#792)

* docs(iteratee): Add `identity` function link

* docs(iteratee): Add examples for property-value pairs and partial objects

* iteratee

---------

Co-authored-by: raon0211 <raon0211@toss.im>

docs/ja/reference/compat/util/iteratee.md

@@ -36,14 +36,17 @@ function iteratee(value: symbol | number | string | object): (...args: any[]) =>
 
 ```typescript
 const func = iteratee();
-
 [{ a: 1 }, { a: 2 }, { a: 3 }].map(func) // => [{ a: 1 }, { a: 2 }, { a: 3 }]
 
 const func = iteratee((object) => object.a);
-
 [{ a: 1 }, { a: 2 }, { a: 3 }].map(func) // => [1, 2, 3]
 
 const func = iteratee('a');
-
 [{ a: 1 }, { a: 2 }, { a: 3 }].map(func) // => [1, 2, 3]
+
+const func = iteratee({ a: 1 });
+[{ a: 1 }, { a: 2 }, { a: 3 }].find(func) // => { a: 1 }
+
+const func = iteratee(['a', 1]);
+[{ a: 1 }, { a: 2 }, { a: 3 }].find(func) // => { a: 1 }
 ```

docs/ko/reference/compat/util/iteratee.md

@@ -40,14 +40,17 @@ function iteratee(
 
 ```typescript
 const func = iteratee();
-
 [{ a: 1 }, { a: 2 }, { a: 3 }].map(func) // => [{ a: 1 }, { a: 2 }, { a: 3 }]
 
 const func = iteratee((object) => object.a);
-
 [{ a: 1 }, { a: 2 }, { a: 3 }].map(func) // => [1, 2, 3]
 
 const func = iteratee('a');
-
 [{ a: 1 }, { a: 2 }, { a: 3 }].map(func) // => [1, 2, 3]
+
+const func = iteratee({ a: 1 });
+[{ a: 1 }, { a: 2 }, { a: 3 }].find(func) // => { a: 1 }
+
+const func = iteratee(['a', 1]);
+[{ a: 1 }, { a: 2 }, { a: 3 }].find(func) // => { a: 1 }
 ```

docs/reference/compat/util/iteratee.md

@@ -15,7 +15,7 @@ You can call `iteratee` with the following types of arguments:
 - **Property-value pair**: Returns a boolean indicating whether the element's property matches the given value.
 - **Partial object**: Returns a boolean indicating whether the element matches the properties of the partial object.
 
-If you don't provide any arguments or pass `null`, this function will return a function that simply returns its input unchanged.
+If you don't provide any arguments or pass `null`, this function will return a [function that simply returns its input unchanged](../../function/identity.md).
 
 ## Signature
 
@@ -40,14 +40,17 @@ function iteratee(
 
 ```typescript
 const func = iteratee();
-
 [{ a: 1 }, { a: 2 }, { a: 3 }].map(func) // => [{ a: 1 }, { a: 2 }, { a: 3 }]
 
 const func = iteratee((object) => object.a);
-
 [{ a: 1 }, { a: 2 }, { a: 3 }].map(func) // => [1, 2, 3]
 
 const func = iteratee('a');
-
 [{ a: 1 }, { a: 2 }, { a: 3 }].map(func) // => [1, 2, 3]
+
+const func = iteratee({ a: 1 });
+[{ a: 1 }, { a: 2 }, { a: 3 }].find(func) // => { a: 1 }
+
+const func = iteratee(['a', 1]);
+[{ a: 1 }, { a: 2 }, { a: 3 }].find(func) // => { a: 1 }
 ```

docs/zh_hans/reference/compat/util/iteratee.md

@@ -14,7 +14,7 @@
 - **属性-值对**: 返回一个布尔值，指示元素的属性是否与给定值匹配。
 - **部分对象**: 返回一个布尔值，指示元素是否与部分对象的属性匹配。
 
-如果你不提供任何参数或传递 `null`，此函数将返回一个简单返回其输入的函数。
+如果你不提供任何参数或传递 `null`，此函数将返回一个[简单返回其输入的函数](../../function/identity.md)。
 
 ## 签名
 
@@ -39,14 +39,17 @@ function iteratee(
 
 ```typescript
 const func = iteratee();
-
 [{ a: 1 }, { a: 2 }, { a: 3 }].map(func) // => [{ a: 1 }, { a: 2 }, { a: 3 }]
 
 const func = iteratee((object) => object.a);
-
 [{ a: 1 }, { a: 2 }, { a: 3 }].map(func) // => [1, 2, 3]
 
 const func = iteratee('a');
-
 [{ a: 1 }, { a: 2 }, { a: 3 }].map(func) // => [1, 2, 3]
+
+const func = iteratee({ a: 1 });
+[{ a: 1 }, { a: 2 }, { a: 3 }].find(func) // => { a: 1 }
+
+const func = iteratee(['a', 1]);
+[{ a: 1 }, { a: 2 }, { a: 3 }].find(func) // => { a: 1 }
 ```

src/compat/util/iteratee.ts

@@ -11,7 +11,6 @@ import { matchesProperty } from '../predicate/matchesProperty.ts';
  *
  * @example
  * const func = iteratee();
- *
  * [{ a: 1 }, { a: 2 }, { a: 3 }].map(func) // => [{ a: 1 }, { a: 2 }, { a: 3 }]
  */
 export function iteratee(value?: null): <T>(value: T) => T;
@@ -25,7 +24,6 @@ export function iteratee(value?: null): <T>(value: T) => T;
  *
  * @example
  * const func = iteratee((object) => object.a);
- *
  * [{ a: 1 }, { a: 2 }, { a: 3 }].map(func) // => [1, 2, 3]
  */
 export function iteratee<F extends (...args: any[]) => unknown>(func: F): F;
@@ -40,8 +38,13 @@ export function iteratee<F extends (...args: any[]) => unknown>(func: F): F;
  *
  * @example
  * const func = iteratee('a');
- *
  * [{ a: 1 }, { a: 2 }, { a: 3 }].map(func) // => [1, 2, 3]
+ *
+ * const func = iteratee({ a: 1 });
+ * [{ a: 1 }, { a: 2 }, { a: 3 }].find(func) // => { a: 1 }
+ *
+ * const func = iteratee(['a', 1]);
+ * [{ a: 1 }, { a: 2 }, { a: 3 }].find(func) // => { a: 1 }
  */
 export function iteratee(value: symbol | number | string | object): (...args: any[]) => any;
 
@@ -61,16 +64,19 @@ export function iteratee(value: symbol | number | string | object): (...args: an
  * @returns {(...args: any[]) => unknown} - Returns the new iteratee function.
  * @example
  * const func = iteratee();
- *
  * [{ a: 1 }, { a: 2 }, { a: 3 }].map(func) // => [{ a: 1 }, { a: 2 }, { a: 3 }]
- * @example
+ *
  * const func = iteratee((object) => object.a);
- *
  * [{ a: 1 }, { a: 2 }, { a: 3 }].map(func) // => [1, 2, 3]
- * @example
+ *
  * const func = iteratee('a');
- *
  * [{ a: 1 }, { a: 2 }, { a: 3 }].map(func) // => [1, 2, 3]
+ *
+ * const func = iteratee({ a: 1 });
+ * [{ a: 1 }, { a: 2 }, { a: 3 }].find(func) // => { a: 1 }
+ *
+ * const func = iteratee(['a', 1]);
+ * [{ a: 1 }, { a: 2 }, { a: 3 }].find(func) // => { a: 1 }
  */
 export function iteratee(
   value?: symbol | number | string | object | null | ((...args: any[]) => unknown)