@netflix/nerror 1.0.0 → 1.1.3

package/CHANGELOG.md

@@ -1,3 +1,29 @@
+<a name="1.1.3"></a>
+### 1.1.3 (2019-11-27)
+
+
+#### Bug Fixes
+
+* **nerror:**  don't call extsprintf if single string passed to VError constructor (#11) ([89b2088b](https://github.com/Netflix/nerror/commit/89b2088b))
+
+
+<a name="1.1.2"></a>
+### 1.1.2 (2019-07-26)
+
+
+<a name="1.1.1"></a>
+### 1.1.1 (2019-07-09)
+
+
+<a name="1.1.0"></a>
+## 1.1.0 (2019-05-06)
+
+
+#### Features
+
+* **errorForEach:** make it MultiError support more general (#2) ([96cc8769](https://github.com/Netflix/nerror/commit/96cc8769))
+
+
 <a name="1.0.0"></a>
 ## 1.0.0 (2019-05-02)
 

package/README.md

@@ -60,7 +60,7 @@ JavaScript Error class, with the addition of printf-style messages:
 
 ```javascript
 const { VError } = require('@netflix/nerror');
-const err = new NError('missing file: "%s"', '/etc/passwd');
+const err = new VError('missing file: "%s"', '/etc/passwd');
 console.log(err.message);
 ```
 

package/lib/index.d.ts

@@ -0,0 +1,67 @@
+export class VError extends Error {
+    static VError: typeof VError;
+
+    static cause(err: Error): Error | null;
+    static info(err: Error): VError.Info;
+    static fullStack(err: Error): string;
+    static findCauseByName(err: Error, name: string): Error | null;
+    static hasCauseWithName(err: Error, name: string): boolean;
+    static errorFromList<T extends Error>(
+        errors: T[]
+    ): null | T | VError.MultiError;
+    static errorForEach(err: Error, func: (err: Error) => void): void;
+
+    cause(): Error | undefined;
+    constructor(
+        options: VError.Options | Error,
+        message: string,
+        ...params: any[]
+    );
+    constructor(message?: string, ...params: any[]);
+}
+
+export namespace VError {
+    interface Info {
+        [key: string]: any;
+    }
+
+    interface Options {
+        cause?: Error | null;
+        name?: string;
+        strict?: boolean;
+        constructorOpt?(...args: any[]): void;
+        info?: Info;
+    }
+
+    /*
+     * SError is like VError, but stricter about types.  You cannot pass "null" or
+     * "undefined" as string arguments to the formatter.  Since SError is only a
+     * different function, not really a different class, we don't set
+     * SError.prototype.name.
+     */
+    class SError extends VError {}
+
+    /*
+     * PError is like VError, but the message is not run through printf-style
+     * templating.
+     */
+    class PError extends VError {}
+
+    /*
+     * Represents a collection of errors for the purpose of consumers that generally
+     * only deal with one error.  Callers can extract the individual errors
+     * contained in this object, but may also just treat it as a normal single
+     * error, in which case a summary message will be printed.
+     */
+    class MultiError extends VError {
+        constructor(errors: Error[]);
+        errors(): Error[];
+    }
+
+    /*
+     * Like JavaScript's built-in Error class, but supports a "cause" argument which
+     * is wrapped, not "folded in" as with VError.	Accepts a printf-style message.
+     * The cause argument can be null.
+     */
+    class WError extends VError {}
+}

package/lib/verror.js

@@ -134,7 +134,10 @@ function parseConstructorArguments(args) {
 
     if (sprintf_args.length === 0) {
         shortmessage = '';
-    } else if (options.skipPrintf) {
+    } else if (
+        options.skipPrintf ||
+        (sprintf_args.length === 1 && typeof sprintf_args[0] === 'string')
+    ) {
         assert.equal(
             sprintf_args.length,
             1,
@@ -597,7 +600,7 @@ VError.errorForEach = function errorForEach(err, func) {
     VError._assertError(err);
     assert.func(func, 'func');
 
-    if (err instanceof MultiError) {
+    if (err.name === 'MultiError') {
         err.errors().forEach(function iterError(e) {
             func(e);
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netflix/nerror",
-  "version": "1.0.0",
+  "version": "1.1.3",
   "main": "lib/index.js",
   "description": "Rich errors",
   "homepage": "https://github.com/Netflix/nerror",
@@ -10,8 +10,10 @@
   },
   "license": "MIT",
   "files": [
-    "lib"
+    "lib",
+    "lib/index.d.ts"
   ],
+  "types": "lib/index.d.ts",
   "keywords": [
     "nerror",
     "error",
@@ -29,14 +31,18 @@
     "mocha": "^5.2.0",
     "nyc": "^12.0.2",
     "prettier": "^1.13.5",
+    "tsd": "^0.7.3",
     "unleash": "^2.0.1"
   },
   "dependencies": {
     "assert-plus": "^1.0.0",
     "extsprintf": "^1.4.0",
-    "lodash": "^4.17.11"
+    "lodash": "^4.17.15"
   },
   "scripts": {
-    "test": "make prepush"
+    "test": "make prepush & tsd"
+  },
+  "tsd": {
+    "directory": "test"
   }
 }