@eggjs/core 6.4.1 → 6.6.0-beta.10

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.
Files changed (87) hide show
  1. package/README.md +23 -27
  2. package/dist/base_context_class.d.ts +21 -0
  3. package/dist/base_context_class.js +40 -0
  4. package/dist/egg.d.ts +248 -0
  5. package/dist/egg.js +358 -0
  6. package/dist/index.d.ts +12 -0
  7. package/dist/index.js +12 -0
  8. package/dist/lifecycle.d.ts +84 -0
  9. package/dist/lifecycle.js +280 -0
  10. package/dist/loader/context_loader.d.ts +39 -0
  11. package/dist/loader/context_loader.js +79 -0
  12. package/dist/loader/egg_loader.d.ts +374 -0
  13. package/dist/loader/egg_loader.js +1184 -0
  14. package/dist/loader/file_loader.d.ts +105 -0
  15. package/dist/loader/file_loader.js +198 -0
  16. package/dist/singleton.d.ts +33 -0
  17. package/dist/singleton.js +107 -0
  18. package/{src/types.ts → dist/types.d.ts} +7 -7
  19. package/dist/utils/index.d.ts +19 -0
  20. package/dist/utils/index.js +103 -0
  21. package/dist/utils/sequencify.d.ts +16 -0
  22. package/dist/utils/sequencify.js +46 -0
  23. package/dist/utils/timing.d.ts +24 -0
  24. package/dist/utils/timing.js +85 -0
  25. package/package.json +39 -65
  26. package/dist/commonjs/base_context_class.d.ts +0 -16
  27. package/dist/commonjs/base_context_class.js +0 -41
  28. package/dist/commonjs/egg.d.ts +0 -247
  29. package/dist/commonjs/egg.js +0 -401
  30. package/dist/commonjs/index.d.ts +0 -12
  31. package/dist/commonjs/index.js +0 -32
  32. package/dist/commonjs/lifecycle.d.ts +0 -78
  33. package/dist/commonjs/lifecycle.js +0 -312
  34. package/dist/commonjs/loader/context_loader.d.ts +0 -35
  35. package/dist/commonjs/loader/context_loader.js +0 -110
  36. package/dist/commonjs/loader/egg_loader.d.ts +0 -369
  37. package/dist/commonjs/loader/egg_loader.js +0 -1543
  38. package/dist/commonjs/loader/file_loader.d.ts +0 -100
  39. package/dist/commonjs/loader/file_loader.js +0 -262
  40. package/dist/commonjs/package.json +0 -3
  41. package/dist/commonjs/singleton.d.ts +0 -29
  42. package/dist/commonjs/singleton.js +0 -125
  43. package/dist/commonjs/types.d.ts +0 -53
  44. package/dist/commonjs/types.js +0 -3
  45. package/dist/commonjs/utils/index.d.ts +0 -17
  46. package/dist/commonjs/utils/index.js +0 -117
  47. package/dist/commonjs/utils/sequencify.d.ts +0 -13
  48. package/dist/commonjs/utils/sequencify.js +0 -59
  49. package/dist/commonjs/utils/timing.d.ts +0 -21
  50. package/dist/commonjs/utils/timing.js +0 -100
  51. package/dist/esm/base_context_class.d.ts +0 -16
  52. package/dist/esm/base_context_class.js +0 -37
  53. package/dist/esm/egg.d.ts +0 -247
  54. package/dist/esm/egg.js +0 -388
  55. package/dist/esm/index.d.ts +0 -12
  56. package/dist/esm/index.js +0 -12
  57. package/dist/esm/lifecycle.d.ts +0 -78
  58. package/dist/esm/lifecycle.js +0 -305
  59. package/dist/esm/loader/context_loader.d.ts +0 -35
  60. package/dist/esm/loader/context_loader.js +0 -102
  61. package/dist/esm/loader/egg_loader.d.ts +0 -369
  62. package/dist/esm/loader/egg_loader.js +0 -1536
  63. package/dist/esm/loader/file_loader.d.ts +0 -100
  64. package/dist/esm/loader/file_loader.js +0 -255
  65. package/dist/esm/package.json +0 -3
  66. package/dist/esm/singleton.d.ts +0 -29
  67. package/dist/esm/singleton.js +0 -118
  68. package/dist/esm/types.d.ts +0 -53
  69. package/dist/esm/types.js +0 -2
  70. package/dist/esm/utils/index.d.ts +0 -17
  71. package/dist/esm/utils/index.js +0 -112
  72. package/dist/esm/utils/sequencify.d.ts +0 -13
  73. package/dist/esm/utils/sequencify.js +0 -56
  74. package/dist/esm/utils/timing.d.ts +0 -21
  75. package/dist/esm/utils/timing.js +0 -93
  76. package/dist/package.json +0 -4
  77. package/src/base_context_class.ts +0 -39
  78. package/src/egg.ts +0 -517
  79. package/src/index.ts +0 -14
  80. package/src/lifecycle.ts +0 -399
  81. package/src/loader/context_loader.ts +0 -121
  82. package/src/loader/egg_loader.ts +0 -1722
  83. package/src/loader/file_loader.ts +0 -308
  84. package/src/singleton.ts +0 -149
  85. package/src/utils/index.ts +0 -125
  86. package/src/utils/sequencify.ts +0 -70
  87. package/src/utils/timing.ts +0 -114
