@eggjs/core 6.0.0-beta.0
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/LICENSE +21 -0
- package/README.md +296 -0
- package/dist/commonjs/base_context_class.d.ts +16 -0
- package/dist/commonjs/base_context_class.js +41 -0
- package/dist/commonjs/egg.d.ts +204 -0
- package/dist/commonjs/egg.js +346 -0
- package/dist/commonjs/index.d.ts +5 -0
- package/dist/commonjs/index.js +26 -0
- package/dist/commonjs/lifecycle.d.ts +75 -0
- package/dist/commonjs/lifecycle.js +306 -0
- package/dist/commonjs/loader/context_loader.d.ts +24 -0
- package/dist/commonjs/loader/context_loader.js +109 -0
- package/dist/commonjs/loader/egg_loader.d.ts +405 -0
- package/dist/commonjs/loader/egg_loader.js +1497 -0
- package/dist/commonjs/loader/file_loader.d.ts +96 -0
- package/dist/commonjs/loader/file_loader.js +248 -0
- package/dist/commonjs/package.json +3 -0
- package/dist/commonjs/types.d.ts +1 -0
- package/dist/commonjs/types.js +403 -0
- package/dist/commonjs/utils/index.d.ts +14 -0
- package/dist/commonjs/utils/index.js +146 -0
- package/dist/commonjs/utils/sequencify.d.ts +13 -0
- package/dist/commonjs/utils/sequencify.js +59 -0
- package/dist/commonjs/utils/timing.d.ts +22 -0
- package/dist/commonjs/utils/timing.js +100 -0
- package/dist/esm/base_context_class.d.ts +16 -0
- package/dist/esm/base_context_class.js +37 -0
- package/dist/esm/egg.d.ts +204 -0
- package/dist/esm/egg.js +339 -0
- package/dist/esm/index.d.ts +5 -0
- package/dist/esm/index.js +6 -0
- package/dist/esm/lifecycle.d.ts +75 -0
- package/dist/esm/lifecycle.js +276 -0
- package/dist/esm/loader/context_loader.d.ts +24 -0
- package/dist/esm/loader/context_loader.js +102 -0
- package/dist/esm/loader/egg_loader.d.ts +405 -0
- package/dist/esm/loader/egg_loader.js +1490 -0
- package/dist/esm/loader/file_loader.d.ts +96 -0
- package/dist/esm/loader/file_loader.js +241 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/types.d.ts +1 -0
- package/dist/esm/types.js +402 -0
- package/dist/esm/utils/index.d.ts +14 -0
- package/dist/esm/utils/index.js +141 -0
- package/dist/esm/utils/sequencify.d.ts +13 -0
- package/dist/esm/utils/sequencify.js +56 -0
- package/dist/esm/utils/timing.d.ts +22 -0
- package/dist/esm/utils/timing.js +93 -0
- package/package.json +103 -0
- package/src/base_context_class.ts +39 -0
- package/src/egg.ts +430 -0
- package/src/index.ts +6 -0
- package/src/lifecycle.ts +363 -0
- package/src/loader/context_loader.ts +121 -0
- package/src/loader/egg_loader.ts +1703 -0
- package/src/loader/file_loader.ts +295 -0
- package/src/types.ts +447 -0
- package/src/utils/index.ts +154 -0
- package/src/utils/sequencify.ts +70 -0
- package/src/utils/timing.ts +114 -0
package/dist/esm/egg.js
ADDED
|
@@ -0,0 +1,339 @@
|
|
|
1
|
+
/* eslint-disable prefer-spread */
|
|
2
|
+
import assert from 'node:assert';
|
|
3
|
+
import { debuglog } from 'node:util';
|
|
4
|
+
import is from 'is-type-of';
|
|
5
|
+
import KoaApplication from '@eggjs/koa';
|
|
6
|
+
import { EggConsoleLogger } from 'egg-logger';
|
|
7
|
+
import { EggRouter as Router } from '@eggjs/router';
|
|
8
|
+
import { BaseContextClass } from './base_context_class.js';
|
|
9
|
+
import { Timing } from './utils/timing.js';
|
|
10
|
+
import { Lifecycle } from './lifecycle.js';
|
|
11
|
+
import { EggLoader } from './loader/egg_loader.js';
|
|
12
|
+
import utils from './utils/index.js';
|
|
13
|
+
const debug = debuglog('@eggjs/core:egg');
|
|
14
|
+
const EGG_LOADER = Symbol.for('egg#loader');
|
|
15
|
+
export class EggCore extends KoaApplication {
|
|
16
|
+
options;
|
|
17
|
+
timing;
|
|
18
|
+
console;
|
|
19
|
+
BaseContextClass;
|
|
20
|
+
Controller;
|
|
21
|
+
Service;
|
|
22
|
+
Helper;
|
|
23
|
+
lifecycle;
|
|
24
|
+
loader;
|
|
25
|
+
#closePromise;
|
|
26
|
+
#router;
|
|
27
|
+
/** auto inject on loadService() */
|
|
28
|
+
serviceClasses = {};
|
|
29
|
+
/** auto inject on loadController() */
|
|
30
|
+
controller = {};
|
|
31
|
+
/** auto inject on loadMiddleware() */
|
|
32
|
+
middlewares = {};
|
|
33
|
+
/**
|
|
34
|
+
* @class
|
|
35
|
+
* @param {Object} options - options
|
|
36
|
+
* @param {String} [options.baseDir=process.cwd()] - the directory of application
|
|
37
|
+
* @param {String} [options.type=application|agent] - whether it's running in app worker or agent worker
|
|
38
|
+
* @param {Object} [options.plugins] - custom plugins
|
|
39
|
+
* @since 1.0.0
|
|
40
|
+
*/
|
|
41
|
+
constructor(options = {}) {
|
|
42
|
+
options.baseDir = options.baseDir ?? process.cwd();
|
|
43
|
+
options.type = options.type ?? 'application';
|
|
44
|
+
assert(typeof options.baseDir === 'string', 'options.baseDir required, and must be a string');
|
|
45
|
+
// assert(fs.existsSync(options.baseDir), `Directory ${options.baseDir} not exists`);
|
|
46
|
+
// assert(fs.statSync(options.baseDir).isDirectory(), `Directory ${options.baseDir} is not a directory`);
|
|
47
|
+
assert(options.type === 'application' || options.type === 'agent', 'options.type should be application or agent');
|
|
48
|
+
super();
|
|
49
|
+
this.timing = new Timing();
|
|
50
|
+
/**
|
|
51
|
+
* @member {Object} EggCore#options
|
|
52
|
+
* @private
|
|
53
|
+
* @since 1.0.0
|
|
54
|
+
*/
|
|
55
|
+
this.options = options;
|
|
56
|
+
/**
|
|
57
|
+
* logging for EggCore, avoid using console directly
|
|
58
|
+
* @member {Logger} EggCore#console
|
|
59
|
+
* @private
|
|
60
|
+
* @since 1.0.0
|
|
61
|
+
*/
|
|
62
|
+
this.console = new EggConsoleLogger();
|
|
63
|
+
/**
|
|
64
|
+
* @member {BaseContextClass} EggCore#BaseContextClass
|
|
65
|
+
* @since 1.0.0
|
|
66
|
+
*/
|
|
67
|
+
this.BaseContextClass = BaseContextClass;
|
|
68
|
+
/**
|
|
69
|
+
* Base controller to be extended by controller in `app.controller`
|
|
70
|
+
* @class Controller
|
|
71
|
+
* @augments BaseContextClass
|
|
72
|
+
* @example
|
|
73
|
+
* class UserController extends app.Controller {}
|
|
74
|
+
*/
|
|
75
|
+
const Controller = this.BaseContextClass;
|
|
76
|
+
/**
|
|
77
|
+
* Retrieve base controller
|
|
78
|
+
* @member {Controller} EggCore#Controller
|
|
79
|
+
* @since 1.0.0
|
|
80
|
+
*/
|
|
81
|
+
this.Controller = Controller;
|
|
82
|
+
/**
|
|
83
|
+
* Base service to be extended by services in `app.service`
|
|
84
|
+
* @class Service
|
|
85
|
+
* @augments BaseContextClass
|
|
86
|
+
* @example
|
|
87
|
+
* class UserService extends app.Service {}
|
|
88
|
+
*/
|
|
89
|
+
const Service = this.BaseContextClass;
|
|
90
|
+
/**
|
|
91
|
+
* Retrieve base service
|
|
92
|
+
* @member {Service} EggCore#Service
|
|
93
|
+
* @since 1.0.0
|
|
94
|
+
*/
|
|
95
|
+
this.Service = Service;
|
|
96
|
+
this.lifecycle = new Lifecycle({
|
|
97
|
+
baseDir: options.baseDir,
|
|
98
|
+
app: this,
|
|
99
|
+
logger: this.console,
|
|
100
|
+
});
|
|
101
|
+
this.lifecycle.on('error', err => this.emit('error', err));
|
|
102
|
+
this.lifecycle.on('ready_timeout', id => this.emit('ready_timeout', id));
|
|
103
|
+
this.lifecycle.on('ready_stat', data => this.emit('ready_stat', data));
|
|
104
|
+
/**
|
|
105
|
+
* The loader instance, the default class is {@link EggLoader}.
|
|
106
|
+
* If you want define
|
|
107
|
+
* @member {EggLoader} EggCore#loader
|
|
108
|
+
* @since 1.0.0
|
|
109
|
+
*/
|
|
110
|
+
const Loader = this[EGG_LOADER];
|
|
111
|
+
assert(Loader, 'Symbol.for(\'egg#loader\') is required');
|
|
112
|
+
this.loader = new Loader({
|
|
113
|
+
baseDir: options.baseDir,
|
|
114
|
+
app: this,
|
|
115
|
+
plugins: options.plugins,
|
|
116
|
+
logger: this.console,
|
|
117
|
+
serverScope: options.serverScope,
|
|
118
|
+
env: options.env ?? '',
|
|
119
|
+
EggCoreClass: EggCore,
|
|
120
|
+
});
|
|
121
|
+
}
|
|
122
|
+
/**
|
|
123
|
+
* override koa's app.use, support generator function
|
|
124
|
+
* @since 1.0.0
|
|
125
|
+
*/
|
|
126
|
+
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
127
|
+
// @ts-ignore
|
|
128
|
+
use(fn) {
|
|
129
|
+
assert(is.function(fn), 'app.use() requires a function');
|
|
130
|
+
debug('[use] add middleware: %o', fn._name || fn.name || '-');
|
|
131
|
+
this.middleware.push(fn);
|
|
132
|
+
return this;
|
|
133
|
+
}
|
|
134
|
+
/**
|
|
135
|
+
* Whether `application` or `agent`
|
|
136
|
+
* @member {String}
|
|
137
|
+
* @since 1.0.0
|
|
138
|
+
*/
|
|
139
|
+
get type() {
|
|
140
|
+
return this.options.type;
|
|
141
|
+
}
|
|
142
|
+
/**
|
|
143
|
+
* The current directory of application
|
|
144
|
+
* @member {String}
|
|
145
|
+
* @see {@link AppInfo#baseDir}
|
|
146
|
+
* @since 1.0.0
|
|
147
|
+
*/
|
|
148
|
+
get baseDir() {
|
|
149
|
+
return this.options.baseDir;
|
|
150
|
+
}
|
|
151
|
+
/**
|
|
152
|
+
* Alias to {@link https://npmjs.com/package/depd}
|
|
153
|
+
* @member {Function}
|
|
154
|
+
* @since 1.0.0
|
|
155
|
+
*/
|
|
156
|
+
get deprecate() {
|
|
157
|
+
return utils.deprecated;
|
|
158
|
+
}
|
|
159
|
+
/**
|
|
160
|
+
* The name of application
|
|
161
|
+
* @member {String}
|
|
162
|
+
* @see {@link AppInfo#name}
|
|
163
|
+
* @since 1.0.0
|
|
164
|
+
*/
|
|
165
|
+
get name() {
|
|
166
|
+
return this.loader ? this.loader.pkg.name : '';
|
|
167
|
+
}
|
|
168
|
+
/**
|
|
169
|
+
* Retrieve enabled plugins
|
|
170
|
+
* @member {Object}
|
|
171
|
+
* @since 1.0.0
|
|
172
|
+
*/
|
|
173
|
+
get plugins() {
|
|
174
|
+
return this.loader ? this.loader.plugins : {};
|
|
175
|
+
}
|
|
176
|
+
/**
|
|
177
|
+
* The configuration of application
|
|
178
|
+
* @member {Config}
|
|
179
|
+
* @since 1.0.0
|
|
180
|
+
*/
|
|
181
|
+
get config() {
|
|
182
|
+
return this.loader ? this.loader.config : {};
|
|
183
|
+
}
|
|
184
|
+
/**
|
|
185
|
+
* Execute scope after loaded and before app start.
|
|
186
|
+
*
|
|
187
|
+
* Notice:
|
|
188
|
+
* This method is now NOT recommanded and reguarded as a deprecated one,
|
|
189
|
+
* For plugin development, we should use `didLoad` instead.
|
|
190
|
+
* For application development, we should use `willReady` instead.
|
|
191
|
+
*
|
|
192
|
+
* @see https://eggjs.org/en/advanced/loader.html#beforestart
|
|
193
|
+
*
|
|
194
|
+
* @param {Function|AsyncFunction} scope function will execute before app start
|
|
195
|
+
* @param {string} [name] scope name, default is empty string
|
|
196
|
+
*/
|
|
197
|
+
beforeStart(scope, name) {
|
|
198
|
+
this.deprecate('Please use "Life Cycles" instead, see https://www.eggjs.org/advanced/loader#life-cycles');
|
|
199
|
+
this.lifecycle.registerBeforeStart(scope, name ?? '');
|
|
200
|
+
}
|
|
201
|
+
/**
|
|
202
|
+
* register an callback function that will be invoked when application is ready.
|
|
203
|
+
* @see https://github.com/node-modules/get-ready
|
|
204
|
+
* @since 1.0.0
|
|
205
|
+
* @example
|
|
206
|
+
* const app = new Application(...);
|
|
207
|
+
* app.ready(err => {
|
|
208
|
+
* if (err) throw err;
|
|
209
|
+
* console.log('done');
|
|
210
|
+
* });
|
|
211
|
+
*/
|
|
212
|
+
ready(flagOrFunction) {
|
|
213
|
+
return this.lifecycle.ready(flagOrFunction);
|
|
214
|
+
}
|
|
215
|
+
/**
|
|
216
|
+
* If a client starts asynchronously, you can register `readyCallback`,
|
|
217
|
+
* then the application will wait for the callback to ready
|
|
218
|
+
*
|
|
219
|
+
* It will log when the callback is not invoked after 10s
|
|
220
|
+
*
|
|
221
|
+
* Recommend to use {@link EggCore#beforeStart}
|
|
222
|
+
* @since 1.0.0
|
|
223
|
+
*
|
|
224
|
+
* @param {String} name - readyCallback task name
|
|
225
|
+
* @param {object} opts -
|
|
226
|
+
* - {Number} [timeout=10000] - emit `ready_timeout` when it doesn't finish but reach the timeout
|
|
227
|
+
* - {Boolean} [isWeakDep=false] - whether it's a weak dependency
|
|
228
|
+
* @return {Function} - a callback
|
|
229
|
+
* @example
|
|
230
|
+
* const done = app.readyCallback('mysql');
|
|
231
|
+
* mysql.ready(done);
|
|
232
|
+
*/
|
|
233
|
+
readyCallback(name, opts) {
|
|
234
|
+
this.deprecate('Please use "Life Cycles" instead, see https://www.eggjs.org/advanced/loader#life-cycles');
|
|
235
|
+
return this.lifecycle.legacyReadyCallback(name, opts);
|
|
236
|
+
}
|
|
237
|
+
/**
|
|
238
|
+
* Register a function that will be called when app close.
|
|
239
|
+
*
|
|
240
|
+
* Notice:
|
|
241
|
+
* This method is now NOT recommanded directly used,
|
|
242
|
+
* Developers SHOULDN'T use app.beforeClose directly now,
|
|
243
|
+
* but in the form of class to implement beforeClose instead.
|
|
244
|
+
*
|
|
245
|
+
* @see https://eggjs.org/en/advanced/loader.html#beforeclose
|
|
246
|
+
*
|
|
247
|
+
* @param {Function} fn - the function that can be generator function or async function.
|
|
248
|
+
*/
|
|
249
|
+
beforeClose(fn) {
|
|
250
|
+
this.deprecate('Please use "Life Cycles" instead, see https://www.eggjs.org/advanced/loader#life-cycles');
|
|
251
|
+
this.lifecycle.registerBeforeClose(fn);
|
|
252
|
+
}
|
|
253
|
+
/**
|
|
254
|
+
* Close all, it will close
|
|
255
|
+
* - callbacks registered by beforeClose
|
|
256
|
+
* - emit `close` event
|
|
257
|
+
* - remove add listeners
|
|
258
|
+
*
|
|
259
|
+
* If error is thrown when it's closing, the promise will reject.
|
|
260
|
+
* It will also reject after following call.
|
|
261
|
+
* @return {Promise} promise
|
|
262
|
+
* @since 1.0.0
|
|
263
|
+
*/
|
|
264
|
+
async close() {
|
|
265
|
+
if (this.#closePromise)
|
|
266
|
+
return this.#closePromise;
|
|
267
|
+
this.#closePromise = this.lifecycle.close();
|
|
268
|
+
return this.#closePromise;
|
|
269
|
+
}
|
|
270
|
+
/**
|
|
271
|
+
* get router
|
|
272
|
+
* @member {Router} EggCore#router
|
|
273
|
+
* @since 1.0.0
|
|
274
|
+
*/
|
|
275
|
+
get router() {
|
|
276
|
+
if (this.#router) {
|
|
277
|
+
return this.#router;
|
|
278
|
+
}
|
|
279
|
+
const router = this.#router = new Router({ sensitive: true }, this);
|
|
280
|
+
return router;
|
|
281
|
+
}
|
|
282
|
+
/**
|
|
283
|
+
* Alias to {@link Router#url}
|
|
284
|
+
* @param {String} name - Router name
|
|
285
|
+
* @param {Object} params - more parameters
|
|
286
|
+
* @return {String} url
|
|
287
|
+
*/
|
|
288
|
+
url(name, params) {
|
|
289
|
+
return this.router.url(name, params);
|
|
290
|
+
}
|
|
291
|
+
head(...args) {
|
|
292
|
+
this.router.head.apply(this.router, args);
|
|
293
|
+
return this;
|
|
294
|
+
}
|
|
295
|
+
get(...args) {
|
|
296
|
+
this.router.get.apply(this.router, args);
|
|
297
|
+
return this;
|
|
298
|
+
}
|
|
299
|
+
put(...args) {
|
|
300
|
+
this.router.put.apply(this.router, args);
|
|
301
|
+
return this;
|
|
302
|
+
}
|
|
303
|
+
patch(...args) {
|
|
304
|
+
this.router.patch.apply(this.router, args);
|
|
305
|
+
return this;
|
|
306
|
+
}
|
|
307
|
+
post(...args) {
|
|
308
|
+
this.router.post.apply(this.router, args);
|
|
309
|
+
return this;
|
|
310
|
+
}
|
|
311
|
+
delete(...args) {
|
|
312
|
+
this.router.delete.apply(this.router, args);
|
|
313
|
+
return this;
|
|
314
|
+
}
|
|
315
|
+
del(...args) {
|
|
316
|
+
this.router.del.apply(this.router, args);
|
|
317
|
+
return this;
|
|
318
|
+
}
|
|
319
|
+
all(...args) {
|
|
320
|
+
this.router.all.apply(this.router, args);
|
|
321
|
+
return this;
|
|
322
|
+
}
|
|
323
|
+
resources(...args) {
|
|
324
|
+
this.router.resources.apply(this.router, args);
|
|
325
|
+
return this;
|
|
326
|
+
}
|
|
327
|
+
redirect(source, destination, status = 301) {
|
|
328
|
+
this.router.redirect(source, destination, status);
|
|
329
|
+
return this;
|
|
330
|
+
}
|
|
331
|
+
register(path, methods, middleware, opts) {
|
|
332
|
+
this.router.register(path, methods, middleware, opts);
|
|
333
|
+
return this;
|
|
334
|
+
}
|
|
335
|
+
get [EGG_LOADER]() {
|
|
336
|
+
return EggLoader;
|
|
337
|
+
}
|
|
338
|
+
}
|
|
339
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"egg.js","sourceRoot":"","sources":["../../src/egg.ts"],"names":[],"mappings":"AAAA,kCAAkC;AAClC,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,cAAc,MAAM,YAAY,CAAC;AAExC,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,EAAwC,SAAS,IAAI,MAAM,EAAE,MAAM,eAAe,CAAC;AAE1F,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,KAAK,MAAM,kBAAkB,CAAC;AAErC,MAAM,KAAK,GAAG,QAAQ,CAAC,iBAAiB,CAAC,CAAC;AAE1C,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;AAuB5C,MAAM,OAAO,OAAQ,SAAQ,cAAc;IACzC,OAAO,CAAiB;IACxB,MAAM,CAAS;IACf,OAAO,CAAmB;IAC1B,gBAAgB,CAA0B;IAC1C,UAAU,CAA0B;IACpC,OAAO,CAA0B;IACjC,MAAM,CAA2B;IACjC,SAAS,CAAY;IACrB,MAAM,CAAY;IAClB,aAAa,CAAiB;IAC9B,OAAO,CAAU;IAEjB,mCAAmC;IAC1B,cAAc,GAAwB,EAAE,CAAC;IAClD,sCAAsC;IAC7B,UAAU,GAAwB,EAAE,CAAC;IAC9C,sCAAsC;IAC7B,WAAW,GAA+D,EAAE,CAAC;IAKtF;;;;;;;OAOG;IACH,YAAY,UAA8B,EAAE;QAC1C,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;QACnD,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,aAAa,CAAC;QAC7C,MAAM,CAAC,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ,EAAE,gDAAgD,CAAC,CAAC;QAC9F,qFAAqF;QACrF,yGAAyG;QACzG,MAAM,CAAC,OAAO,CAAC,IAAI,KAAK,aAAa,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO,EAAE,6CAA6C,CAAC,CAAC;QAClH,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;QAC3B;;;;WAIG;QACH,IAAI,CAAC,OAAO,GAAG,OAAyB,CAAC;QAEzC;;;;;WAKG;QACH,IAAI,CAAC,OAAO,GAAG,IAAI,gBAAgB,EAAE,CAAC;QAEtC;;;WAGG;QACH,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QAEzC;;;;;;WAMG;QACH,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAEzC;;;;WAIG;QACH,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAE7B;;;;;;WAMG;QACH,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAEtC;;;;WAIG;QACH,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC;YAC7B,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,GAAG,EAAE,IAAI;YACT,MAAM,EAAE,IAAI,CAAC,OAAO;SACrB,CAAC,CAAC;QACH,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;QAC3D,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,eAAe,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,CAAC;QACzE,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,YAAY,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC;QAEvE;;;;;WAKG;QACH,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC;QAChC,MAAM,CAAC,MAAM,EAAE,wCAAwC,CAAC,CAAC;QACzD,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC;YACvB,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,GAAG,EAAE,IAAI;YACT,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,EAAE;YACtB,YAAY,EAAE,OAAO;SACtB,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,6DAA6D;IAC7D,aAAa;IACb,GAAG,CAAC,EAAkB;QACpB,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,+BAA+B,CAAC,CAAC;QACzD,KAAK,CAAC,0BAA0B,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC;QAC9D,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,IAAI,SAAS;QACX,OAAO,KAAK,CAAC,UAAU,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,KAAU,EAAE,IAAa;QACnC,IAAI,CAAC,SAAS,CAAC,yFAAyF,CAAC,CAAC;QAC1G,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,KAAK,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,cAAiC;QACrC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,aAAa,CAAC,IAAY,EAAE,IAAY;QACtC,IAAI,CAAC,SAAS,CAAC,yFAAyF,CAAC,CAAC;QAC1G,OAAO,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,EAAO;QACjB,IAAI,CAAC,SAAS,CAAC,yFAAyF,CAAC,CAAC;QAC1G,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,aAAa;YAAE,OAAO,IAAI,CAAC,aAAa,CAAC;QAClD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QAC5C,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;QACR,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC,OAAO,CAAC;QACtB,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,MAAM,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;QACpE,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,IAAY,EAAE,MAAY;QAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACvC,CAAC;IAOD,IAAI,CAAC,GAAG,IAAS;QACf,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IASD,GAAG,CAAC,GAAG,IAAS;QACd,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAGD,GAAG,CAAC,GAAG,IAAS;QACd,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAGD,KAAK,CAAC,GAAG,IAAS;QAChB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IAGD,IAAI,CAAC,GAAG,IAAS;QACf,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAGD,MAAM,CAAC,GAAG,IAAS;QACjB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC;IACd,CAAC;IAGD,GAAG,CAAC,GAAG,IAAS;QACd,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAID,GAAG,CAAC,GAAG,IAAS;QACd,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAMD,SAAS,CAAC,GAAG,IAAS;QACpB,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,QAAQ,CAAC,MAAc,EAAE,WAAmB,EAAE,SAAiB,GAAG;QAChE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;QAClD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,QAAQ,CAAC,IAA2C,EAClD,OAAiB,EACjB,UAA6C,EAC7C,IAAsB;QACtB,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAAC,UAAU,CAAC;QACd,OAAO,SAAS,CAAC;IACnB,CAAC;CACF"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import utils from './utils/index.js';
|
|
2
|
+
export * from './egg.js';
|
|
3
|
+
export * from './loader/egg_loader.js';
|
|
4
|
+
export * from './base_context_class.js';
|
|
5
|
+
export { utils };
|
|
6
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLE1BQU0sa0JBQWtCLENBQUM7QUFFckMsY0FBYyxVQUFVLENBQUM7QUFDekIsY0FBYyx3QkFBd0IsQ0FBQztBQUN2QyxjQUFjLHlCQUF5QixDQUFDO0FBQ3hDLE9BQU8sRUFBRSxLQUFLLEVBQUUsQ0FBQyJ9
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
/// <reference types="node" resolution-mode="require"/>
|
|
2
|
+
import { EventEmitter } from 'node:events';
|
|
3
|
+
import type { ReadyFunctionArg } from 'get-ready';
|
|
4
|
+
import { Ready } from 'ready-callback';
|
|
5
|
+
import { EggConsoleLogger } from 'egg-logger';
|
|
6
|
+
import type { Fun } from './utils/index.js';
|
|
7
|
+
import type { EggCore } from './egg.js';
|
|
8
|
+
export interface ILifecycleBoot {
|
|
9
|
+
fullPath?: string;
|
|
10
|
+
/**
|
|
11
|
+
* Ready to call configDidLoad,
|
|
12
|
+
* Config, plugin files are referred,
|
|
13
|
+
* this is the last chance to modify the config.
|
|
14
|
+
*/
|
|
15
|
+
configWillLoad?(): void;
|
|
16
|
+
/**
|
|
17
|
+
* Config, plugin files have loaded
|
|
18
|
+
*/
|
|
19
|
+
configDidLoad?(): void;
|
|
20
|
+
/**
|
|
21
|
+
* All files have loaded, start plugin here
|
|
22
|
+
*/
|
|
23
|
+
didLoad?(): Promise<void>;
|
|
24
|
+
/**
|
|
25
|
+
* All plugins have started, can do some thing before app ready
|
|
26
|
+
*/
|
|
27
|
+
willReady?(): Promise<void>;
|
|
28
|
+
/**
|
|
29
|
+
* Worker is ready, can do some things,
|
|
30
|
+
* don't need to block the app boot
|
|
31
|
+
*/
|
|
32
|
+
didReady?(err?: Error): Promise<void>;
|
|
33
|
+
/**
|
|
34
|
+
* Server is listening
|
|
35
|
+
*/
|
|
36
|
+
serverDidReady?(): Promise<void>;
|
|
37
|
+
/**
|
|
38
|
+
* Do some thing before app close
|
|
39
|
+
*/
|
|
40
|
+
beforeClose?(): Promise<void>;
|
|
41
|
+
}
|
|
42
|
+
export type BootImplClass<T = object> = (new (...args: any[]) => T) & ILifecycleBoot;
|
|
43
|
+
export interface LifecycleOptions {
|
|
44
|
+
baseDir: string;
|
|
45
|
+
app: EggCore;
|
|
46
|
+
logger: EggConsoleLogger;
|
|
47
|
+
}
|
|
48
|
+
export declare class Lifecycle extends EventEmitter {
|
|
49
|
+
#private;
|
|
50
|
+
loadReady: Ready;
|
|
51
|
+
bootReady: Ready;
|
|
52
|
+
options: LifecycleOptions;
|
|
53
|
+
readyTimeout: number;
|
|
54
|
+
constructor(options: Partial<LifecycleOptions>);
|
|
55
|
+
ready(arg?: ReadyFunctionArg): Promise<void> | undefined;
|
|
56
|
+
get app(): EggCore;
|
|
57
|
+
get logger(): EggConsoleLogger<import("egg-logger").LoggerOptions>;
|
|
58
|
+
get timing(): import("./utils/timing.js").Timing;
|
|
59
|
+
legacyReadyCallback(name: string, opt?: object): (...args: any[]) => void;
|
|
60
|
+
addBootHook(bootHootOrBootClass: BootImplClass | ILifecycleBoot): void;
|
|
61
|
+
addFunctionAsBootHook<T = EggCore>(hook: (app: T) => void): void;
|
|
62
|
+
/**
|
|
63
|
+
* init boots and trigger config did config
|
|
64
|
+
*/
|
|
65
|
+
init(): void;
|
|
66
|
+
registerBeforeStart(scope: Fun, name: string): void;
|
|
67
|
+
registerBeforeClose(fn: Fun): void;
|
|
68
|
+
close(): Promise<void>;
|
|
69
|
+
triggerConfigWillLoad(): void;
|
|
70
|
+
triggerConfigDidLoad(): void;
|
|
71
|
+
triggerDidLoad(): void;
|
|
72
|
+
triggerWillReady(): void;
|
|
73
|
+
triggerDidReady(err?: Error): Promise<void>;
|
|
74
|
+
triggerServerDidReady(): Promise<void>;
|
|
75
|
+
}
|