✨ Add identity function

docs/api/identity/index.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+
+
+## identity variable
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Return the parameter supplied to it.
+
+<b>Signature:</b>
+
+```typescript
+identity: <T>(val: T) => T
+```
+
+## Example
+
+
+```ts
+identity(1) // 1
+identity({}) // {}
+
+```
+

docs/api/index.md

@@ -20,6 +20,7 @@
 |  [gte](./gte/) | Returns <code>true</code> if the first argument is greater than or equal to the second; otherwise <code>false</code> |
 |  [has](./has/) | <b><i>(BETA)</i></b> Returns whether or not an object has an own property with the specified name. |
 |  [hasPath](./haspath/) | <b><i>(BETA)</i></b> Returns whether or not a path exists in an object. Only the object's own properties are checked. |
+|  [identity](./identity/) | <b><i>(BETA)</i></b> Return the parameter supplied to it. |
 |  [inc](./inc/) | Increments its argument. |
 |  [isBigint](./isbigint/) | Whatever argument is type of <code>bigint</code> or not. |
 |  [isBoolean](./isboolean/) | Whatever argument is type of <code>boolean</code> or not. |

src/identity.ts

@@ -0,0 +1,17 @@
+/**
+ * Return the parameter supplied to it.
+ *
+ * @param val - The value to return
+ * @returns The result of `val`
+ *
+ * @example
+ * ```ts
+ * identity(1) // 1
+ * identity({}) // {}
+ * ```
+ *
+ * @beta
+ */
+const identity = <T>(val: T): T => val
+
+export { identity }

src/index.ts

@@ -11,6 +11,7 @@ export { gt } from '@/gt'
 export { gte } from '@/gte'
 export { has } from '@/has'
 export { hasPath } from '@/hasPath'
+export { identity } from '@/identity'
 export { inc } from '@/inc'
 export { isBigint } from '@/isBigint'
 export { isBoolean } from '@/isBoolean'

test/identity.spec.ts

@@ -0,0 +1,16 @@
+import { identity } from '@/identity'
+
+describe('identity', () => {
+  const table: [unknown, unknown][] = [
+    ['', ''],
+    [0, 0],
+    [1n, 1n],
+    [() => 1, () => 1],
+    [{}, {}],
+    [[], []]
+  ]
+
+  it.each(table)('identity(%s) -> %s', (val) => {
+    expect(identity(val)).toEqual(val)
+  })
+})