@xylabs/set 4.13.19 → 4.13.21

package/README.md

@@ -12,13 +12,113 @@
 [![snyk-badge][]][snyk-link]
 [![socket-badge][]][socket-link]
 
-Version: 4.13.15
 
 Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
-## Documentation
+## API Documentation
+
+**@xylabs/set**
+
+***
+
+## Functions
+
+- [difference](#functions/difference)
+- [intersection](#functions/intersection)
+- [union](#functions/union)
+
+### functions
+
+  ### <a id="difference"></a>difference
+
+[**@xylabs/set**](#../README)
+
+***
+
+```ts
+function difference<TKey>(a, b): Set<TKey>;
+```
+
+## Type Parameters
+
+### TKey
+
+`TKey`
+
+## Parameters
+
+### a
+
+`Set`\<`TKey`\>
+
+### b
+
+`Set`\<`TKey`\>
+
+## Returns
+
+`Set`\<`TKey`\>
+
+  ### <a id="intersection"></a>intersection
+
+[**@xylabs/set**](#../README)
+
+***
+
+```ts
+function intersection<TKey>(a, b): Set<TKey>;
+```
+
+## Type Parameters
+
+### TKey
+
+`TKey`
+
+## Parameters
+
+### a
+
+`Set`\<`TKey`\>
+
+### b
+
+`Set`\<`TKey`\>
+
+## Returns
+
+`Set`\<`TKey`\>
+
+  ### <a id="union"></a>union
+
+[**@xylabs/set**](#../README)
+
+***
+
+```ts
+function union<TKey>(a, b): Set<TKey>;
+```
+
+## Type Parameters
+
+### TKey
+
+`TKey`
+
+## Parameters
+
+### a
+
+`Set`\<`TKey`\>
+
+### b
+
+`Set`\<`TKey`\>
+
+## Returns
+
+`Set`\<`TKey`\>
 
-Coming Soon!
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/set",
-  "version": "4.13.19",
+  "version": "4.13.21",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "set",
@@ -29,18 +29,21 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
+      "source": "./src/index.ts",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "./dist/neutral/index.mjs",
+  "source": "./src/index.ts",
   "types": "./dist/neutral/index.d.ts",
-  "workspaces": [
-    "packages/**/*"
+  "files": [
+    "dist",
+    "src"
   ],
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
-    "@xylabs/tsconfig": "^7.0.0-rc.27",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0",
+    "@xylabs/tsconfig": "^7.0.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/src/lib/spec/difference.spec.ts

@@ -0,0 +1,19 @@
+import {
+  describe, expect, test,
+} from 'vitest'
+
+import { difference } from '../difference.ts'
+
+const cases = [
+  // Difference is non-commutative
+  [new Set([1, 2, 3]), new Set([2, 3, 4]), new Set([1])],
+  [new Set([2, 3, 4]), new Set([1, 2, 3]), new Set([4])],
+  // Difference of identical sets yields empty set
+  [new Set([1, 2, 3]), new Set([1, 2, 3]), new Set([])],
+]
+
+describe('difference', () => {
+  test.each(cases)('calculates the difference of the two sets', (a, b, expected) => {
+    expect(difference(a, b)).toEqual(expected)
+  })
+})

package/src/lib/spec/intersection.spec.ts

@@ -0,0 +1,19 @@
+import {
+  describe, expect, test,
+} from 'vitest'
+
+import { intersection } from '../intersection.ts'
+
+const cases = [
+  // Intersection is commutative
+  [new Set([1, 2, 3]), new Set([2, 3, 4]), new Set([2, 3])],
+  [new Set([2, 3, 4]), new Set([1, 2, 3]), new Set([2, 3])],
+  // Intersection of identical sets yields same set
+  [new Set([1, 2, 3]), new Set([1, 2, 3]), new Set([1, 2, 3])],
+]
+
+describe('intersection', () => {
+  test.each(cases)('calculates the intersection of the two sets', (a, b, expected) => {
+    expect(intersection(a, b)).toEqual(expected)
+  })
+})

package/src/lib/spec/union.spec.ts

@@ -0,0 +1,18 @@
+import {
+  describe, expect, test,
+} from 'vitest'
+
+import { union } from '../union.ts'
+const cases = [
+  // Union is commutative
+  [new Set([1, 2]), new Set([3, 4]), new Set([1, 2, 3, 4])],
+  [new Set([3, 4]), new Set([1, 2]), new Set([1, 2, 3, 4])],
+  // Union of identical sets yields same set
+  [new Set([1, 2, 3]), new Set([1, 2, 3]), new Set([1, 2, 3])],
+]
+
+describe('union', () => {
+  test.each(cases)('calculates the union of the two sets', (a, b, expected) => {
+    expect(union(a, b)).toEqual(expected)
+  })
+})

package/xy.config.ts

@@ -1,10 +0,0 @@
-import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
-const config: XyTsupConfig = {
-  compile: {
-    browser: {},
-    neutral: { src: true },
-    node: {},
-  },
-}
-
-export default config