egg-errors - npm Package Compare versions

Comparing version 2.2.3 to 2.3.0

History.md

 
+2.3.0 / 2021-10-26
+==================
+
+**features**
+  * [[`94453a4`](http://github.com/eggjs/egg-errors/commit/94453a4b2b24c98b0fc53020808340e446a04ed8)] - feat: add static create method (#13) (mansonchor.github.com <<[e-mail]>>)
+
 2.2.3 / 2021-07-29
@@ -3,0 +9,0 @@ ==================

lib/framework/framework_base_error.d.ts

@@ -8,3 +8,4 @@ import { EggBaseError, ErrorOptions } from '../';
     constructor(message: string, serialNumber: string | number, errorContext?: any);
+    static create(message: string, serialNumber: string | number, errorContext?: any): FrameworkBaseError;
     static isFrameworkError(err: Error): err is FrameworkBaseError;
 }

lib/framework/framework_base_error.js

@@ -5,2 +5,3 @@ "use strict";
 const __1 = require("../");
+const formatter_1 = require("./formatter");
 const assert = require("assert");
@@ -21,2 +22,8 @@ exports.FRAMEWORK_ERROR_SYMBOL = Symbol.for('FrameworkBaseError');
     }
+    // create a new frameworkError with format
+    static create(message, serialNumber, errorContext) {
+        const err = formatter_1.FrameworkErrorFormater.formatError(new this(message, serialNumber, errorContext));
+        Error.captureStackTrace(err, this.create);
+        return err;
+    }
     static isFrameworkError(err) {
@@ -27,2 +34,2 @@ return err[exports.FRAMEWORK_ERROR_SYMBOL] === true;
 exports.FrameworkBaseError = FrameworkBaseError;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZnJhbWV3b3JrX2Jhc2VfZXJyb3IuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJmcmFtZXdvcmtfYmFzZV9lcnJvci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSwyQkFBaUQ7QUFDakQsaUNBQWlDO0FBRXBCLFFBQUEsc0JBQXNCLEdBQVcsTUFBTSxDQUFDLEdBQUcsQ0FBQyxvQkFBb0IsQ0FBQyxDQUFDO0FBRS9FLE1BQWEsa0JBQW1CLFNBQVEsZ0JBQTBCO0lBUWhFLFlBQVksT0FBZSxFQUFFLFlBQTZCLEVBQUUsWUFBa0I7UUFDNUUsS0FBSyxDQUFDLEVBQUUsT0FBTyxFQUFFLFlBQVksRUFBRSxZQUFZLEVBQUUsQ0FBQyxDQUFDO1FBQy9DLE1BQU0sQ0FBQyxPQUFPLEVBQUUscUJBQXFCLENBQUMsQ0FBQztRQUN2QyxNQUFNLENBQUMsWUFBWSxFQUFFLDBCQUEwQixDQUFDLENBQUM7UUFFakQsSUFBSSxDQUFDLFlBQVksR0FBRyxNQUFNLENBQUMsWUFBWSxDQUFDLENBQUM7UUFDekMsSUFBSSxDQUFDLFlBQVksR0FBRyxZQUFZLElBQUksRUFBRSxDQUFDO1FBQ3ZDLElBQUksQ0FBQyxJQUFJLEdBQUcsR0FBRyxJQUFJLENBQUMsTUFBTSxJQUFJLElBQUksQ0FBQyxZQUFZLEVBQUUsQ0FBQztRQUVqRCxJQUFZLENBQUMsOEJBQXNCLENBQUMsR0FBRyxJQUFJLENBQUM7SUFDL0MsQ0FBQztJQWRELElBQUksTUFBTTtRQUNSLE1BQU0sSUFBSSxLQUFLLENBQUMsNEJBQTRCLENBQUMsQ0FBQztJQUNoRCxDQUFDO0lBY0QsTUFBTSxDQUFDLGdCQUFnQixDQUFDLEdBQVU7UUFDaEMsT0FBUSxHQUFXLENBQUMsOEJBQXNCLENBQUMsS0FBSyxJQUFJLENBQUM7SUFDdkQsQ0FBQztDQUNGO0FBdkJELGdEQXVCQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZnJhbWV3b3JrX2Jhc2VfZXJyb3IuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJmcmFtZXdvcmtfYmFzZV9lcnJvci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSwyQkFBaUQ7QUFDakQsMkNBQXFEO0FBQ3JELGlDQUFpQztBQUVwQixRQUFBLHNCQUFzQixHQUFXLE1BQU0sQ0FBQyxHQUFHLENBQUMsb0JBQW9CLENBQUMsQ0FBQztBQUUvRSxNQUFhLGtCQUFtQixTQUFRLGdCQUEwQjtJQVFoRSxZQUFZLE9BQWUsRUFBRSxZQUE2QixFQUFFLFlBQWtCO1FBQzVFLEtBQUssQ0FBQyxFQUFFLE9BQU8sRUFBRSxZQUFZLEVBQUUsWUFBWSxFQUFFLENBQUMsQ0FBQztRQUMvQyxNQUFNLENBQUMsT0FBTyxFQUFFLHFCQUFxQixDQUFDLENBQUM7UUFDdkMsTUFBTSxDQUFDLFlBQVksRUFBRSwwQkFBMEIsQ0FBQyxDQUFDO1FBRWpELElBQUksQ0FBQyxZQUFZLEdBQUcsTUFBTSxDQUFDLFlBQVksQ0FBQyxDQUFDO1FBQ3pDLElBQUksQ0FBQyxZQUFZLEdBQUcsWUFBWSxJQUFJLEVBQUUsQ0FBQztRQUN2QyxJQUFJLENBQUMsSUFBSSxHQUFHLEdBQUcsSUFBSSxDQUFDLE1BQU0sSUFBSSxJQUFJLENBQUMsWUFBWSxFQUFFLENBQUM7UUFFakQsSUFBWSxDQUFDLDhCQUFzQixDQUFDLEdBQUcsSUFBSSxDQUFDO0lBQy9DLENBQUM7SUFkRCxJQUFJLE1BQU07UUFDUixNQUFNLElBQUksS0FBSyxDQUFDLDRCQUE0QixDQUFDLENBQUM7SUFDaEQsQ0FBQztJQWNELDBDQUEwQztJQUMxQyxNQUFNLENBQUMsTUFBTSxDQUFDLE9BQWUsRUFBRSxZQUE2QixFQUFFLFlBQWtCO1FBQzlFLE1BQU0sR0FBRyxHQUFHLGtDQUFzQixDQUFDLFdBQVcsQ0FBQyxJQUFJLElBQUksQ0FBQyxPQUFPLEVBQUUsWUFBWSxFQUFFLFlBQVksQ0FBQyxDQUFDLENBQUM7UUFDOUYsS0FBSyxDQUFDLGlCQUFpQixDQUFDLEdBQUcsRUFBRSxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUM7UUFDMUMsT0FBTyxHQUFHLENBQUM7SUFDYixDQUFDO0lBRUQsTUFBTSxDQUFDLGdCQUFnQixDQUFDLEdBQVU7UUFDaEMsT0FBUSxHQUFXLENBQUMsOEJBQXNCLENBQUMsS0FBSyxJQUFJLENBQUM7SUFDdkQsQ0FBQztDQUNGO0FBOUJELGdEQThCQyJ9

package.json

 {
   "name": "egg-errors",
-  "version": "2.2.3",
+  "version": "2.3.0",
   "description": "",
@@ -5,0 +5,0 @@ "scripts": {

README.md

@@ -139,2 +139,22 @@ # egg-errors
 
+#### create frameworkError with formater
+
+use the static method `.create(message: string, serialNumber: string | number, errorContext?: any)` to new a frameworkError and format it convenient
+
+```js
+const { FrameworkBaseError } = require('egg-errors');
+
+class EggMysqlError extends FrameworkBaseError {
+  // module should be implement
+  get module() {
+    return 'EGG_MYSQL';
+  }
+}
+
+const err = EggMysqlError.create('error message', '01', { traceId: 'xxx' });
+console.log(err.message); 
+// =>
+framework.EggMysqlError: error message [https://eggjs.org/zh-cn/faq/EGG_MYSQL/01]
+```
+
 ### FrameworkErrorFormater
@@ -144,3 +164,3 @@
 
-the faq guide url format: `${faqPrefix}/${err.module}#${err.serialNumber}`, `faqPrefix` is `https://eggjs.org/zh-cn/faq` by default. can be extendable or set `process.env.EGG_FRAMEWORK_ERR_FAQ_PERFIX` to override it.
+the faq guide url format: `${faqPrefix}/${err.module}/${err.serialNumber}`, `faqPrefix` is `https://eggjs.org/zh-cn/faq` by default. can be extendable or set `process.env.EGG_FRAMEWORK_ERR_FAQ_PERFIX` to override it.
 
@@ -172,3 +192,3 @@ ```js
 // => message format like this
-framework.EggMysqlError: error message [https://eggjs.org/zh-cn/faq/EGG_MYSQL#01]
+framework.EggMysqlError: error message [https://eggjs.org/zh-cn/faq/EGG_MYSQL/01]
 ...stack
@@ -190,3 +210,3 @@ ...
 // =>
-framework.EggMysqlError: error message [http://www.custom.com/faq/EGG_MYSQL#01]
+framework.EggMysqlError: error message [http://www.custom.com/faq/EGG_MYSQL/01]
 ...
@@ -210,3 +230,3 @@ ```
 const err = FrameworkErrorFormater.formatError(new EggMysqlError('error message', '01'));
-console.log(err.message); // error message [https://eggjs.org/zh-cn/faq/EGG_MYSQL#01]
+console.log(err.message); // error message [https://eggjs.org/zh-cn/faq/EGG_MYSQL/01]
 ```
@@ -213,0 +233,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

95379

increased by1.74%

Lines of code

1143

increased by0.7%

Number of lines in readme file

253

increased by8.58%

No dependency changes