@thi.ng/errors 2.4.19 → 2.5.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-03-01T15:22:50Z
+- **Last updated**: 2024-03-13T14:04:31Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [2.5.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/errors@2.5.0) (2024-03-13)
+
+#### 🚀 Features
+
+- add CustomError interface, update docs, add tests ([d2ea8b2](https://github.com/thi-ng/umbrella/commit/d2ea8b2))
+
 ### [2.4.1](https://github.com/thi-ng/umbrella/tree/@thi.ng/errors@2.4.1) (2023-11-09)
 
 #### ♻️ Refactoring

package/assert.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 export declare const AssertionError: {
     new (msg?: any): {
+        origMessage: string;
         name: string;
         message: string;
         stack?: string | undefined;

package/deferror.d.ts

@@ -1,6 +1,24 @@
 /// <reference types="node" />
-export declare const defError: <T = string>(prefix: (msg?: T | undefined) => string, suffix?: (msg?: T | undefined) => string) => {
-    new (msg?: T | undefined): {
+export interface CustomError extends Error {
+    /**
+     * The original message given to the error ctor (prior to applying
+     * prefix/suffix). If none was given this will be an empty string.
+     */
+    origMessage: string;
+}
+/**
+ * Defines a custom error type/class which implements the {@link CustomError}
+ * interface.
+ *
+ * @remarks
+ * All error types in this package are defined via this function.
+ *
+ * @param prefix
+ * @param suffix
+ */
+export declare const defError: <T = string>(prefix: (msg?: T) => string, suffix?: (msg?: T) => string) => {
+    new (msg?: T): {
+        origMessage: string;
         name: string;
         message: string;
         stack?: string | undefined;

package/deferror.js

@@ -1,6 +1,8 @@
 const defError = (prefix, suffix = (msg) => msg !== void 0 ? ": " + msg : "") => class extends Error {
+  origMessage;
   constructor(msg) {
     super(prefix(msg) + suffix(msg));
+    this.origMessage = msg !== void 0 ? String(msg) : "";
   }
 };
 export {

package/ensure.d.ts

@@ -1,9 +1,9 @@
 /**
- * Higher-order function to define ensurance assertions. Takes a `pred`icate
+ * Higher-order function to define assurance assertions. Takes a `pred`icate
  * function and an `expected` (type) name, returns a new function which accepts
- * 2 args (an arbitrary value `x` and optional error `msg`). When called, checks
- * `x` for non-null and if so applies given `pred`icate. If result is false (or
- * `x` is nullish) and iff {@link assert} is enabled, throws a
+ * 2 args: an arbitrary value `x` and optional error `msg`. When called, checks
+ * `x` for non-nullishness and if so applies given `pred`icate. If result is
+ * false (or `x` is nullish) and iff {@link assert} is enabled, throws a
  * {@link AssertionError} with given `msg` (or a constructed default msg).
  * Otherwise function is a no-op.
  *

package/illegal-arguments.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 export declare const IllegalArgumentError: {
     new (msg?: any): {
+        origMessage: string;
         name: string;
         message: string;
         stack?: string | undefined;

package/illegal-arity.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 export declare const IllegalArityError: {
     new (msg?: number | undefined): {
+        origMessage: string;
         name: string;
         message: string;
         stack?: string | undefined;

package/illegal-state.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 export declare const IllegalStateError: {
     new (msg?: any): {
+        origMessage: string;
         name: string;
         message: string;
         stack?: string | undefined;

package/io.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 export declare const IOError: {
     new (msg?: any): {
+        origMessage: string;
         name: string;
         message: string;
         stack?: string | undefined;
@@ -13,6 +14,7 @@ export declare const IOError: {
 export declare const ioerror: (msg?: any) => never;
 export declare const FileNotFoundError: {
     new (msg?: any): {
+        origMessage: string;
         name: string;
         message: string;
         stack?: string | undefined;

package/out-of-bounds.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 export declare const OutOfBoundsError: {
     new (msg?: any): {
+        origMessage: string;
         name: string;
         message: string;
         stack?: string | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/errors",
-  "version": "2.4.19",
+  "version": "2.5.0",
   "description": "Custom error types and error factory functions",
   "type": "module",
   "module": "./index.js",
@@ -32,15 +32,16 @@
     "doc:ae": "mkdir -p .ae/doc .ae/temp && api-extractor run --local --verbose",
     "doc:readme": "bun ../../tools/src/module-stats.ts && bun ../../tools/src/readme.ts",
     "pub": "yarn npm publish --access public",
-    "test": "bun test"
+    "test": "bun test",
+    "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.40.1",
-    "@types/node": "^20.11.17",
-    "esbuild": "^0.20.0",
+    "@microsoft/api-extractor": "^7.42.3",
+    "@types/node": "^20.11.26",
+    "esbuild": "^0.20.1",
     "rimraf": "^5.0.5",
-    "typedoc": "^0.25.7",
-    "typescript": "^5.3.3"
+    "typedoc": "^0.25.12",
+    "typescript": "^5.4.2"
   },
   "keywords": [
     "assert",
@@ -96,5 +97,5 @@
   "thi.ng": {
     "year": 2018
   },
-  "gitHead": "d660ae8fd1bf64d919b4334f19509f1f539d70f6\n"
+  "gitHead": "7f3fcbd6c0462b0ce45afa141fe163d1f297fd51\n"
 }

package/unsupported.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 export declare const UnsupportedOperationError: {
     new (msg?: any): {
+        origMessage: string;
         name: string;
         message: string;
         stack?: string | undefined;