@eggjs/errors 3.0.0-beta.29 → 3.0.0-beta.30
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/dist/framework/formatter.js +1 -1
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -148,14 +148,14 @@ class EggMysqlError extends FrameworkBaseError {
|
|
|
148
148
|
const err = EggMysqlError.create('error message', '01', { traceId: 'xxx' });
|
|
149
149
|
console.log(err.message);
|
|
150
150
|
// =>
|
|
151
|
-
framework.EggMysqlError: error message [ https://eggjs.org/
|
|
151
|
+
framework.EggMysqlError: error message [ https://eggjs.org/faq/EGG_MYSQL/01 ]
|
|
152
152
|
```
|
|
153
153
|
|
|
154
154
|
### FrameworkErrorFormater
|
|
155
155
|
|
|
156
156
|
FrameworkErrorFormater will append a faq guide url in error message.this would be helpful when developer encountered a framework error
|
|
157
157
|
|
|
158
|
-
the faq guide url format: `${faqPrefix}/${err.module}/${err.serialNumber}`, `faqPrefix` is `https://eggjs.org/
|
|
158
|
+
the faq guide url format: `${faqPrefix}/${err.module}/${err.serialNumber}`, `faqPrefix` is `https://eggjs.org/faq` by default. It can be extended or overridden by setting `process.env.EGG_FRAMEWORK_ERR_FAQ_PREFIX` (recommended) or, for backward compatibility, `process.env.EGG_FRAMEWORK_ERR_FAQ_PERFIX` (legacy typo).
|
|
159
159
|
|
|
160
160
|
```js
|
|
161
161
|
const { FrameworkErrorFormater } = require('@eggjs/errors');
|
|
@@ -182,7 +182,7 @@ class EggMysqlError extends FrameworkBaseError {
|
|
|
182
182
|
const message = FrameworkErrorFormater.format(new EggMysqlError('error message', '01'));
|
|
183
183
|
console.log(message);
|
|
184
184
|
// => message format like this
|
|
185
|
-
framework.EggMysqlError: error message [ https://eggjs.org/
|
|
185
|
+
framework.EggMysqlError: error message [ https://eggjs.org/faq/EGG_MYSQL/01 ]
|
|
186
186
|
...stack
|
|
187
187
|
...
|
|
188
188
|
code: "EGG_MYSQL_01"
|
|
@@ -218,7 +218,7 @@ class EggMysqlError extends FrameworkBaseError {
|
|
|
218
218
|
}
|
|
219
219
|
|
|
220
220
|
const err = FrameworkErrorFormater.formatError(new EggMysqlError('error message', '01'));
|
|
221
|
-
console.log(err.message); // error message [ https://eggjs.org/
|
|
221
|
+
console.log(err.message); // error message [ https://eggjs.org/faq/EGG_MYSQL/01 ]
|
|
222
222
|
```
|
|
223
223
|
|
|
224
224
|
### Available Errors
|
|
@@ -5,7 +5,7 @@ import os from "node:os";
|
|
|
5
5
|
//#region src/framework/formatter.ts
|
|
6
6
|
const hostname = os.hostname();
|
|
7
7
|
var FrameworkErrorFormatter = class {
|
|
8
|
-
static faqPrefix = "https://eggjs.org/
|
|
8
|
+
static faqPrefix = "https://eggjs.org/faq";
|
|
9
9
|
/**
|
|
10
10
|
* Custom framework error FAQ prefix
|
|
11
11
|
*/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@eggjs/errors",
|
|
3
|
-
"version": "3.0.0-beta.
|
|
3
|
+
"version": "3.0.0-beta.30",
|
|
4
4
|
"description": "@eggjs/errors provide two kinds of errors that is Error and Exception.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"exports": {
|
|
@@ -29,12 +29,12 @@
|
|
|
29
29
|
},
|
|
30
30
|
"dependencies": {},
|
|
31
31
|
"devDependencies": {
|
|
32
|
-
"@types/node": "^24.
|
|
33
|
-
"oxlint": "^1.
|
|
34
|
-
"tsdown": "0.15.
|
|
32
|
+
"@types/node": "^24.9.1",
|
|
33
|
+
"oxlint": "^1.24.0",
|
|
34
|
+
"tsdown": "0.15.9",
|
|
35
35
|
"typescript": "^5.9.3",
|
|
36
|
-
"vitest": "4.0.
|
|
37
|
-
"@eggjs/tsconfig": "3.1.0-beta.
|
|
36
|
+
"vitest": "4.0.1",
|
|
37
|
+
"@eggjs/tsconfig": "3.1.0-beta.30"
|
|
38
38
|
},
|
|
39
39
|
"main": "./dist/index.js",
|
|
40
40
|
"module": "./dist/index.js",
|