refactor: cleanup pick pickBy omit omitBy and update docs

docs/.vitepress/config.ts

@@ -4,6 +4,7 @@ import {
   numberItems,
   stringItems,
   arrayItems,
+  objectItems,
   functionItems,
   collectionItems,
   mathItems,
@@ -57,6 +58,10 @@ export default defineConfig({
             text: '数学',
             items: withI18n(mathItems, 'zh'),
           },
+          {
+            text: '对象',
+            items: withI18n(objectItems, 'zh'),
+          },
           {
             text: '数组',
             items: withI18n(arrayItems, 'zh'),
@@ -119,6 +124,10 @@ export default defineConfig({
         text: 'Math',
         items: mathItems,
       },
+      {
+        text: 'Object',
+        items: objectItems,
+      },
       {
         text: 'Array',
         items: arrayItems,

docs/.vitepress/items/index.ts

@@ -1,6 +1,7 @@
 export * from './general'
 export * from './string'
 export * from './number'
+export * from './object'
 export * from './array'
 export * from './collection'
 export * from './function'

docs/.vitepress/items/object.ts

@@ -0,0 +1,6 @@
+export const objectItems = [
+  { text: 'pick', link: '/object/pick' },
+  { text: 'pickBy', link: '/object/pick-by' },
+  { text: 'omit', link: '/object/omit' },
+  { text: 'omitBy', link: '/object/omit-by' },
+]

docs/array/uniq-by.md

@@ -13,10 +13,10 @@ uniqBy([{ id: 1 }, { id: 2 }, { id: 1 }], (a, b) => a.id === b.id)
 
 ### Arguments
 
-| Arg   | Type                          | Defaults |
-| ----- | ----------------------------- | -------- |
-| `arr` | `Array`                       |          |
-| `fn`  | `(a: any, b: any) => boolean` |          |
+| Arg   | Type                      | Defaults |
+| ----- | ------------------------- | -------- |
+| `arr` | `Array`                   |          |
+| `fn`  | `(a: any, b: any) => any` |          |
 
 ### Return
 

docs/object/omit-by.md

@@ -0,0 +1,27 @@
+# omitBy
+
+Excludes an object property by providing a function that constructs a new object. Returns a `truthy` value to indicate that the property should be excluded.
+
+### Usage
+
+```ts
+import { omitBy } from 'rattail'
+
+omitBy({ a: 1, b: 2, c: 3 }, (value) => value > 1)
+// return { a: 1 }
+omitBy({ a: 1, b: 2, c: 3 }, (value, key) => key !== 'a')
+// return { a: 1 }
+```
+
+### Arguments
+
+| Arg      | Type                               | Defaults |
+| -------- | ---------------------------------- | -------- |
+| `object` | `object`                           |          |
+| `fn`     | `(value: any, key: string) => any` |          |
+
+### Return
+
+| Type     |
+| -------- |
+| `object` |

docs/collection/omit.md → docs/object/omit.md

@@ -1,6 +1,6 @@
 # omit
 
-Creates a new object by omitting specified keys from an existing object.
+Excludes object properties and constructs a new object.
 
 ### Usage
 

docs/object/pick-by.md

@@ -0,0 +1,27 @@
+# pickBy
+
+By providing a function to extract object properties and construct a new object, returning a `truthy` value indicates that the property needs to be extracted.
+
+### Usage
+
+```ts
+import { pickBy } from 'rattail'
+
+pickBy({ a: 1, b: 2, c: 3 }, (value) => value > 1)
+// return { b: 2, c: 3 }
+pickBy({ a: 1, b: 2, c: 3 }, (value, key) => key !== 'a')
+// return { b: 2, c: 3 }
+```
+
+### Arguments
+
+| Arg      | Type                               | Defaults |
+| -------- | ---------------------------------- | -------- |
+| `object` | `object`                           |          |
+| `fn`     | `(value: any, key: string) => any` |          |
+
+### Return
+
+| Type     |
+| -------- |
+| `object` |

docs/collection/pick.md → docs/object/pick.md

@@ -1,6 +1,6 @@
 # pick
 
-Creates a new object by selecting specified keys from an existing object.
+Pick object properties and construct a new object.
 
 ### Usage
 

docs/zh/array/uniq-by.md

@@ -13,10 +13,10 @@ uniqBy([{ id: 1 }, { id: 2 }, { id: 1 }], (a, b) => a.id === b.id)
 
 ### 参数
 
-| 参数  | 类型                          | 默认值 |
-| ----- | ----------------------------- | ------ |
-| `arr` | `Array`                       |        |
-| `fn`  | `(a: any, b: any) => boolean` |        |
+| 参数  | 类型                      | 默认值 |
+| ----- | ------------------------- | ------ |
+| `arr` | `Array`                   |        |
+| `fn`  | `(a: any, b: any) => any` |        |
 
 ### 返回值
 

docs/zh/math/max-by.md

@@ -20,6 +20,6 @@ maxBy([{ n: 5 }, { n: 10 }, { n: 8 }], ({ n }) => n)
 
 ### 返回值
 
-| 类型 |
-| :--: | ---------- |
-|  `T  | undefined` |
+|       类型        |
+| :---------------: |
+| `T  \| undefined` |

docs/zh/object/omit-by.md

@@ -0,0 +1,27 @@
+# omitBy
+
+通过提供一个函数来排除对象属性并构造成一个新的对象， 返回 `真值` 表示需要排除该属性。
+
+### 使用
+
+```ts
+import { omitBy } from 'rattail'
+
+omitBy({ a: 1, b: 2, c: 3 }, (value) => value > 1)
+// return { a: 1 }
+omitBy({ a: 1, b: 2, c: 3 }, (value, key) => key !== 'a')
+// return { a: 1 }
+```
+
+### 参数
+
+| 参数     | 类型                               | 默认值 |
+| -------- | ---------------------------------- | ------ |
+| `object` | `object`                           |        |
+| `fn`     | `(value: any, key: string) => any` |        |
+
+### 返回值
+
+| 类型     |
+| -------- |
+| `object` |

docs/zh/collection/omit.md → docs/zh/object/omit.md

@@ -1,6 +1,6 @@
 # omit
 
-通过从现有对象中排除指定键来创建新对象。
+排除对象属性并构造成一个新的对象。
 
 ### 使用
 

docs/zh/object/pick-by.md

@@ -0,0 +1,27 @@
+# pickBy
+
+通过提供一个函数来提取对象属性并构造成一个新的对象, 返回 `真值` 表示需要提取该属性。
+
+### 使用
+
+```ts
+import { pickBy } from 'rattail'
+
+pickBy({ a: 1, b: 2, c: 3 }, (value) => value > 1)
+// return { b: 2, c: 3 }
+pickBy({ a: 1, b: 2, c: 3 }, (value, key) => key !== 'a')
+// return { b: 2, c: 3 }
+```
+
+### 参数
+
+| 参数     | 类型                               | 默认值 |
+| -------- | ---------------------------------- | ------ |
+| `object` | `object`                           |        |
+| `fn`     | `(value: any, key: string) => any` |        |
+
+### 返回值
+
+| 类型     |
+| -------- |
+| `object` |

docs/zh/collection/pick.md → docs/zh/object/pick.md

@@ -1,6 +1,6 @@
 # pick
 
-通过从现有对象中选择指定键来创建新对象。
+提取对象属性并构造成一个新的对象。
 
 ### 使用
 

src/array/uniqBy.ts

@@ -1,4 +1,4 @@
-export function uniqBy<T>(arr: T[], fn: (a: T, b: T) => boolean): T[] {
+export function uniqBy<T>(arr: T[], fn: (a: T, b: T) => any): T[] {
   return arr.reduce((ret: T[], i: T) => {
     const index = ret.findIndex((j: T) => fn(i, j))
 

src/index.ts

@@ -1,4 +1,5 @@
 export * from './array'
+export * from './object'
 export * from './util'
 export * from './function'
 export * from './general'

src/object/index.ts

@@ -0,0 +1,4 @@
+export * from './pick'
+export * from './pickBy'
+export * from './omit'
+export * from './omitBy'