@xylabs/exists 4.13.19 → 4.13.21

package/README.md

@@ -12,13 +12,60 @@
 [![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/exists**
+
+***
+
+## Functions
+
+- [exists](#functions/exists)
+
+### functions
+
+  ### <a id="exists"></a>exists
+
+[**@xylabs/exists**](#../README)
+
+***
+
+```ts
+function exists<T>(x?): x is NonNullable<T>;
+```
+
+Used to type narrow an object which is possibly null or undefined. Works well
+with functional Array methods. For example:
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### x?
+
+The object which is potentially undefined or null
+
+`null` | `T`
+
+## Returns
+
+`x is NonNullable<T>`
+
+False if the object is null/undefined, true otherwise
+
+## Example
+
+```ts
+const payloads: XyoPayload[] = boundWitness._payloads?.filter(exists) || []
+```
 
-Coming Soon!
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/exists",
-  "version": "4.13.19",
+  "version": "4.13.21",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "exists",
@@ -29,15 +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",
+  "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/spec/exists.spec.ts

@@ -0,0 +1,43 @@
+import {
+  describe, expect, it,
+} from 'vitest'
+
+// eslint-disable-next-line no-restricted-imports
+import { exists } from '../index.ts'
+
+const filterableValues = [undefined, null]
+const nonfilterableValue = {}
+
+describe('exists', () => {
+  describe.each(filterableValues)('with all %p', (value) => {
+    it('filters all', () => {
+      const input = [value, value]
+      const actual = input.filter(exists)
+      expect(actual.length).toBe(0)
+    })
+  })
+  describe.each(filterableValues)('with mixed %p', (value) => {
+    it('filters some', () => {
+      const input = [value, nonfilterableValue, value, nonfilterableValue]
+      const actual = input.filter(exists)
+      expect(actual.length).toBe(2)
+    })
+  })
+  describe.each(filterableValues)('with no %p', () => {
+    it('filters none', () => {
+      const input = [nonfilterableValue, nonfilterableValue]
+      const actual = input.filter(exists)
+      expect(actual.length).toBe(input.length)
+    })
+  })
+  it('does not filter zero', () => {
+    const input = [0, 1]
+    const actual = input.filter(exists)
+    expect(actual).toEqual(input)
+  })
+  it('does not filter false', () => {
+    const input = [true, false]
+    const actual = input.filter(exists)
+    expect(actual).toEqual(input)
+  })
+})

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