feat: xor, xorWith

docs/.vitepress/items/array.ts

@@ -7,6 +7,8 @@ export const arrayItems = [
   { text: 'differenceWith', link: '/array/difference-with' },
   { text: 'intersection', link: '/array/intersection' },
   { text: 'intersectionWith', link: '/array/intersection-with' },
+  { text: 'xor', link: '/array/xor' },
+  { text: 'xorWith', link: '/array/xor-with' },
   { text: 'groupBy', link: '/array/group-by' },
   { text: 'find', link: '/array/find' },
   { text: 'shuffle', link: '/array/shuffle' },

docs/array/difference-with.md

@@ -5,7 +5,7 @@ Creates an `array` of array values ​​that are not contained in other given a
 ### Usage
 
 ```ts
-import { difference } from 'rattail'
+import { differenceWith } from 'rattail'
 
 differenceWith([{ num: 1 }, { num: 2 }, { num: 3 }], [{ num: 2 }], (a, b) => a.num === b.num)
 // return [{ num: 1 }, { num: 3 }]

docs/array/xor-with.md

@@ -0,0 +1,27 @@
+# xorWith
+
+XOR(Exclusive OR) the passed array and return a new `array`, and supports custom comparison functions.
+
+### Usage
+
+```ts
+import { xorWith } from 'rattail'
+
+xorWith([{ num: 1 }, { num: 2 }, { num: 2 }], [{ num: 1 }, { num: 3 }], (a, b) => a.num === b.num)
+// return [{ num: 2 }, { num: 3 }]
+xorWith([{ num: 1 }, { num: 2 }], [{ num: 1 }, { num: 2 }], [{ num: 3 }], (a, b) => a.num === b.num)
+// return [{ num: 3 }]
+```
+
+### Arguments
+
+| Arg         | Type                      | Defaults |
+| ----------- | ------------------------- | -------- |
+| `...values` | `Array<Array>`            |          |
+| `fn`        | `(a: any, b: any) => any` |          |
+
+### Return
+
+| Type    |
+| ------- |
+| `Array` |

docs/array/xor.md

@@ -0,0 +1,26 @@
+# xor
+
+XOR(Exclusive OR) the passed array and return a new `array`.
+
+### Usage
+
+```ts
+import { xor } from 'rattail'
+
+xor([1, 2, 2], [1, 3])
+// return [2, 3]
+xor([1, 2], [1, 2], [3])
+// return [3]
+```
+
+### Arguments
+
+| Arg         | Type           | Defaults |
+| ----------- | -------------- | -------- |
+| `...values` | `Array<Array>` |          |
+
+### Return
+
+| Type    |
+| ------- |
+| `Array` |

docs/zh/array/difference-with.md

@@ -5,7 +5,7 @@
 ### 使用
 
 ```ts
-import { difference } from 'rattail'
+import { differenceWith } from 'rattail'
 
 differenceWith([{ num: 1 }, { num: 2 }, { num: 3 }], [{ num: 2 }], (a, b) => a.num === b.num)
 // return [{ num: 1 }, { num: 3 }]

docs/zh/array/xor-with.md

@@ -0,0 +1,27 @@
+# xorWith
+
+对传入的数组进行异或(Exclusive OR)计算，返回一个新的 `数组`，并支持自定义比较函数。
+
+### 使用
+
+```ts
+import { xorWith } from 'rattail'
+
+xorWith([{ num: 1 }, { num: 2 }, { num: 2 }], [{ num: 1 }, { num: 3 }], (a, b) => a.num === b.num)
+// return [{ num: 2 }, { num: 3 }]
+xorWith([{ num: 1 }, { num: 2 }], [{ num: 1 }, { num: 2 }], [{ num: 3 }], (a, b) => a.num === b.num)
+// return [{ num: 3 }]
+```
+
+### 参数
+
+| 参数        | 类型                      | 默认值 |
+| ----------- | ------------------------- | ------ |
+| `...values` | `Array<Array>`            |        |
+| `fn`        | `(a: any, b: any) => any` |        |
+
+### 返回值
+
+| 类型    |
+| ------- |
+| `Array` |

docs/zh/array/xor.md

@@ -0,0 +1,26 @@
+# xor
+
+对传入的数组进行异或(Exclusive OR)计算，返回一个新的 `数组`。
+
+### 使用
+
+```ts
+import { xor } from 'rattail'
+
+xor([1, 2, 2], [1, 3])
+// return [2, 3]
+xor([1, 2], [1, 2], [3])
+// return [3]
+```
+
+### 参数
+
+| 参数        | 类型           | 默认值 |
+| ----------- | -------------- | ------ |
+| `...values` | `Array<Array>` |        |
+
+### 返回值
+
+| 类型    |
+| ------- |
+| `Array` |

package.json

@@ -33,12 +33,11 @@
   },
   "scripts": {
     "prepare": "simple-git-hooks",
-    "dev": "tsup src/index.ts --format esm --out-dir=lib --watch --dts",
+    "dev": "vitest --coverage",
     "build": "tsup src/index.ts --format esm,cjs --out-dir=lib --dts --clean",
     "lint": "eslint . --fix --ext .ts,.js",
     "format": "prettier --write .",
     "clean": "rimraf node_modules lib",
-    "test:watch": "vitest --coverage",
     "test": "vitest run --coverage",
     "release": "pnpm build && vr release",
     "docs:dev": "vitepress dev docs",

src/array/index.ts

@@ -14,3 +14,5 @@ export * from './differenceWith'
 export * from './intersection'
 export * from './intersectionWith'
 export * from './groupBy'
+export * from './xor'
+export * from './xorWith'

src/array/xor.ts

@@ -0,0 +1,5 @@
+import { xorWith } from './xorWith'
+
+export function xor<T>(...values: T[][]): T[] {
+  return xorWith(...values, (a, b) => a === b)
+}

src/array/xorWith.ts

@@ -0,0 +1,17 @@
+import { at } from './at'
+import { differenceWith } from './differenceWith'
+import { uniqBy } from './uniqBy'
+
+type Fn<T> = (a: T, b: T) => any
+
+export function xorWith<T>(...values: [...T[][], fn: Fn<T>]): T[] {
+  const fn = at(values, -1) as Fn<T>
+  const targets = values.slice(0, -1) as T[][]
+
+  return uniqBy(
+    targets.reduce((result, target) => {
+      return [...differenceWith(result, target, fn), ...differenceWith(target, result, fn)]
+    }),
+    fn,
+  )
+}

tests/array.spec.ts

@@ -16,6 +16,8 @@ import {
   intersection,
   intersectionWith,
   groupBy,
+  xor,
+  xorWith,
 } from '../src'
 
 it('uniq', () => {
@@ -183,3 +185,22 @@ it('groupBy', () => {
     male: [{ name: 'c', gender: 'male' }],
   })
 })
+
+it('xor', () => {
+  expect(xor([])).toEqual([])
+  expect(xor([1, 2])).toEqual([1, 2])
+  expect(xor([1, 2], [1, 2], [3])).toEqual([3])
+  expect(xor([1, 2, 2], [1, 3])).toEqual([2, 3])
+  expect(xor([], [1, 3])).toEqual([1, 3])
+  expect(xor([1, 3], [])).toEqual([1, 3])
+})
+
+it('xorWith', () => {
+  expect(xorWith([{ num: 1 }, { num: 2 }, { num: 2 }], [{ num: 1 }, { num: 3 }], (a, b) => a.num === b.num)).toEqual([
+    { num: 2 },
+    { num: 3 },
+  ])
+  expect(xorWith([{ num: 1 }, { num: 3 }], [{ num: 1 }, { num: 3 }], (a, b) => a.num === b.num)).toEqual([])
+  expect(xorWith([{ num: 1 }, { num: 3 }], [], (a, b) => a.num === b.num)).toEqual([{ num: 1 }, { num: 3 }])
+  expect(xorWith([], [{ num: 1 }, { num: 3 }], (a, b) => a.num === b.num)).toEqual([{ num: 1 }, { num: 3 }])
+})