From 1e4029c008fe9ff73dfb479be92c196ef13f995a Mon Sep 17 00:00:00 2001 From: renzp94 <1074720760@qq.com> Date: Tue, 18 Jun 2024 09:30:19 +0800 Subject: [PATCH] =?UTF-8?q?docs(array(xor)):=20=E8=B0=83=E6=95=B4xor?= =?UTF-8?q?=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/pages/array/xor.md | 26 +++++++++++--------------- 1 file changed, 11 insertions(+), 15 deletions(-) diff --git a/docs/pages/array/xor.md b/docs/pages/array/xor.md index f6d8ce7..782a51a 100644 --- 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]` | - | 否 | -| options | 配置 | `XorOptions` | - | 否 | +| 参数 | 说明 | 类型 | 默认值 | 是否必填 | +| ------- | -------- | ------------------ | ------ | -------- | +| ...args | 目标数组 | `[...Array]` | - | 否 | +| options | 配置 | `FilterOptions` | - | 否 | -```ts -export type XorOptions = { - filter?: Filter -} +### options +| 参数 | 说明 | 类型 | 默认值 | 是否必填 | +| ------ | ------------- | ----------- | ------ | -------- | +| filter | 过滤key或函数 | `Filter` | - | 否 | + +```ts export type Filter = | keyof T | Array | ((target: T, v: T) => boolean) ``` -### options - -| 参数 | 说明 | 类型 | 默认值 | 是否必填 | -| ------ | ------ | ----------- | ------ | -------- | -| filter | 过滤器 | `Filter` | - | 否 | - ## 返回 | 参数 | 说明 | 类型 |