@@ -1,117 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- const node_util_1 = require("node:util");
7
- const node_path_1 = __importDefault(require("node:path"));
8
- const node_fs_1 = __importDefault(require("node:fs"));
9
- const promises_1 = require("node:fs/promises");
10
- const node_module_1 = __importDefault(require("node:module"));
11
- const utils_1 = require("@eggjs/utils");
12
- const debug = (0, node_util_1.debuglog)('@eggjs/core/utils');
13
- // Guard against poorly mocked module constructors.
14
- const Module = typeof module !== 'undefined' && module.constructor.length > 1
15
- ? module.constructor
16
- /* istanbul ignore next */
17
- : node_module_1.default;
18
- const extensions = Module._extensions;
19
- const extensionNames = Object.keys(extensions).concat(['.cjs', '.mjs']);
20
- debug('Module extensions: %j', extensionNames);
21
- function getCalleeFromStack(withLine, stackIndex) {
22
- stackIndex = stackIndex === undefined ? 2 : stackIndex;
23
- const limit = Error.stackTraceLimit;
24
- const prep = Error.prepareStackTrace;
25
- Error.prepareStackTrace = prepareObjectStackTrace;
26
- Error.stackTraceLimit = 5;
27
- // capture the stack
28
- const obj = {};
29
- Error.captureStackTrace(obj);
30
- let callSite = obj.stack[stackIndex];
31
- let fileName = '';
32
- if (callSite) {
33
- // egg-mock will create a proxy
34
- // https://github.com/eggjs/egg-mock/blob/master/lib/app.js#L174
35
- fileName = callSite.getFileName();
36
- /* istanbul ignore if */
37
- if (fileName && fileName.endsWith('egg-mock/lib/app.js')) {
38
- // TODO: add test
39
- callSite = obj.stack[stackIndex + 1];
40
- fileName = callSite.getFileName();
41
- }
42
- }
43
- Error.prepareStackTrace = prep;
44
- Error.stackTraceLimit = limit;
45
- if (!callSite || !fileName)
46
- return '<anonymous>';
47
- if (!withLine)
48
- return fileName;
49
- return `${fileName}:${callSite.getLineNumber()}:${callSite.getColumnNumber()}`;
50
- }
51
- exports.default = {
52
- deprecated(message) {
53
- if (debug.enabled) {
54
- console.trace('[@eggjs/core/deprecated] %s', message);
55
- }
56
- else {
57
- console.log('[@eggjs/core/deprecated] %s', message);
58
- console.log('[@eggjs/core/deprecated] set NODE_DEBUG=@eggjs/core/utils can show call stack');
59
- }
60
- },
61
- extensions,
62
- extensionNames,
63
- async existsPath(filepath) {
64
- try {
65
- await (0, promises_1.stat)(filepath);
66
- return true;
67
- }
68
- catch {
69
- return false;
70
- }
71
- },
72
- async loadFile(filepath) {
73
- try {
74
- // if not js module, just return content buffer
75
- const extname = node_path_1.default.extname(filepath);
76
- if (extname && !extensionNames.includes(extname) && extname !== '.ts') {
77
- return node_fs_1.default.readFileSync(filepath);
78
- }
79
- const obj = await (0, utils_1.importModule)(filepath, { importDefaultOnly: true });
80
- return obj;
81
- }
82
- catch (e) {
83
- if (!e.message && typeof e !== 'string') {
84
- // ts error: test/fixtures/apps/app-ts/app/extend/context.ts(5,17): error TS2339: Property 'url' does not exist on type 'Context'
85
- console.trace(e);
86
- throw e;
87
- }
88
- const err = new Error(`[@eggjs/core] load file: ${filepath}, error: ${e.message}`);
89
- err.cause = e;
90
- debug('[loadFile] handle %s error: %s', filepath, e);
91
- throw err;
92
- }
93
- },
94
- resolvePath(filepath, options) {
95
- return (0, utils_1.importResolve)(filepath, options);
96
- },
97
- methods: ['head', 'options', 'get', 'put', 'patch', 'post', 'delete'],
98
- async callFn(fn, args, ctx) {
99
- args = args || [];
100
- if (typeof fn !== 'function')
101
- return;
102
- return ctx ? fn.call(ctx, ...args) : fn(...args);
103
- },
104
- getCalleeFromStack,
105
- getResolvedFilename(filepath, baseDir) {
106
- const reg = /[/\\]/g;
107
- return filepath.replace(baseDir + node_path_1.default.sep, '').replace(reg, '/');
108
- },
109
- };
110
- /**
111
- * Capture call site stack from v8.
112
- * https://github.com/v8/v8/wiki/Stack-Trace-API
113
- */
114
- function prepareObjectStackTrace(_obj, stack) {
115
- return stack;
116
- }
117
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvdXRpbHMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSx5Q0FBcUM7QUFDckMsMERBQTZCO0FBQzdCLHNEQUF5QjtBQUN6QiwrQ0FBd0M7QUFDeEMsOERBQXdDO0FBQ3hDLHdDQUEyRDtBQUUzRCxNQUFNLEtBQUssR0FBRyxJQUFBLG9CQUFRLEVBQUMsbUJBQW1CLENBQUMsQ0FBQztBQUk1QyxtREFBbUQ7QUFDbkQsTUFBTSxNQUFNLEdBQUcsT0FBTyxNQUFNLEtBQUssV0FBVyxJQUFJLE1BQU0sQ0FBQyxXQUFXLENBQUMsTUFBTSxHQUFHLENBQUM7SUFDM0UsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxXQUFXO0lBQ3BCLDBCQUEwQjtJQUMxQixDQUFDLENBQUMscUJBQWEsQ0FBQztBQUVsQixNQUFNLFVBQVUsR0FBSSxNQUFjLENBQUMsV0FBVyxDQUFDO0FBQy9DLE1BQU0sY0FBYyxHQUFHLE1BQU0sQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUMsTUFBTSxDQUFDLENBQUUsTUFBTSxFQUFFLE1BQU0sQ0FBRSxDQUFDLENBQUM7QUFDMUUsS0FBSyxDQUFDLHVCQUF1QixFQUFFLGNBQWMsQ0FBQyxDQUFDO0FBRS9DLFNBQVMsa0JBQWtCLENBQUMsUUFBa0IsRUFBRSxVQUFtQjtJQUNqRSxVQUFVLEdBQUcsVUFBVSxLQUFLLFNBQVMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxVQUFVLENBQUM7SUFDdkQsTUFBTSxLQUFLLEdBQUcsS0FBSyxDQUFDLGVBQWUsQ0FBQztJQUNwQyxNQUFNLElBQUksR0FBRyxLQUFLLENBQUMsaUJBQWlCLENBQUM7SUFFckMsS0FBSyxDQUFDLGlCQUFpQixHQUFHLHVCQUF1QixDQUFDO0lBQ2xELEtBQUssQ0FBQyxlQUFlLEdBQUcsQ0FBQyxDQUFDO0lBRTFCLG9CQUFvQjtJQUNwQixNQUFNLEdBQUcsR0FBUSxFQUFFLENBQUM7SUFDcEIsS0FBSyxDQUFDLGlCQUFpQixDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQzdCLElBQUksUUFBUSxHQUFHLEdBQUcsQ0FBQyxLQUFLLENBQUMsVUFBVSxDQUFDLENBQUM7SUFDckMsSUFBSSxRQUFRLEdBQUcsRUFBRSxDQUFDO0lBQ2xCLElBQUksUUFBUSxFQUFFLENBQUM7UUFDYiwrQkFBK0I7UUFDL0IsZ0VBQWdFO1FBQ2hFLFFBQVEsR0FBRyxRQUFRLENBQUMsV0FBVyxFQUFFLENBQUM7UUFDbEMsd0JBQXdCO1FBQ3hCLElBQUksUUFBUSxJQUFJLFFBQVEsQ0FBQyxRQUFRLENBQUMscUJBQXFCLENBQUMsRUFBRSxDQUFDO1lBQ3pELGlCQUFpQjtZQUNqQixRQUFRLEdBQUcsR0FBRyxDQUFDLEtBQUssQ0FBQyxVQUFVLEdBQUcsQ0FBQyxDQUFDLENBQUM7WUFDckMsUUFBUSxHQUFHLFFBQVEsQ0FBQyxXQUFXLEVBQUUsQ0FBQztRQUNwQyxDQUFDO0lBQ0gsQ0FBQztJQUVELEtBQUssQ0FBQyxpQkFBaUIsR0FBRyxJQUFJLENBQUM7SUFDL0IsS0FBSyxDQUFDLGVBQWUsR0FBRyxLQUFLLENBQUM7SUFFOUIsSUFBSSxDQUFDLFFBQVEsSUFBSSxDQUFDLFFBQVE7UUFBRSxPQUFPLGFBQWEsQ0FBQztJQUNqRCxJQUFJLENBQUMsUUFBUTtRQUFFLE9BQU8sUUFBUSxDQUFDO0lBQy9CLE9BQU8sR0FBRyxRQUFRLElBQUksUUFBUSxDQUFDLGFBQWEsRUFBRSxJQUFJLFFBQVEsQ0FBQyxlQUFlLEVBQUUsRUFBRSxDQUFDO0FBQ2pGLENBQUM7QUFFRCxrQkFBZTtJQUNiLFVBQVUsQ0FBQyxPQUFlO1FBQ3hCLElBQUksS0FBSyxDQUFDLE9BQU8sRUFBRSxDQUFDO1lBQ2xCLE9BQU8sQ0FBQyxLQUFLLENBQUMsNkJBQTZCLEVBQUUsT0FBTyxDQUFDLENBQUM7UUFDeEQsQ0FBQzthQUFNLENBQUM7WUFDTixPQUFPLENBQUMsR0FBRyxDQUFDLDZCQUE2QixFQUFFLE9BQU8sQ0FBQyxDQUFDO1lBQ3BELE9BQU8sQ0FBQyxHQUFHLENBQUMsK0VBQStFLENBQUMsQ0FBQztRQUMvRixDQUFDO0lBQ0gsQ0FBQztJQUVELFVBQVU7SUFDVixjQUFjO0lBRWQsS0FBSyxDQUFDLFVBQVUsQ0FBQyxRQUFnQjtRQUMvQixJQUFJLENBQUM7WUFDSCxNQUFNLElBQUEsZUFBSSxFQUFDLFFBQVEsQ0FBQyxDQUFDO1lBQ3JCLE9BQU8sSUFBSSxDQUFDO1FBQ2QsQ0FBQztRQUFDLE1BQU0sQ0FBQztZQUNQLE9BQU8sS0FBSyxDQUFDO1FBQ2YsQ0FBQztJQUNILENBQUM7SUFFRCxLQUFLLENBQUMsUUFBUSxDQUFDLFFBQWdCO1FBQzdCLElBQUksQ0FBQztZQUNILCtDQUErQztZQUMvQyxNQUFNLE9BQU8sR0FBRyxtQkFBSSxDQUFDLE9BQU8sQ0FBQyxRQUFRLENBQUMsQ0FBQztZQUN2QyxJQUFJLE9BQU8sSUFBSSxDQUFDLGNBQWMsQ0FBQyxRQUFRLENBQUMsT0FBTyxDQUFDLElBQUksT0FBTyxLQUFLLEtBQUssRUFBRSxDQUFDO2dCQUN0RSxPQUFPLGlCQUFFLENBQUMsWUFBWSxDQUFDLFFBQVEsQ0FBQyxDQUFDO1lBQ25DLENBQUM7WUFDRCxNQUFNLEdBQUcsR0FBRyxNQUFNLElBQUEsb0JBQVksRUFBQyxRQUFRLEVBQUUsRUFBRSxpQkFBaUIsRUFBRSxJQUFJLEVBQUUsQ0FBQyxDQUFDO1lBQ3RFLE9BQU8sR0FBRyxDQUFDO1FBQ2IsQ0FBQztRQUFDLE9BQU8sQ0FBTSxFQUFFLENBQUM7WUFDaEIsSUFBSSxDQUFDLENBQUMsQ0FBQyxPQUFPLElBQUksT0FBTyxDQUFDLEtBQUssUUFBUSxFQUFFLENBQUM7Z0JBQ3hDLGlJQUFpSTtnQkFDakksT0FBTyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQztnQkFDakIsTUFBTSxDQUFDLENBQUM7WUFDVixDQUFDO1lBQ0QsTUFBTSxHQUFHLEdBQUcsSUFBSSxLQUFLLENBQUMsNEJBQTRCLFFBQVEsWUFBWSxDQUFDLENBQUMsT0FBTyxFQUFFLENBQUMsQ0FBQztZQUNuRixHQUFHLENBQUMsS0FBSyxHQUFHLENBQUMsQ0FBQztZQUNkLEtBQUssQ0FBQyxnQ0FBZ0MsRUFBRSxRQUFRLEVBQUUsQ0FBQyxDQUFDLENBQUM7WUFDckQsTUFBTSxHQUFHLENBQUM7UUFDWixDQUFDO0lBQ0gsQ0FBQztJQUVELFdBQVcsQ0FBQyxRQUFnQixFQUFFLE9BQThCO1FBQzFELE9BQU8sSUFBQSxxQkFBYSxFQUFDLFFBQVEsRUFBRSxPQUFPLENBQUMsQ0FBQztJQUMxQyxDQUFDO0lBRUQsT0FBTyxFQUFFLENBQUUsTUFBTSxFQUFFLFNBQVMsRUFBRSxLQUFLLEVBQUUsS0FBSyxFQUFFLE9BQU8sRUFBRSxNQUFNLEVBQUUsUUFBUSxDQUFFO0lBRXZFLEtBQUssQ0FBQyxNQUFNLENBQUMsRUFBTyxFQUFFLElBQVksRUFBRSxHQUFTO1FBQzNDLElBQUksR0FBRyxJQUFJLElBQUksRUFBRSxDQUFDO1FBQ2xCLElBQUksT0FBTyxFQUFFLEtBQUssVUFBVTtZQUFFLE9BQU87UUFDckMsT0FBTyxHQUFHLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLEdBQUcsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxHQUFHLElBQUksQ0FBQyxDQUFDO0lBQ25ELENBQUM7SUFFRCxrQkFBa0I7SUFFbEIsbUJBQW1CLENBQUMsUUFBZ0IsRUFBRSxPQUFlO1FBQ25ELE1BQU0sR0FBRyxHQUFHLFFBQVEsQ0FBQztRQUNyQixPQUFPLFFBQVEsQ0FBQyxPQUFPLENBQUMsT0FBTyxHQUFHLG1CQUFJLENBQUMsR0FBRyxFQUFFLEVBQUUsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsR0FBRyxDQUFDLENBQUM7SUFDcEUsQ0FBQztDQUNGLENBQUM7QUFFRjs7O0dBR0c7QUFDSCxTQUFTLHVCQUF1QixDQUFDLElBQVMsRUFBRSxLQUFVO0lBQ3BELE9BQU8sS0FBSyxDQUFDO0FBQ2YsQ0FBQyJ9
@@ -1,13 +0,0 @@
1
- export interface SequencifyResult {
2
- sequence: string[];
3
- requires: Record<string, true>;
4
- }
5
- export interface SequencifyTask {
6
- dependencies: string[];
7
- optionalDependencies: string[];
8
- }
9
- export default function sequencify(tasks: Record<string, SequencifyTask>, names: string[]): {
10
- sequence: string[];
11
- missingTasks: string[];
12
- recursiveDependencies: string[];
13
- };
@@ -1,59 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.default = sequencify;
4
- const node_util_1 = require("node:util");
5
- const debug = (0, node_util_1.debuglog)('@eggjs/core/utils/sequencify');
6
- function sequence(tasks, names, result, missing, recursive, nest, optional, parent) {
7
- names.forEach(function (name) {
8
- if (result.requires[name])
9
- return;
10
- const node = tasks[name];
11
- if (!node) {
12
- if (optional === true)
13
- return;
14
- missing.push(name);
15
- }
16
- else if (nest.includes(name)) {
17
- nest.push(name);
18
- recursive.push(...nest.slice(0));
19
- nest.pop();
20
- }
21
- else if (node.dependencies.length || node.optionalDependencies.length) {
22
- nest.push(name);
23
- if (node.dependencies.length) {
24
- sequence(tasks, node.dependencies, result, missing, recursive, nest, optional, name);
25
- }
26
- if (node.optionalDependencies.length) {
27
- sequence(tasks, node.optionalDependencies, result, missing, recursive, nest, true, name);
28
- }
29
- nest.pop();
30
- }
31
- if (!optional) {
32
- result.requires[name] = true;
33
- debug('task: %s is enabled by %s', name, parent);
34
- }
35
- if (!result.sequence.includes(name)) {
36
- result.sequence.push(name);
37
- }
38
- });
39
- }
40
- // tasks: object with keys as task names
41
- // names: array of task names
42
- function sequencify(tasks, names) {
43
- const result = {
44
- sequence: [],
45
- requires: {},
46
- }; // the final sequence
47
- const missing = []; // missing tasks
48
- const recursive = []; // recursive task dependencies
49
- sequence(tasks, names, result, missing, recursive, [], false, 'app');
50
- if (missing.length || recursive.length) {
51
- result.sequence = []; // results are incomplete at best, completely wrong at worst, remove them to avoid confusion
52
- }
53
- return {
54
- sequence: result.sequence.filter(item => result.requires[item]),
55
- missingTasks: missing,
56
- recursiveDependencies: recursive,
57
- };
58
- }
59
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VxdWVuY2lmeS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy91dGlscy9zZXF1ZW5jaWZ5LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBa0RBLDZCQW1CQztBQXJFRCx5Q0FBcUM7QUFFckMsTUFBTSxLQUFLLEdBQUcsSUFBQSxvQkFBUSxFQUFDLDhCQUE4QixDQUFDLENBQUM7QUFZdkQsU0FBUyxRQUFRLENBQUMsS0FBcUMsRUFBRSxLQUFlLEVBQUUsTUFBd0IsRUFDaEcsT0FBaUIsRUFBRSxTQUFtQixFQUN0QyxJQUFjLEVBQUUsUUFBaUIsRUFBRSxNQUFjO0lBQ2pELEtBQUssQ0FBQyxPQUFPLENBQUMsVUFBUyxJQUFJO1FBQ3pCLElBQUksTUFBTSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUM7WUFBRSxPQUFPO1FBRWxDLE1BQU0sSUFBSSxHQUFHLEtBQUssQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUN6QixJQUFJLENBQUMsSUFBSSxFQUFFLENBQUM7WUFDVixJQUFJLFFBQVEsS0FBSyxJQUFJO2dCQUFFLE9BQU87WUFDOUIsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUNyQixDQUFDO2FBQU0sSUFBSSxJQUFJLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUM7WUFDL0IsSUFBSSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztZQUNoQixTQUFTLENBQUMsSUFBSSxDQUFDLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO1lBQ2pDLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBQztRQUNiLENBQUM7YUFBTSxJQUFJLElBQUksQ0FBQyxZQUFZLENBQUMsTUFBTSxJQUFJLElBQUksQ0FBQyxvQkFBb0IsQ0FBQyxNQUFNLEVBQUUsQ0FBQztZQUN4RSxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO1lBQ2hCLElBQUksSUFBSSxDQUFDLFlBQVksQ0FBQyxNQUFNLEVBQUUsQ0FBQztnQkFDN0IsUUFBUSxDQUFDLEtBQUssRUFBRSxJQUFJLENBQUMsWUFBWSxFQUFFLE1BQU0sRUFBRSxPQUFPLEVBQUUsU0FBUyxFQUFFLElBQUksRUFBRSxRQUFRLEVBQUUsSUFBSSxDQUFDLENBQUM7WUFDdkYsQ0FBQztZQUNELElBQUksSUFBSSxDQUFDLG9CQUFvQixDQUFDLE1BQU0sRUFBRSxDQUFDO2dCQUNyQyxRQUFRLENBQUMsS0FBSyxFQUFFLElBQUksQ0FBQyxvQkFBb0IsRUFBRSxNQUFNLEVBQUUsT0FBTyxFQUFFLFNBQVMsRUFBRSxJQUFJLEVBQUUsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFDO1lBQzNGLENBQUM7WUFDRCxJQUFJLENBQUMsR0FBRyxFQUFFLENBQUM7UUFDYixDQUFDO1FBQ0QsSUFBSSxDQUFDLFFBQVEsRUFBRSxDQUFDO1lBQ2QsTUFBTSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsR0FBRyxJQUFJLENBQUM7WUFDN0IsS0FBSyxDQUFDLDJCQUEyQixFQUFFLElBQUksRUFBRSxNQUFNLENBQUMsQ0FBQztRQUNuRCxDQUFDO1FBQ0QsSUFBSSxDQUFDLE1BQU0sQ0FBQyxRQUFRLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUM7WUFDcEMsTUFBTSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDN0IsQ0FBQztJQUNILENBQUMsQ0FBQyxDQUFDO0FBQ0wsQ0FBQztBQUVELHdDQUF3QztBQUN4Qyw2QkFBNkI7QUFDN0IsU0FBd0IsVUFBVSxDQUFDLEtBQXFDLEVBQUUsS0FBZTtJQUN2RixNQUFNLE1BQU0sR0FBcUI7UUFDL0IsUUFBUSxFQUFFLEVBQUU7UUFDWixRQUFRLEVBQUUsRUFBRTtLQUNiLENBQUMsQ0FBQyxxQkFBcUI7SUFDeEIsTUFBTSxPQUFPLEdBQWEsRUFBRSxDQUFDLENBQUMsZ0JBQWdCO0lBQzlDLE1BQU0sU0FBUyxHQUFhLEVBQUUsQ0FBQyxDQUFDLDhCQUE4QjtJQUU5RCxRQUFRLENBQUMsS0FBSyxFQUFFLEtBQUssRUFBRSxNQUFNLEVBQUUsT0FBTyxFQUFFLFNBQVMsRUFBRSxFQUFFLEVBQUUsS0FBSyxFQUFFLEtBQUssQ0FBQyxDQUFDO0lBRXJFLElBQUksT0FBTyxDQUFDLE1BQU0sSUFBSSxTQUFTLENBQUMsTUFBTSxFQUFFLENBQUM7UUFDdkMsTUFBTSxDQUFDLFFBQVEsR0FBRyxFQUFFLENBQUMsQ0FBQyw0RkFBNEY7SUFDcEgsQ0FBQztJQUVELE9BQU87UUFDTCxRQUFRLEVBQUUsTUFBTSxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxNQUFNLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQy9ELFlBQVksRUFBRSxPQUFPO1FBQ3JCLHFCQUFxQixFQUFFLFNBQVM7S0FDakMsQ0FBQztBQUNKLENBQUMifQ==
@@ -1,21 +0,0 @@
1
- export interface TimingItem {
2
- name: string;
3
- start: number;
4
- end?: number;
5
- duration?: number;
6
- pid: number;
7
- index: number;
8
- }
9
- export declare class Timing {
10
- #private;
11
- constructor();
12
- init(): void;
13
- start(name?: string, start?: number): TimingItem | undefined;
14
- end(name?: string): TimingItem | undefined;
15
- enable(): void;
16
- disable(): void;
17
- clear(): void;
18
- toJSON(): TimingItem[];
19
- itemToString(timelineEnd: number, item: TimingItem, times: number): string;
20
- toString(prefix?: string, width?: number): string;
21
- }
@@ -1,100 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.Timing = void 0;
7
- const node_os_1 = require("node:os");
8
- const node_util_1 = require("node:util");
9
- const node_assert_1 = __importDefault(require("node:assert"));
10
- const debug = (0, node_util_1.debuglog)('@eggjs/core/utils/timing');
11
- class Timing {
12
- #enable;
13
- #startTime;
14
- #map;
15
- #list;
16
- constructor() {
17
- this.#enable = true;
18
- this.#startTime = null;
19
- this.#map = new Map();
20
- this.#list = [];
21
- this.init();
22
- }
23
- init() {
24
- // process start time
25
- this.start('Process Start', Date.now() - Math.floor(process.uptime() * 1000));
26
- this.end('Process Start');
27
- if ('scriptStartTime' in process && typeof process.scriptStartTime === 'number') {
28
- // js script start execute time
29
- this.start('Script Start', process.scriptStartTime);
30
- this.end('Script Start');
31
- }
32
- }
33
- start(name, start) {
34
- if (!name || !this.#enable)
35
- return;
36
- if (this.#map.has(name)) {
37
- this.end(name);
38
- }
39
- start = start || Date.now();
40
- if (this.#startTime === null) {
41
- this.#startTime = start;
42
- }
43
- const item = {
44
- name,
45
- start,
46
- pid: process.pid,
47
- index: this.#list.length,
48
- };
49
- this.#map.set(name, item);
50
- this.#list.push(item);
51
- debug('start %j', item);
52
- return item;
53
- }
54
- end(name) {
55
- if (!name || !this.#enable)
56
- return;
57
- (0, node_assert_1.default)(this.#map.has(name), `should run timing.start('${name}') first`);
58
- const item = this.#map.get(name);
59
- item.end = Date.now();
60
- item.duration = item.end - item.start;
61
- debug('end %j', item);
62
- return item;
63
- }
64
- enable() {
65
- this.#enable = true;
66
- }
67
- disable() {
68
- this.#enable = false;
69
- }
70
- clear() {
71
- this.#map.clear();
72
- this.#list = [];
73
- }
74
- toJSON() {
75
- return this.#list;
76
- }
77
- itemToString(timelineEnd, item, times) {
78
- const isEnd = typeof item.duration === 'number';
79
- const duration = isEnd ? item.duration : timelineEnd - item.start;
80
- const offset = item.start - this.#startTime;
81
- const status = `${duration}ms${isEnd ? '' : ' NOT_END'}`;
82
- const timespan = Math.floor(Number((offset * times).toFixed(6)));
83
- let timeline = Math.floor(Number((duration * times).toFixed(6)));
84
- timeline = timeline > 0 ? timeline : 1; // make sure there is at least one unit
85
- const message = `#${item.index} ${item.name}`;
86
- return ' '.repeat(timespan) + '▇'.repeat(timeline) + ` [${status}] - ${message}`;
87
- }
88
- toString(prefix = 'egg start timeline:', width = 50) {
89
- const timelineEnd = Date.now();
90
- const timelineDuration = timelineEnd - this.#startTime;
91
- let times = 1;
92
- if (timelineDuration > width) {
93
- times = width / timelineDuration;
94
- }
95
- // follow https://github.com/node-modules/time-profile/blob/master/lib/profiler.js#L88
96
- return prefix + node_os_1.EOL + this.#list.map(item => this.itemToString(timelineEnd, item, times)).join(node_os_1.EOL);
97
- }
98
- }
99
- exports.Timing = Timing;
100
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGltaW5nLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3V0aWxzL3RpbWluZy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7QUFBQSxxQ0FBOEI7QUFDOUIseUNBQXFDO0FBQ3JDLDhEQUFpQztBQUVqQyxNQUFNLEtBQUssR0FBRyxJQUFBLG9CQUFRLEVBQUMsMEJBQTBCLENBQUMsQ0FBQztBQVduRCxNQUFhLE1BQU07SUFDakIsT0FBTyxDQUFVO0lBQ2pCLFVBQVUsQ0FBZ0I7SUFDMUIsSUFBSSxDQUEwQjtJQUM5QixLQUFLLENBQWU7SUFDcEI7UUFDRSxJQUFJLENBQUMsT0FBTyxHQUFHLElBQUksQ0FBQztRQUNwQixJQUFJLENBQUMsVUFBVSxHQUFHLElBQUksQ0FBQztRQUN2QixJQUFJLENBQUMsSUFBSSxHQUFHLElBQUksR0FBRyxFQUFFLENBQUM7UUFDdEIsSUFBSSxDQUFDLEtBQUssR0FBRyxFQUFFLENBQUM7UUFDaEIsSUFBSSxDQUFDLElBQUksRUFBRSxDQUFDO0lBQ2QsQ0FBQztJQUVELElBQUk7UUFDRixxQkFBcUI7UUFDckIsSUFBSSxDQUFDLEtBQUssQ0FBQyxlQUFlLEVBQUUsSUFBSSxDQUFDLEdBQUcsRUFBRSxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLE1BQU0sRUFBRSxHQUFHLElBQUksQ0FBQyxDQUFDLENBQUM7UUFDOUUsSUFBSSxDQUFDLEdBQUcsQ0FBQyxlQUFlLENBQUMsQ0FBQztRQUUxQixJQUFJLGlCQUFpQixJQUFJLE9BQU8sSUFBSSxPQUFPLE9BQU8sQ0FBQyxlQUFlLEtBQUssUUFBUSxFQUFFLENBQUM7WUFDaEYsK0JBQStCO1lBQy9CLElBQUksQ0FBQyxLQUFLLENBQUMsY0FBYyxFQUFFLE9BQU8sQ0FBQyxlQUFlLENBQUMsQ0FBQztZQUNwRCxJQUFJLENBQUMsR0FBRyxDQUFDLGNBQWMsQ0FBQyxDQUFDO1FBQzNCLENBQUM7SUFDSCxDQUFDO0lBRUQsS0FBSyxDQUFDLElBQWEsRUFBRSxLQUFjO1FBQ2pDLElBQUksQ0FBQyxJQUFJLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTztZQUFFLE9BQU87UUFFbkMsSUFBSSxJQUFJLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDO1lBQ3hCLElBQUksQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDakIsQ0FBQztRQUVELEtBQUssR0FBRyxLQUFLLElBQUksSUFBSSxDQUFDLEdBQUcsRUFBRSxDQUFDO1FBQzVCLElBQUksSUFBSSxDQUFDLFVBQVUsS0FBSyxJQUFJLEVBQUUsQ0FBQztZQUM3QixJQUFJLENBQUMsVUFBVSxHQUFHLEtBQUssQ0FBQztRQUMxQixDQUFDO1FBQ0QsTUFBTSxJQUFJLEdBQWU7WUFDdkIsSUFBSTtZQUNKLEtBQUs7WUFDTCxHQUFHLEVBQUUsT0FBTyxDQUFDLEdBQUc7WUFDaEIsS0FBSyxFQUFFLElBQUksQ0FBQyxLQUFLLENBQUMsTUFBTTtTQUN6QixDQUFDO1FBQ0YsSUFBSSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFDO1FBQzFCLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQ3RCLEtBQUssQ0FBQyxVQUFVLEVBQUUsSUFBSSxDQUFDLENBQUM7UUFDeEIsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQsR0FBRyxDQUFDLElBQWE7UUFDZixJQUFJLENBQUMsSUFBSSxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU87WUFBRSxPQUFPO1FBQ25DLElBQUEscUJBQU0sRUFBQyxJQUFJLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsRUFBRSw0QkFBNEIsSUFBSSxVQUFVLENBQUMsQ0FBQztRQUV4RSxNQUFNLElBQUksR0FBRyxJQUFJLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUUsQ0FBQztRQUNsQyxJQUFJLENBQUMsR0FBRyxHQUFHLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBQztRQUN0QixJQUFJLENBQUMsUUFBUSxHQUFHLElBQUksQ0FBQyxHQUFHLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQztRQUN0QyxLQUFLLENBQUMsUUFBUSxFQUFFLElBQUksQ0FBQyxDQUFDO1FBQ3RCLE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVELE1BQU07UUFDSixJQUFJLENBQUMsT0FBTyxHQUFHLElBQUksQ0FBQztJQUN0QixDQUFDO0lBRUQsT0FBTztRQUNMLElBQUksQ0FBQyxPQUFPLEdBQUcsS0FBSyxDQUFDO0lBQ3ZCLENBQUM7SUFFRCxLQUFLO1FBQ0gsSUFBSSxDQUFDLElBQUksQ0FBQyxLQUFLLEVBQUUsQ0FBQztRQUNsQixJQUFJLENBQUMsS0FBSyxHQUFHLEVBQUUsQ0FBQztJQUNsQixDQUFDO0lBRUQsTUFBTTtRQUNKLE9BQU8sSUFBSSxDQUFDLEtBQUssQ0FBQztJQUNwQixDQUFDO0lBRUQsWUFBWSxDQUFDLFdBQW1CLEVBQUUsSUFBZ0IsRUFBRSxLQUFhO1FBQy9ELE1BQU0sS0FBSyxHQUFHLE9BQU8sSUFBSSxDQUFDLFFBQVEsS0FBSyxRQUFRLENBQUM7UUFDaEQsTUFBTSxRQUFRLEdBQUcsS0FBSyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsUUFBUyxDQUFDLENBQUMsQ0FBQyxXQUFXLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQztRQUNuRSxNQUFNLE1BQU0sR0FBRyxJQUFJLENBQUMsS0FBSyxHQUFHLElBQUksQ0FBQyxVQUFXLENBQUM7UUFDN0MsTUFBTSxNQUFNLEdBQUcsR0FBRyxRQUFRLEtBQUssS0FBSyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsQ0FBQyxDQUFDLFVBQVUsRUFBRSxDQUFDO1FBQ3pELE1BQU0sUUFBUSxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFDLENBQUMsTUFBTSxHQUFHLEtBQUssQ0FBQyxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFDakUsSUFBSSxRQUFRLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUMsQ0FBQyxRQUFRLEdBQUcsS0FBSyxDQUFDLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUNqRSxRQUFRLEdBQUcsUUFBUSxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUMsUUFBUSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyx1Q0FBdUM7UUFDL0UsTUFBTSxPQUFPLEdBQUcsSUFBSSxJQUFJLENBQUMsS0FBSyxJQUFJLElBQUksQ0FBQyxJQUFJLEVBQUUsQ0FBQztRQUM5QyxPQUFPLEdBQUcsQ0FBQyxNQUFNLENBQUMsUUFBUSxDQUFDLEdBQUcsR0FBRyxDQUFDLE1BQU0sQ0FBQyxRQUFRLENBQUMsR0FBRyxLQUFLLE1BQU0sT0FBTyxPQUFPLEVBQUUsQ0FBQztJQUNuRixDQUFDO0lBRUQsUUFBUSxDQUFDLE1BQU0sR0FBRyxxQkFBcUIsRUFBRSxLQUFLLEdBQUcsRUFBRTtRQUNqRCxNQUFNLFdBQVcsR0FBRyxJQUFJLENBQUMsR0FBRyxFQUFFLENBQUM7UUFDL0IsTUFBTSxnQkFBZ0IsR0FBRyxXQUFXLEdBQUcsSUFBSSxDQUFDLFVBQVcsQ0FBQztRQUN4RCxJQUFJLEtBQUssR0FBRyxDQUFDLENBQUM7UUFDZCxJQUFJLGdCQUFnQixHQUFHLEtBQUssRUFBRSxDQUFDO1lBQzdCLEtBQUssR0FBRyxLQUFLLEdBQUcsZ0JBQWdCLENBQUM7UUFDbkMsQ0FBQztRQUNELHNGQUFzRjtRQUN0RixPQUFPLE1BQU0sR0FBRyxhQUFHLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxJQUFJLENBQUMsWUFBWSxDQUFDLFdBQVcsRUFBRSxJQUFJLEVBQUUsS0FBSyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsYUFBRyxDQUFDLENBQUM7SUFDdEcsQ0FBQztDQUNGO0FBbEdELHdCQWtHQyJ9
@@ -1,16 +0,0 @@
1
- import type { EggCore, Context } from './egg.js';
2
- /**
3
- * BaseContextClass is a base class that can be extended,
4
- * it's instantiated in context level,
5
- * {@link Helper}, {@link Service} is extending it.
6
- */
7
- export declare class BaseContextClass {
8
- ctx: Context;
9
- app: EggCore;
10
- config: Record<string, any>;
11
- service: BaseContextClass;
12
- /**
13
- * @since 1.0.0
14
- */
15
- constructor(ctx: Context);
16
- }
@@ -1,37 +0,0 @@
1
- /**
2
- * BaseContextClass is a base class that can be extended,
3
- * it's instantiated in context level,
4
- * {@link Helper}, {@link Service} is extending it.
5
- */
6
- export class BaseContextClass {
7
- ctx;
8
- app;
9
- config;
10
- service;
11
- /**
12
- * @since 1.0.0
13
- */
14
- constructor(ctx) {
15
- /**
16
- * @member {Context} BaseContextClass#ctx
17
- * @since 1.0.0
18
- */
19
- this.ctx = ctx;
20
- /**
21
- * @member {Application} BaseContextClass#app
22
- * @since 1.0.0
23
- */
24
- this.app = ctx.app;
25
- /**
26
- * @member {Config} BaseContextClass#config
27
- * @since 1.0.0
28
- */
29
- this.config = ctx.app.config;
30
- /**
31
- * @member {Service} BaseContextClass#service
32
- * @since 1.0.0
33
- */
34
- this.service = ctx.service;
35
- }
36
- }
37
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmFzZV9jb250ZXh0X2NsYXNzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2Jhc2VfY29udGV4dF9jbGFzcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFFQTs7OztHQUlHO0FBQ0gsTUFBTSxPQUFPLGdCQUFnQjtJQUMzQixHQUFHLENBQVU7SUFDYixHQUFHLENBQVU7SUFDYixNQUFNLENBQXNCO0lBQzVCLE9BQU8sQ0FBbUI7SUFFMUI7O09BRUc7SUFDSCxZQUFZLEdBQVk7UUFDdEI7OztXQUdHO1FBQ0gsSUFBSSxDQUFDLEdBQUcsR0FBRyxHQUFHLENBQUM7UUFDZjs7O1dBR0c7UUFDSCxJQUFJLENBQUMsR0FBRyxHQUFHLEdBQUcsQ0FBQyxHQUFHLENBQUM7UUFDbkI7OztXQUdHO1FBQ0gsSUFBSSxDQUFDLE1BQU0sR0FBRyxHQUFHLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQztRQUM3Qjs7O1dBR0c7UUFDSCxJQUFJLENBQUMsT0FBTyxHQUFHLEdBQUcsQ0FBQyxPQUFPLENBQUM7SUFDN0IsQ0FBQztDQUNGIn0=
package/dist/esm/egg.d.ts DELETED
@@ -1,247 +0,0 @@
1
- import { Application as KoaApplication, Context as KoaContext, Request as KoaRequest, Response as KoaResponse } from '@eggjs/koa';
2
- import type { MiddlewareFunc as KoaMiddlewareFunc, Next } from '@eggjs/koa';
3
- import { EggConsoleLogger, Logger } from 'egg-logger';
4
- import { RegisterOptions, ResourcesController, EggRouter as Router } from '@eggjs/router';
5
- import type { ReadyFunctionArg } from 'get-ready';
6
- import { BaseContextClass } from './base_context_class.js';
7
- import { Timing } from './utils/timing.js';
8
- import type { Fun } from './utils/index.js';
9
- import { Lifecycle } from './lifecycle.js';
10
- import { EggLoader } from './loader/egg_loader.js';
11
- import { EggAppConfig } from './types.js';
12
- import { type SingletonCreateMethod } from './singleton.js';
13
- export declare const EGG_LOADER: unique symbol;
14
- export interface EggCoreOptions {
15
- baseDir: string;
16
- type: 'application' | 'agent';
17
- plugins?: any;
18
- serverScope?: string;
19
- env?: string;
20
- }
21
- export type EggCoreInitOptions = Partial<EggCoreOptions>;
22
- export { KoaRequest, KoaResponse, KoaContext, KoaApplication, Router, };
23
- export type { Next, KoaMiddlewareFunc, };
24
- export declare class Request extends KoaRequest {
25
- app: EggCore;
26
- response: Response;
27
- }
28
- export declare class Response extends KoaResponse {
29
- app: EggCore;
30
- request: Request;
31
- }
32
- export declare class Context extends KoaContext {
33
- app: EggCore;
34
- request: Request;
35
- response: Response;
36
- service: BaseContextClass;
37
- /**
38
- * Returns map of URL parameters for given `path` and `paramNames`.
39
- * @example
40
- * ##### ctx.params.id {string}
41
- *
42
- * `GET /api/users/1` => `'1'`
43
- *
44
- * ##### ctx.params.per_page {string}
45
- *
46
- * The number of every page, `GET /api/users?per_page=20` => `20`
47
- */
48
- params?: Record<string, string>;
49
- /**
50
- * Returns array of router regexp url path captures.
51
- */
52
- captures?: string[];
53
- /**
54
- * Returns the name of the matched router.
55
- */
56
- routerName?: string;
57
- /**
58
- * Returns the path of the matched router.
59
- */
60
- routerPath?: string | RegExp;
61
- }
62
- export type MiddlewareFunc<T = Context> = KoaMiddlewareFunc<T>;
63
- export declare class EggCore extends KoaApplication {
64
- #private;
65
- options: EggCoreOptions;
66
- timing: Timing;
67
- console: EggConsoleLogger;
68
- BaseContextClass: typeof BaseContextClass;
69
- Controller: typeof BaseContextClass;
70
- Service: typeof BaseContextClass;
71
- Helper?: typeof BaseContextClass;
72
- lifecycle: Lifecycle;
73
- loader: EggLoader;
74
- /** auto inject on loadService() */
75
- readonly serviceClasses: Record<string, any>;
76
- /** auto inject on loadController() */
77
- readonly controller: Record<string, any>;
78
- /** auto inject on loadMiddleware() */
79
- readonly middlewares: Record<string, (opt: any, app: EggCore) => MiddlewareFunc>;
80
- /**
81
- * @class
82
- * @param {Object} options - options
83
- * @param {String} [options.baseDir=process.cwd()] - the directory of application
84
- * @param {String} [options.type=application|agent] - whether it's running in app worker or agent worker
85
- * @param {Object} [options.plugins] - custom plugins
86
- * @since 1.0.0
87
- */
88
- constructor(options?: EggCoreInitOptions);
89
- get logger(): Logger;
90
- get coreLogger(): Logger;
91
- /**
92
- * create a singleton instance
93
- * @param {String} name - unique name for singleton
94
- * @param {Function|AsyncFunction} create - method will be invoked when singleton instance create
95
- */
96
- addSingleton(name: string, create: SingletonCreateMethod): void;
97
- /**
98
- * override koa's app.use, support generator function
99
- * @since 1.0.0
100
- */
101
- use(fn: MiddlewareFunc): this;
102
- /**
103
- * Whether `application` or `agent`
104
- * @member {String}
105
- * @since 1.0.0
106
- */
107
- get type(): "application" | "agent";
108
- /**
109
- * The current directory of application
110
- * @member {String}
111
- * @see {@link AppInfo#baseDir}
112
- * @since 1.0.0
113
- */
114
- get baseDir(): string;
115
- /**
116
- * Alias to {@link https://npmjs.com/package/depd}
117
- * @member {Function}
118
- * @since 1.0.0
119
- */
120
- get deprecate(): (message: string) => void;
121
- /**
122
- * The name of application
123
- * @member {String}
124
- * @see {@link AppInfo#name}
125
- * @since 1.0.0
126
- */
127
- get name(): any;
128
- /**
129
- * Retrieve enabled plugins
130
- * @member {Object}
131
- * @since 1.0.0
132
- */
133
- get plugins(): Record<string, import("./types.js").EggPluginInfo>;
134
- /**
135
- * The configuration of application
136
- * @member {Config}
137
- * @since 1.0.0
138
- */
139
- get config(): EggAppConfig;
140
- /**
141
- * Execute scope after loaded and before app start.
142
- *
143
- * Notice:
144
- * This method is now NOT recommended and regarded as a deprecated one,
145
- * For plugin development, we should use `didLoad` instead.
146
- * For application development, we should use `willReady` instead.
147
- *
148
- * @see https://eggjs.org/en/advanced/loader.html#beforestart
149
- *
150
- * @param {Function} scope function will execute before app start
151
- * @param {string} [name] scope name, default is empty string
152
- */
153
- beforeStart(scope: Fun, name?: string): void;
154
- /**
155
- * register an callback function that will be invoked when application is ready.
156
- * @see https://github.com/node-modules/get-ready
157
- * @since 1.0.0
158
- * @example
159
- * const app = new Application(...);
160
- * app.ready(err => {
161
- * if (err) throw err;
162
- * console.log('done');
163
- * });
164
- */
165
- ready(): Promise<void>;
166
- ready(flagOrFunction: ReadyFunctionArg): void;
167
- /**
168
- * If a client starts asynchronously, you can register `readyCallback`,
169
- * then the application will wait for the callback to ready
170
- *
171
- * It will log when the callback is not invoked after 10s
172
- *
173
- * Recommend to use {@link EggCore#beforeStart}
174
- * @since 1.0.0
175
- *
176
- * @param {String} name - readyCallback task name
177
- * @param {object} opts -
178
- * - {Number} [timeout=10000] - emit `ready_timeout` when it doesn't finish but reach the timeout
179
- * - {Boolean} [isWeakDep=false] - whether it's a weak dependency
180
- * @return {Function} - a callback
181
- * @example
182
- * const done = app.readyCallback('mysql');
183
- * mysql.ready(done);
184
- */
185
- readyCallback(name: string, opts: object): (...args: any[]) => void;
186
- /**
187
- * Register a function that will be called when app close.
188
- *
189
- * Notice:
190
- * This method is now NOT recommended directly used,
191
- * Developers SHOULDN'T use app.beforeClose directly now,
192
- * but in the form of class to implement beforeClose instead.
193
- *
194
- * @see https://eggjs.org/en/advanced/loader.html#beforeclose
195
- *
196
- * @param {Function} fn - the function that can be generator function or async function.
197
- */
198
- beforeClose(fn: Fun, name?: string): void;
199
- /**
200
- * Close all, it will close
201
- * - callbacks registered by beforeClose
202
- * - emit `close` event
203
- * - remove add listeners
204
- *
205
- * If error is thrown when it's closing, the promise will reject.
206
- * It will also reject after following call.
207
- * @return {Promise} promise
208
- * @since 1.0.0
209
- */
210
- close(): Promise<void>;
211
- /**
212
- * get router
213
- * @member {Router} EggCore#router
214
- * @since 1.0.0
215
- */
216
- get router(): Router;
217
- /**
218
- * Alias to {@link Router#url}
219
- * @param {String} name - Router name
220
- * @param {Object} params - more parameters
221
- * @return {String} url
222
- */
223
- url(name: string, params?: any): string;
224
- head(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
225
- head(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
226
- get(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
227
- get(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
228
- put(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
229
- put(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
230
- patch(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
231
- patch(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
232
- post(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
233
- post(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
234
- delete(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
235
- delete(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
236
- del(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
237
- del(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
238
- all(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
239
- all(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
240
- resources(prefix: string, controller: string | ResourcesController): EggCore;
241
- resources(prefix: string, middleware: MiddlewareFunc, controller: string | ResourcesController): EggCore;
242
- resources(name: string, prefix: string, controller: string | ResourcesController): EggCore;
243
- resources(name: string, prefix: string, middleware: MiddlewareFunc, controller: string | ResourcesController): EggCore;
244
- redirect(source: string, destination: string, status?: number): this;
245
- register(path: string | RegExp | (string | RegExp)[], methods: string[], middleware: MiddlewareFunc | MiddlewareFunc[], opts?: RegisterOptions): this;
246
- get [EGG_LOADER](): typeof EggLoader;
247
- }