docs(array(xor)): 调整xor文档

renzp94 · Jun 18, 2024 · 1e4029c · 1e4029c
1 parent 56e904d
commit 1e4029c
Showing 1 changed file with 11 additions and 15 deletions.
diff --git a/docs/pages/array/xor.md b/docs/pages/array/xor.md
@@ -4,7 +4,7 @@
 
 ## 基本用法
 
-传入多个数组，返回含有补集数据的数组。
+传入多个数组，使用[SameValueZero](https://262.ecma-international.org/6.0/#sec-samevaluezero)进行比较，返回含有补集数据的数组。
 
 ```ts
 import { xor } from '@renzp/utils';
@@ -71,28 +71,24 @@ xor(
 
 ## 参数
 
-| 参数    | 说明     | 类型            | 默认值 | 是否必填 |
-| ------- | -------- | --------------- | ------ | -------- |
-| ...args | 目标数组 | `[...Array<T>]` | -      | 否       |
-| options | 配置     | `XorOptions<T>` | -      | 否       |
+| 参数    | 说明     | 类型               | 默认值 | 是否必填 |
+| ------- | -------- | ------------------ | ------ | -------- |
+| ...args | 目标数组 | `[...Array<T>]`    | -      | 否       |
+| options | 配置     | `FilterOptions<T>` | -      | 否       |
 
-```ts
-export type XorOptions<T> = {
-  filter?: Filter<T>
-}
+### options
 
+| 参数   | 说明          | 类型        | 默认值 | 是否必填 |
+| ------ | ------------- | ----------- | ------ | -------- |
+| filter | 过滤key或函数 | `Filter<T>` | -      | 否       |
+
+```ts
 export type Filter<T> =
   | keyof T
   | Array<keyof T>
   | ((target: T, v: T) => boolean)
 ```
 
-### options
-
-| 参数   | 说明   | 类型        | 默认值 | 是否必填 |
-| ------ | ------ | ----------- | ------ | -------- |
-| filter | 过滤器 | `Filter<T>` | -      | 否       |
-
 ## 返回
 
 | 参数 | 说明               | 类型       |