@xylabs/assert 4.13.15 → 4.13.17

package/README.md

@@ -1,82 +1,54 @@
-[![logo][]](https://xylabs.com)
-
 # @xylabs/assert
 
+[![logo][]](https://xylabs.com)
+
+[![main-build][]][main-build-link]
 [![npm-badge][]][npm-link]
 [![npm-downloads-badge][]][npm-link]
 [![jsdelivr-badge][]][jsdelivr-link]
 [![npm-license-badge][]](LICENSE)
+[![codacy-badge][]][codacy-link]
+[![codeclimate-badge][]][codeclimate-link]
+[![snyk-badge][]][snyk-link]
 [![socket-badge][]][socket-link]
 
-> XY Labs generalized Javascript library 
-
-## Table of Contents
-
--   [Description](#description)
--   [Install](#install)
--   [Maintainers](#maintainers)
--   [License](#license)
--   [Credits](#credits)
-
-## Description
-
-Common Javascript code that is used throughout XYO projects that use React.
-
-## Install
-
-Using npm:
-
-```sh
-npm i --save @xylabs/assert
-```
+Version: 4.13.15
 
-Using yarn:
+Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
-```sh
-yarn add @xylabs/assert
-```
+## Documentation
 
-## Usage
+Coming Soon!
 
-The `assertEx` function is a utility function for simple null/undefined checks for variables. It evaluates an expression for truthiness and throws an error if the expression is false.
-
-Here are some examples of how to use `assertEx` in different scenarios:
-
-- Basic usage:
-
-  ```javascript
-  import { assertEx } from '@xylabs/assert';
-
-  const value = getValue(); // This is a function that may return null or undefined
-  assertEx(value); // Throws an AssertExError with a default message if value is null or undefined
-  ```
-
-- Using with a custom error message:
-
-  ```javascript
-  import { assertEx } from '@xylabs/assert';
-
-  const value = getValue(); // This function may return null or undefined
-  assertEx(value, () => 'Dynamic error message based on some conditions'); // Throws an AssertExError with a dynamic message if value is null or undefined
+Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 
 ## Maintainers
+
 -   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
--   [Joel Carter](https://github.com/JoelBCarter)
 -   [Matt Jones](https://github.com/jonesmac)
+-   [Joel Carter](https://github.com/JoelBCarter)
 -   [Jordan Trouw](https://github.com/jordantrouw)
 
 ## License
 
-See the [LICENSE](LICENSE) file for license details
+> See the [LICENSE](LICENSE) file for license details
 
 ## Credits
 
-[Made with 🔥and ❄️ by XY Labs](https://xylabs.com)
+[Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
 
 [logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
 
+[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
+[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
 [npm-badge]: https://img.shields.io/npm/v/@xylabs/assert.svg
 [npm-link]: https://www.npmjs.com/package/@xylabs/assert
+[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
+[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
+[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
+[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
+[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
+[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
 
 [npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/assert
 [npm-license-badge]: https://img.shields.io/npm/l/@xylabs/assert

package/dist/neutral/index.d.ts

@@ -1,47 +1,4 @@
-type AssertExMessageFunc<T> = (value?: T | null) => string;
-type AssertExErrorFunc<T, R extends Error> = (value?: T | null) => R;
-
-/**
- *
- * Intended for defined checks for variables
- *
- * @param expr - Expression to be evaluated for truthiness
- * @param message - Message in Error if expression is false, may be a function that returns a string
- * @throws AssertExError
- * @returns Value of expression
- */
-declare function assertDefinedEx<T>(expr: T | undefined, messageFunc?: AssertExMessageFunc<T>): T;
-declare function assertDefinedEx<T, R extends Error>(expr: T | undefined, errorFunc?: AssertExErrorFunc<T, R>): T;
-/**
- * @deprecated - passing a message will soon be required
- */
-declare function assertDefinedEx<T>(expr: T | undefined): T;
-/**
- * @deprecated - replace string with () => string
- */
-declare function assertDefinedEx<T>(expr: T | undefined, message?: string): T;
-//# sourceMappingURL=assertDefinedEx.d.ts.map
-
-/**
- *
- * Intended for simple truthiness checks for variables
- *
- * @param expr - Expression to be evaluated for truthiness
- * @param message - Message in Error if expression is false, may be a function that returns a string
- * @throws AssertExError
- * @returns Value of expression
- */
-declare function assertEx<T>(expr: T | null | undefined, messageFunc?: AssertExMessageFunc<T>): T;
-declare function assertEx<T, R extends Error>(expr: T | null | undefined, errorFunc?: AssertExErrorFunc<T, R>): T;
-/**
- * @deprecated - passing a message will soon be required
- */
-declare function assertEx<T>(expr: T | null | undefined): T;
-/**
- * @deprecated - replace string with () => string
- */
-declare function assertEx<T>(expr: T | null | undefined, message?: string): T;
-//# sourceMappingURL=assertEx.d.ts.map
-
-export { assertDefinedEx, assertEx };
-export type { AssertExErrorFunc, AssertExMessageFunc };
+export * from './assertDefinedEx.ts';
+export * from './assertEx.ts';
+export type * from './types.ts';
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/assert",
-  "version": "4.13.15",
+  "version": "4.13.17",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "xylabs",
@@ -35,8 +35,8 @@
   "module": "./dist/neutral/index.mjs",
   "types": "./dist/neutral/index.d.ts",
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
-    "@xylabs/tsconfig": "^7.0.0-rc.20",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
+    "@xylabs/tsconfig": "^7.0.0-rc.27",
     "typescript": "^5.8.3"
   },
   "engines": {

package/build/neutral/index.d.ts

@@ -1,4 +0,0 @@
-export * from './assertDefinedEx.ts';
-export * from './assertEx.ts';
-export type * from './types.ts';
-//# sourceMappingURL=index.d.ts.map