ts-nested-error - npm Package Compare versions

Comparing version 1.0.1 to 1.1.0

package.json

 {
   "name": "ts-nested-error",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Lightweight xplatform nested error implementation with native TypeScript support.",
@@ -17,20 +17,6 @@ "main": "build/nested-error.js",
   },
-  "repository": {
-    "type": "git",
-    "url": "https://git.sami.int.thomsonreuters.com/Vitalii.Kryvenko/MicroservicesPoC.git"
-  },
-  "keywords": [
-    "nested",
-    "error",
-    "nested-error",
-    "typescript",
-    "ttypescript"
-  ],
-  "author": "Lynx Insight Dev <[e-mail]>",
-  "license": "MIT",
-  "dependencies": {},
   "devDependencies": {
     "@types/jest": "^24.0.18",
-    "@types/node": "^12.7.5",
-    "@types/ts-nameof": "^3.2.0",
+    "@types/node": "^12.7.11",
+    "@types/ts-nameof": "^4.0.0",
     "coveralls": "^3.0.6",
@@ -42,3 +28,3 @@ "jest": "^24.9.0",
     "ts-jest": "^24.1.0",
-    "ts-nameof": "^3.2.0",
+    "ts-nameof": "^4.0.3",
     "ts-node": "^8.4.1",
@@ -49,3 +35,16 @@ "ts-node-dev": "^1.0.0-pre.40",
     "typescript": "^3.6.3"
-  }
+  },
+  "author": "Veetaha",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Veetaha/ts-nested-error.git"
+  },
+  "keywords": [
+    "nested",
+    "error",
+    "nested-error",
+    "typescript",
+    "ttypescript"
+  ]
 }

README.md

@@ -9,21 +9,20 @@ # ts-nested-error
 
-### `new NestedError(message: string, public readonly innerError?: Error)`
+## :zap: Rationale
 
-Class that provides `readonly innerError?: Error` property alongside with an error callstack (as `.stack` property) of original error eagerly
-combined with itself's. Deeply nested errors
-form a list of callstacks and error messages that are concatenated.
+Suppose you are handling some low-level error and need to throw a higher-level one while having its original cause attached to it for debug purposes.
 
-**Example:**
+This package provides an extremely concise C#-like `NestedError` implementation for you:
 
 ```ts
+    import { NestedError } from 'ts-nested-error';
+
     try {
-        throw new Error('Connection timed out');
+        dataService.saveData(data);
     } catch (err) {
-        throw new NestedError(`Oh no, couldn't load file! More info in inner error`, err);
+        throw new NestedError("DataService failed to save data", err);
     }
 ```
-
-This code will produce an error that when stringifed shows the following message:
+This code will produce an error that when stringified shows the following message:
 ```
-NestedError: Oh no, couldn't load file! More info in inner error
+NestedError: DataService failed to save data
     at someMethod (/path/to/code.js:line:column)
@@ -39,22 +38,49 @@ at ...
 
-### `NestedError.rethrow(message: string)` 
-Returns a function that throws `NestedError` or an object
-of class that is derived from it with the given `message`.
-This is mostly intended to be a shorthand to create error wrapping callbacks
-for `Promise`s:
+## :scroll: Documentation
+Everything is strongly typed and you may expect good inline documentation from VSCode.
 
+## :sunglasses: Features of `NestedError`
+
+### Stack property
+Property `.stack` of `NestedError` is guaranteed to contain a string with error
+callstack if it is supported by runtime or `"${err.name}: ${err.message}"` as a fallback.
+
+### InnerError property
+
+`NestedError` constructor automatically coerces the value passed as the second argument `toError()` object and saves it in `.innerError` property. 
+
+
+### Promise error handler shortcut
+
+Suppose you invoke some async operation and don't want to to write verbose
+error handling lambda to pass as `onerror` callback to `.then()` or `.catch()`.
+
+Static `NestedError.rethrow(message)` method is here to shorten you code:
+
 ```ts
-import { NestedError } from 'ts-nested-error';
+userService.getPage().then(
+    data => console.log(`Hooray! data: ${data}`),
+    err => {
+        throw new NestedError('failed to fetch users page', err);
+    }
+);
 
-class DbError extends NestedError {}
+  ↓ ↓ ↓ ↓ ↓ ↓
 
-database.get().then(
+userService.getPage().then(
     data => console.log(`Hooray! data: ${data}`),
-    DbError.rethrow('some database error happened') // throws instanceof DbError
+    NestedError.rethrow('failed to fetch users page')
 );
 ```
+It just creates the same error handling callback that rethrows passed-in error with given `message`.
 
-### `toError(err)`
 
-Returns `err` itself if `err instanceof Error === true`, otherwise attemts to
+### Coerse values to Error
+
+Suppose you are handling an error within the catch clause.
+Though it may seem very unlikely, the thrown value is not required to be `instanceof Error`.
+
+Exported `toError(value)` free function ensures that for you.
+
+It returns `value` itself if `value instanceof Error`, otherwise attempts to
 stringify it and wrap into `Error` object to be returned.
@@ -61,0 +87,0 @@

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

20355

increased by136.6%

Number of package files

11

increased by175%

Lines of code

355

increased by228.7%

Number of lines in readme file

99

increased by35.62%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes