egg 4.0.9 → 4.1.0-beta.10

package/dist/commonjs/lib/core/messenger/local.js

@@ -1,132 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Messenger = void 0;
-const node_util_1 = require("node:util");
-const base_js_1 = require("./base.js");
-const debug = (0, node_util_1.debuglog)('egg/lib/core/messenger/local');
-/**
- * Communication between app worker and agent worker with EventEmitter
- */
-class Messenger extends base_js_1.BaseMessenger {
-    pid;
-    constructor(egg) {
-        super(egg);
-        this.pid = String(process.pid);
-    }
-    /**
-     * Send message to all agent and app
-     * @param {String} action - message key
-     * @param {Object} data - message value
-     * @return {Messenger} this
-     */
-    broadcast(action, data) {
-        debug('[%s:%s] broadcast %s with %j', this.egg.type, this.pid, action, data);
-        this.send(action, data, 'both');
-        return this;
-    }
-    /**
-     * send message to the specified process
-     * Notice: in single process mode, it only can send to self process,
-     * and it will send to both agent and app's messengers.
-     * @param {String} workerId - the workerId of the receiver
-     * @param {String} action - message key
-     * @param {Object} data - message value
-     * @return {Messenger} this
-     */
-    sendTo(workerId, action, data) {
-        debug('[%s:%s] send %s with %j to %s', this.egg.type, this.pid, action, data, workerId);
-        if (String(workerId) !== this.pid) {
-            return this;
-        }
-        this.send(action, data, 'both');
-        return this;
-    }
-    /**
-     * send message to one worker by random
-     * Notice: in single process mode, we only start one agent worker and one app worker
-     * - if it's running in agent, it will send to one of app workers
-     * - if it's running in app, it will send to agent
-     * @param {String} action - message key
-     * @param {Object} data - message value
-     * @return {Messenger} this
-     */
-    sendRandom(action, data) {
-        debug('[%s:%s] send %s with %j to opposite', this.egg.type, this.pid, action, data);
-        this.send(action, data, 'opposite');
-        return this;
-    }
-    /**
-     * send message to app
-     * @param {String} action - message key
-     * @param {Object} data - message value
-     * @return {Messenger} this
-     */
-    sendToApp(action, data) {
-        debug('[%s:%s] send %s with %j to all app', this.egg.type, this.pid, action, data);
-        this.send(action, data, 'application');
-        return this;
-    }
-    /**
-     * send message to agent
-     * @param {String} action - message key
-     * @param {Object} data - message value
-     * @return {Messenger} this
-     */
-    sendToAgent(action, data) {
-        debug('[%s:%s] send %s with %j to all agent', this.egg.type, this.pid, action, data);
-        this.send(action, data, 'agent');
-        return this;
-    }
-    /**
-     * @param {String} action - message key
-     * @param {Object} data - message value
-     * @param {String} to - let master know how to send message
-     * @return {Messenger} this
-     */
-    send(action, data, to) {
-        // use nextTick to keep it async as IPC messenger
-        process.nextTick(() => {
-            const { egg } = this;
-            let application;
-            let agent;
-            let opposite;
-            if (egg.type === 'application') {
-                application = egg;
-                agent = egg.agent;
-                opposite = agent;
-            }
-            else {
-                agent = egg;
-                application = egg.application;
-                opposite = application;
-            }
-            if (!to) {
-                to = egg.type === 'application' ? 'agent' : 'application';
-            }
-            if (application && application.messenger && (to === 'application' || to === 'both')) {
-                application.messenger.onMessage({ action, data });
-            }
-            if (agent && agent.messenger && (to === 'agent' || to === 'both')) {
-                agent.messenger.onMessage({ action, data });
-            }
-            if (opposite && opposite.messenger && to === 'opposite') {
-                opposite.messenger.onMessage({ action, data });
-            }
-        });
-        return this;
-    }
-    onMessage(message) {
-        if (typeof message?.action === 'string') {
-            debug('[%s:%s] got message %s with %j', this.egg.type, this.pid, message.action, message.data);
-            this.emit(message.action, message.data);
-        }
-        else {
-            debug('[%s:%s] got an invalid message %j', this.egg.type, this.pid, message);
-        }
-    }
-    close() {
-        this.removeAllListeners();
-    }
-}
-exports.Messenger = Messenger;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibG9jYWwuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi9zcmMvbGliL2NvcmUvbWVzc2VuZ2VyL2xvY2FsLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLHlDQUFxQztBQUdyQyx1Q0FBMEM7QUFFMUMsTUFBTSxLQUFLLEdBQUcsSUFBQSxvQkFBUSxFQUFDLDhCQUE4QixDQUFDLENBQUM7QUFFdkQ7O0dBRUc7QUFDSCxNQUFhLFNBQVUsU0FBUSx1QkFBYTtJQUNqQyxHQUFHLENBQVM7SUFFckIsWUFBWSxHQUF1QjtRQUNqQyxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUM7UUFDWCxJQUFJLENBQUMsR0FBRyxHQUFHLE1BQU0sQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLENBQUM7SUFDakMsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0gsU0FBUyxDQUFDLE1BQWMsRUFBRSxJQUFjO1FBQ3RDLEtBQUssQ0FBQyw4QkFBOEIsRUFBRSxJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsR0FBRyxFQUFFLE1BQU0sRUFBRSxJQUFJLENBQUMsQ0FBQztRQUM3RSxJQUFJLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxJQUFJLEVBQUUsTUFBTSxDQUFDLENBQUM7UUFDaEMsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7Ozs7O09BUUc7SUFDSCxNQUFNLENBQUMsUUFBZ0IsRUFBRSxNQUFjLEVBQUUsSUFBYztRQUNyRCxLQUFLLENBQUMsK0JBQStCLEVBQUUsSUFBSSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLEdBQUcsRUFBRSxNQUFNLEVBQUUsSUFBSSxFQUFFLFFBQVEsQ0FBQyxDQUFDO1FBQ3hGLElBQUksTUFBTSxDQUFDLFFBQVEsQ0FBQyxLQUFLLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBQztZQUNsQyxPQUFPLElBQUksQ0FBQztRQUNkLENBQUM7UUFDRCxJQUFJLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxJQUFJLEVBQUUsTUFBTSxDQUFDLENBQUM7UUFDaEMsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7Ozs7O09BUUc7SUFDSCxVQUFVLENBQUMsTUFBYyxFQUFFLElBQWM7UUFDdkMsS0FBSyxDQUFDLHFDQUFxQyxFQUFFLElBQUksQ0FBQyxHQUFHLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxHQUFHLEVBQUUsTUFBTSxFQUFFLElBQUksQ0FBQyxDQUFDO1FBQ3BGLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLElBQUksRUFBRSxVQUFVLENBQUMsQ0FBQztRQUNwQyxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7Ozs7T0FLRztJQUNILFNBQVMsQ0FBQyxNQUFjLEVBQUUsSUFBYztRQUN0QyxLQUFLLENBQUMsb0NBQW9DLEVBQUUsSUFBSSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLEdBQUcsRUFBRSxNQUFNLEVBQUUsSUFBSSxDQUFDLENBQUM7UUFDbkYsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsSUFBSSxFQUFFLGFBQWEsQ0FBQyxDQUFDO1FBQ3ZDLE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0gsV0FBVyxDQUFDLE1BQWMsRUFBRSxJQUFjO1FBQ3hDLEtBQUssQ0FBQyxzQ0FBc0MsRUFBRSxJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsR0FBRyxFQUFFLE1BQU0sRUFBRSxJQUFJLENBQUMsQ0FBQztRQUNyRixJQUFJLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxJQUFJLEVBQUUsT0FBTyxDQUFDLENBQUM7UUFDakMsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSCxJQUFJLENBQUMsTUFBYyxFQUFFLElBQXlCLEVBQUUsRUFBVztRQUN6RCxpREFBaUQ7UUFDakQsT0FBTyxDQUFDLFFBQVEsQ0FBQyxHQUFHLEVBQUU7WUFDcEIsTUFBTSxFQUFFLEdBQUcsRUFBRSxHQUFHLElBQUksQ0FBQztZQUNyQixJQUFJLFdBQVcsQ0FBQztZQUNoQixJQUFJLEtBQUssQ0FBQztZQUNWLElBQUksUUFBUSxDQUFDO1lBRWIsSUFBSSxHQUFHLENBQUMsSUFBSSxLQUFLLGFBQWEsRUFBRSxDQUFDO2dCQUMvQixXQUFXLEdBQUcsR0FBRyxDQUFDO2dCQUNsQixLQUFLLEdBQUcsR0FBRyxDQUFDLEtBQUssQ0FBQztnQkFDbEIsUUFBUSxHQUFHLEtBQUssQ0FBQztZQUNuQixDQUFDO2lCQUFNLENBQUM7Z0JBQ04sS0FBSyxHQUFHLEdBQUcsQ0FBQztnQkFDWixXQUFXLEdBQUcsR0FBRyxDQUFDLFdBQVcsQ0FBQztnQkFDOUIsUUFBUSxHQUFHLFdBQVcsQ0FBQztZQUN6QixDQUFDO1lBQ0QsSUFBSSxDQUFDLEVBQUUsRUFBRSxDQUFDO2dCQUNSLEVBQUUsR0FBRyxHQUFHLENBQUMsSUFBSSxLQUFLLGFBQWEsQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxhQUFhLENBQUM7WUFDNUQsQ0FBQztZQUVELElBQUksV0FBVyxJQUFJLFdBQVcsQ0FBQyxTQUFTLElBQUksQ0FBQyxFQUFFLEtBQUssYUFBYSxJQUFJLEVBQUUsS0FBSyxNQUFNLENBQUMsRUFBRSxDQUFDO2dCQUNwRixXQUFXLENBQUMsU0FBUyxDQUFDLFNBQVMsQ0FBQyxFQUFFLE1BQU0sRUFBRSxJQUFJLEVBQUUsQ0FBQyxDQUFDO1lBQ3BELENBQUM7WUFDRCxJQUFJLEtBQUssSUFBSSxLQUFLLENBQUMsU0FBUyxJQUFJLENBQUMsRUFBRSxLQUFLLE9BQU8sSUFBSSxFQUFFLEtBQUssTUFBTSxDQUFDLEVBQUUsQ0FBQztnQkFDbEUsS0FBSyxDQUFDLFNBQVMsQ0FBQyxTQUFTLENBQUMsRUFBRSxNQUFNLEVBQUUsSUFBSSxFQUFFLENBQUMsQ0FBQztZQUM5QyxDQUFDO1lBQ0QsSUFBSSxRQUFRLElBQUksUUFBUSxDQUFDLFNBQVMsSUFBSSxFQUFFLEtBQUssVUFBVSxFQUFFLENBQUM7Z0JBQ3hELFFBQVEsQ0FBQyxTQUFTLENBQUMsU0FBUyxDQUFDLEVBQUUsTUFBTSxFQUFFLElBQUksRUFBRSxDQUFDLENBQUM7WUFDakQsQ0FBQztRQUNILENBQUMsQ0FBQyxDQUFDO1FBRUgsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQsU0FBUyxDQUFDLE9BQVk7UUFDcEIsSUFBSSxPQUFPLE9BQU8sRUFBRSxNQUFNLEtBQUssUUFBUSxFQUFFLENBQUM7WUFDeEMsS0FBSyxDQUFDLGdDQUFnQyxFQUFFLElBQUksQ0FBQyxHQUFHLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxHQUFHLEVBQUUsT0FBTyxDQUFDLE1BQU0sRUFBRSxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDL0YsSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsTUFBTSxFQUFFLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUMxQyxDQUFDO2FBQU0sQ0FBQztZQUNOLEtBQUssQ0FBQyxtQ0FBbUMsRUFBRSxJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsR0FBRyxFQUFFLE9BQU8sQ0FBQyxDQUFDO1FBQy9FLENBQUM7SUFDSCxDQUFDO0lBRUQsS0FBSztRQUNILElBQUksQ0FBQyxrQkFBa0IsRUFBRSxDQUFDO0lBQzVCLENBQUM7Q0FPRjtBQXhJRCw4QkF3SUMifQ==

package/dist/commonjs/lib/core/utils.d.ts

@@ -1,2 +0,0 @@
-export declare function convertObject(obj: any, ignore?: string | RegExp | (string | RegExp)[]): any;
-export declare function safeParseURL(url: string): URL | null;

package/dist/commonjs/lib/core/utils.js

@@ -1,77 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertObject = convertObject;
-exports.safeParseURL = safeParseURL;
-const node_util_1 = __importDefault(require("node:util"));
-const is_type_of_1 = require("is-type-of");
-function convertObject(obj, ignore = []) {
-    if (!Array.isArray(ignore)) {
-        ignore = [ignore];
-    }
-    for (const key of Object.keys(obj)) {
-        obj[key] = convertValue(key, obj[key], ignore);
-    }
-    return obj;
-}
-function convertValue(key, value, ignore) {
-    if (value === null || value === undefined) {
-        return value;
-    }
-    let hit = false;
-    for (const matchKey of ignore) {
-        if (typeof matchKey === 'string' && matchKey === key) {
-            hit = true;
-            break;
-        }
-        else if ((0, is_type_of_1.isRegExp)(matchKey) && matchKey.test(key)) {
-            hit = true;
-            break;
-        }
-    }
-    if (!hit) {
-        if ((0, is_type_of_1.isSymbol)(value) || (0, is_type_of_1.isRegExp)(value) || value instanceof URL) {
-            return value.toString();
-        }
-        if ((0, is_type_of_1.isPrimitive)(value) || Array.isArray(value)) {
-            return value;
-        }
-    }
-    // only convert recursively when it's a plain object,
-    // o = {}
-    if (Object.getPrototypeOf(value) === Object.prototype) {
-        return convertObject(value, ignore);
-    }
-    // support class
-    const name = value.name || 'anonymous';
-    if ((0, is_type_of_1.isClass)(value)) {
-        return `<Class ${name}>`;
-    }
-    // support generator function
-    if ((0, is_type_of_1.isFunction)(value)) {
-        if ((0, is_type_of_1.isGeneratorFunction)(value))
-            return `<GeneratorFunction ${name}>`;
-        if ((0, is_type_of_1.isAsyncFunction)(value))
-            return `<AsyncFunction ${name}>`;
-        return `<Function ${name}>`;
-    }
-    const typeName = value.constructor.name;
-    if (typeName) {
-        if (Buffer.isBuffer(value) || typeof value === 'string') {
-            return `<${typeName} len: ${value.length}>`;
-        }
-        return `<${typeName}>`;
-    }
-    return node_util_1.default.format(value);
-}
-function safeParseURL(url) {
-    try {
-        return new URL(url);
-    }
-    catch {
-        return null;
-    }
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvbGliL2NvcmUvdXRpbHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFNQSxzQ0FRQztBQXdERCxvQ0FNQztBQTVFRCwwREFBNkI7QUFDN0IsMkNBR29CO0FBRXBCLFNBQWdCLGFBQWEsQ0FBQyxHQUFRLEVBQUUsU0FBZ0QsRUFBRTtJQUN4RixJQUFJLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUFDO1FBQzNCLE1BQU0sR0FBRyxDQUFFLE1BQU0sQ0FBRSxDQUFDO0lBQ3RCLENBQUM7SUFDRCxLQUFLLE1BQU0sR0FBRyxJQUFJLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQztRQUNuQyxHQUFHLENBQUMsR0FBRyxDQUFDLEdBQUcsWUFBWSxDQUFDLEdBQUcsRUFBRSxHQUFHLENBQUMsR0FBRyxDQUFDLEVBQUUsTUFBTSxDQUFDLENBQUM7SUFDakQsQ0FBQztJQUNELE9BQU8sR0FBRyxDQUFDO0FBQ2IsQ0FBQztBQUVELFNBQVMsWUFBWSxDQUFDLEdBQVcsRUFBRSxLQUFVLEVBQUUsTUFBMkI7SUFDeEUsSUFBSSxLQUFLLEtBQUssSUFBSSxJQUFJLEtBQUssS0FBSyxTQUFTLEVBQUUsQ0FBQztRQUMxQyxPQUFPLEtBQUssQ0FBQztJQUNmLENBQUM7SUFFRCxJQUFJLEdBQUcsR0FBRyxLQUFLLENBQUM7SUFDaEIsS0FBSyxNQUFNLFFBQVEsSUFBSSxNQUFNLEVBQUUsQ0FBQztRQUM5QixJQUFJLE9BQU8sUUFBUSxLQUFLLFFBQVEsSUFBSSxRQUFRLEtBQUssR0FBRyxFQUFFLENBQUM7WUFDckQsR0FBRyxHQUFHLElBQUksQ0FBQztZQUNYLE1BQU07UUFDUixDQUFDO2FBQU0sSUFBSSxJQUFBLHFCQUFRLEVBQUMsUUFBUSxDQUFDLElBQUksUUFBUSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDO1lBQ3BELEdBQUcsR0FBRyxJQUFJLENBQUM7WUFDWCxNQUFNO1FBQ1IsQ0FBQztJQUNILENBQUM7SUFDRCxJQUFJLENBQUMsR0FBRyxFQUFFLENBQUM7UUFDVCxJQUFJLElBQUEscUJBQVEsRUFBQyxLQUFLLENBQUMsSUFBSSxJQUFBLHFCQUFRLEVBQUMsS0FBSyxDQUFDLElBQUksS0FBSyxZQUFZLEdBQUcsRUFBRSxDQUFDO1lBQy9ELE9BQU8sS0FBSyxDQUFDLFFBQVEsRUFBRSxDQUFDO1FBQzFCLENBQUM7UUFDRCxJQUFJLElBQUEsd0JBQVcsRUFBQyxLQUFLLENBQUMsSUFBSSxLQUFLLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxFQUFFLENBQUM7WUFDL0MsT0FBTyxLQUFLLENBQUM7UUFDZixDQUFDO0lBQ0gsQ0FBQztJQUVELHFEQUFxRDtJQUNyRCxTQUFTO0lBQ1QsSUFBSSxNQUFNLENBQUMsY0FBYyxDQUFDLEtBQUssQ0FBQyxLQUFLLE1BQU0sQ0FBQyxTQUFTLEVBQUUsQ0FBQztRQUN0RCxPQUFPLGFBQWEsQ0FBQyxLQUFLLEVBQUUsTUFBTSxDQUFDLENBQUM7SUFDdEMsQ0FBQztJQUVELGdCQUFnQjtJQUNoQixNQUFNLElBQUksR0FBRyxLQUFLLENBQUMsSUFBSSxJQUFJLFdBQVcsQ0FBQztJQUN2QyxJQUFJLElBQUEsb0JBQU8sRUFBQyxLQUFLLENBQUMsRUFBRSxDQUFDO1FBQ25CLE9BQU8sVUFBVSxJQUFJLEdBQUcsQ0FBQztJQUMzQixDQUFDO0lBRUQsNkJBQTZCO0lBQzdCLElBQUksSUFBQSx1QkFBVSxFQUFDLEtBQUssQ0FBQyxFQUFFLENBQUM7UUFDdEIsSUFBSSxJQUFBLGdDQUFtQixFQUFDLEtBQUssQ0FBQztZQUFFLE9BQU8sc0JBQXNCLElBQUksR0FBRyxDQUFDO1FBQ3JFLElBQUksSUFBQSw0QkFBZSxFQUFDLEtBQUssQ0FBQztZQUFFLE9BQU8sa0JBQWtCLElBQUksR0FBRyxDQUFDO1FBQzdELE9BQU8sYUFBYSxJQUFJLEdBQUcsQ0FBQztJQUM5QixDQUFDO0lBRUQsTUFBTSxRQUFRLEdBQUcsS0FBSyxDQUFDLFdBQVcsQ0FBQyxJQUFJLENBQUM7SUFDeEMsSUFBSSxRQUFRLEVBQUUsQ0FBQztRQUNiLElBQUksTUFBTSxDQUFDLFFBQVEsQ0FBQyxLQUFLLENBQUMsSUFBSSxPQUFPLEtBQUssS0FBSyxRQUFRLEVBQUUsQ0FBQztZQUN4RCxPQUFPLElBQUksUUFBUSxTQUFTLEtBQUssQ0FBQyxNQUFNLEdBQUcsQ0FBQztRQUM5QyxDQUFDO1FBQ0QsT0FBTyxJQUFJLFFBQVEsR0FBRyxDQUFDO0lBQ3pCLENBQUM7SUFFRCxPQUFPLG1CQUFJLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDO0FBQzVCLENBQUM7QUFFRCxTQUFnQixZQUFZLENBQUMsR0FBVztJQUN0QyxJQUFJLENBQUM7UUFDSCxPQUFPLElBQUksR0FBRyxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQ3RCLENBQUM7SUFBQyxNQUFNLENBQUM7UUFDUCxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7QUFDSCxDQUFDIn0=

package/dist/commonjs/lib/egg.d.ts

@@ -1,305 +0,0 @@
-import { type IncomingMessage, type ServerResponse } from 'node:http';
-import { AsyncLocalStorage } from 'node:async_hooks';
-import { EggCore, Request as EggCoreRequest, Response as EggCoreResponse, Router } from '@eggjs/core';
-import type { EggCoreOptions, Next, MiddlewareFunc as EggCoreMiddlewareFunc, ILifecycleBoot } from '@eggjs/core';
-import { EggContextLogger as ContextLogger, EggLoggers, EggLogger } from 'egg-logger';
-import { Cookies as ContextCookies } from '@eggjs/cookies';
-import type { Agent } from './agent.js';
-import type { Application } from './application.js';
-import Context from '../app/extend/context.js';
-import type { EggAppConfig } from './types.js';
-import { IMessenger } from './core/messenger/index.js';
-import { ContextHttpClient } from './core/context_httpclient.js';
-import { HttpClient, type HttpClientRequestOptions, type HttpClientRequestURL, type HttpClientResponse, type HttpClientOptions } from './core/httpclient.js';
-import { BaseContextClass } from './core/base_context_class.js';
-import { BaseHookClass } from './core/base_hook_class.js';
-import type { EggApplicationLoader } from './loader/index.js';
-declare const EGG_PATH: unique symbol;
-export interface EggApplicationCoreOptions extends Omit<EggCoreOptions, 'baseDir'> {
-    mode?: 'cluster' | 'single';
-    clusterPort?: number;
-    baseDir?: string;
-}
-export declare class Request extends EggCoreRequest {
-    app: EggCore;
-    response: Response;
-    ctx: Context;
-}
-export declare class Response extends EggCoreResponse {
-    app: EggCore;
-    request: Request;
-    ctx: Context;
-}
-export type { ILifecycleBoot, ILifecycleBoot as IBoot, Next, };
-export type EggContext = Context;
-export type MiddlewareFunc<T extends Context = Context> = EggCoreMiddlewareFunc<T>;
-export { Context, Router, };
-/**
- * Based on koa's Application
- * @see https://github.com/eggjs/egg-core
- * @see https://github.com/eggjs/koa/blob/master/src/application.ts
- * @augments EggCore
- */
-export declare class EggApplicationCore extends EggCore {
-    #private;
-    ctxStorage: AsyncLocalStorage<Context>;
-    ContextCookies: typeof ContextCookies;
-    ContextLogger: typeof ContextLogger;
-    ContextHttpClient: typeof ContextHttpClient;
-    HttpClient: typeof HttpClient;
-    HttpClientNext: typeof HttpClient;
-    /**
-     * Retrieve base context class
-     * @member {BaseContextClass} BaseContextClass
-     * @since 1.0.0
-     */
-    BaseContextClass: typeof BaseContextClass;
-    /**
-     * Retrieve base controller
-     * @member {Controller} Controller
-     * @since 1.0.0
-     */
-    Controller: typeof BaseContextClass;
-    /**
-     * Retrieve base service
-     * @member {Service} Service
-     * @since 1.0.0
-     */
-    Service: typeof BaseContextClass;
-    /**
-     * Retrieve base subscription
-     * @member {Subscription} Subscription
-     * @since 2.12.0
-     */
-    Subscription: typeof BaseContextClass;
-    /**
-     * Retrieve base context class
-     * @member {BaseHookClass} BaseHookClass
-     */
-    BaseHookClass: typeof BaseHookClass;
-    /**
-     * Retrieve base boot
-     * @member {Boot}
-     * @alias BaseHookClass
-     */
-    Boot: typeof BaseHookClass;
-    options: Required<EggApplicationCoreOptions>;
-    readonly messenger: IMessenger;
-    agent?: Agent;
-    application?: Application;
-    loader: EggApplicationLoader;
-    /**
-     * @class
-     * @param {Object} options
-     *  - {Object} [type] - type of instance, Agent and Application both extend koa, type can determine what it is.
-     *  - {String} [baseDir] - app root dir, default is `process.cwd()`
-     *  - {Object} [plugins] - custom plugin config, use it in unittest
-     *  - {String} [mode] - process mode, can be cluster / single, default is `cluster`
-     */
-    constructor(options?: EggApplicationCoreOptions);
-    /**
-     * @deprecated please use `options` property instead
-     */
-    get _options(): Required<EggApplicationCoreOptions>;
-    protected loadConfig(): Promise<void>;
-    protected load(): Promise<void>;
-    /**
-     * Usage: new ApiClient({ cluster: app.cluster })
-     */
-    get cluster(): (clientClass: unknown, options?: object) => any;
-    /**
-     * Wrap the Client with Leader/Follower Pattern
-     *
-     * @description almost the same as Agent.cluster API, the only different is that this method create Follower.
-     *
-     * @see https://github.com/node-modules/cluster-client
-     * @param {Function} clientClass - client class function
-     * @param {Object} [options]
-     *   - {Boolean} [autoGenerate] - whether generate delegate rule automatically, default is true
-     *   - {Function} [formatKey] - a method to transform the subscription info into a string，default is JSON.stringify
-     *   - {Object} [transcode|JSON.stringify/parse]
-     *     - {Function} encode - custom serialize method
-     *     - {Function} decode - custom deserialize method
-     *   - {Boolean} [isBroadcast] - whether broadcast subscription result to all followers or just one, default is true
-     *   - {Number} [responseTimeout] - response timeout, default is 3 seconds
-     *   - {Number} [maxWaitTime|30000] - leader startup max time, default is 30 seconds
-     * @return {ClientWrapper} wrapper
-     */
-    clusterWrapper(clientClass: unknown, options?: object): any;
-    /**
-     * print the information when console.log(app)
-     * @return {Object} inspected app.
-     * @since 1.0.0
-     * @example
-     * ```js
-     * console.log(app);
-     * =>
-     * {
-     *   name: 'mock-app',
-     *   env: 'test',
-     *   subdomainOffset: 2,
-     *   config: '<egg config>',
-     *   controller: '<egg controller>',
-     *   service: '<egg service>',
-     *   middlewares: '<egg middlewares>',
-     *   urllib: '<egg urllib>',
-     *   loggers: '<egg loggers>'
-     * }
-     * ```
-     */
-    inspect(): any;
-    toJSON(): any;
-    /**
-     * http request helper base on {@link httpclient}, it will auto save httpclient log.
-     * Keep the same api with `httpclient.request(url, args)`.
-     *
-     * See https://github.com/node-modules/urllib#api-doc for more details.
-     *
-     * @param {String} url request url address.
-     * @param {Object} options
-     * - method {String} - Request method, defaults to GET. Could be GET, POST, DELETE or PUT. Alias 'type'.
-     * - data {Object} - Data to be sent. Will be stringify automatically.
-     * - dataType {String} - String - Type of response data. Could be `text` or `json`.
-     *   If it's `text`, the callback data would be a String.
-     *   If it's `json`, the data of callback would be a parsed JSON Object.
-     *   Default callback data would be a Buffer.
-     * - headers {Object} - Request headers.
-     * - timeout {Number} - Request timeout in milliseconds. Defaults to exports.TIMEOUT.
-     *   Include remote server connecting timeout and response timeout.
-     *   When timeout happen, will return ConnectionTimeout or ResponseTimeout.
-     * - auth {String} - `username:password` used in HTTP Basic Authorization.
-     * - followRedirect {Boolean} - follow HTTP 3xx responses as redirects. defaults to false.
-     * - gzip {Boolean} - let you get the res object when request connected, default false. alias customResponse
-     * - nestedQuerystring {Boolean} - urllib default use querystring to stringify form data which don't
-     *   support nested object, will use qs instead of querystring to support nested object by set this option to true.
-     * - more options see https://github.com/node-modules/urllib
-     * @return {Object}
-     * - status {Number} - HTTP response status
-     * - headers {Object} - HTTP response headers
-     * - res {Object} - HTTP response meta
-     * - data {Object} - HTTP response body
-     *
-     * @example
-     * ```js
-     * const result = await app.curl('http://example.com/foo.json', {
-     *   method: 'GET',
-     *   dataType: 'json',
-     * });
-     * console.log(result.status, result.headers, result.data);
-     * ```
-     */
-    curl<T = any>(url: HttpClientRequestURL, options?: HttpClientRequestOptions): Promise<HttpClientResponse<T>>;
-    /**
-     * Create a new HttpClient instance with custom options
-     * @param {Object} [options] HttpClient init options
-     */
-    createHttpClient(options?: HttpClientOptions): HttpClient;
-    /**
-     * HttpClient instance
-     * @see https://github.com/node-modules/urllib
-     * @member {HttpClient}
-     */
-    get httpClient(): HttpClient;
-    /**
-     * @deprecated please use httpClient instead
-     * @alias httpClient
-     * @member {HttpClient}
-     */
-    get httpclient(): HttpClient;
-    /**
-     * All loggers contain logger, coreLogger and customLogger
-     * @member {Object}
-     * @since 1.0.0
-     */
-    get loggers(): EggLoggers;
-    /**
-     * Get logger by name, it's equal to app.loggers['name'],
-     * but you can extend it with your own logical.
-     * @param {String} name - logger name
-     * @return {Logger} logger
-     */
-    getLogger(name: string): EggLogger;
-    /**
-     * application logger, log file is `$HOME/logs/{appname}/{appname}-web`
-     * @member {Logger}
-     * @since 1.0.0
-     */
-    get logger(): EggLogger;
-    /**
-     * core logger for framework and plugins, log file is `$HOME/logs/{appname}/egg-web`
-     * @member {Logger}
-     * @since 1.0.0
-     */
-    get coreLogger(): EggLogger;
-    _unhandledRejectionHandler(err: any): void;
-    /**
-     * dump out the config and meta object
-     * @private
-     */
-    dumpConfigToObject(): {
-        config: Record<string, any>;
-        meta: Record<string, any>;
-    };
-    /**
-     * save app.config to `run/${type}_config.json`
-     * @private
-     */
-    dumpConfig(): void;
-    dumpTiming(): void;
-    get [EGG_PATH](): string;
-    get config(): EggAppConfig;
-    /**
-     * app.env delegate app.config.env
-     * @deprecated
-     */
-    get env(): string;
-    set env(_: string);
-    /**
-     * app.proxy delegate app.config.proxy
-     * @deprecated
-     */
-    get proxy(): boolean;
-    set proxy(_: boolean);
-    /**
-     * Create an anonymous context, the context isn't request level, so the request is mocked.
-     * then you can use context level API like `ctx.service`
-     * @member {String} EggApplication#createAnonymousContext
-     * @param {Request} [req] - if you want to mock request like querystring, you can pass an object to this function.
-     * @return {Context} context
-     */
-    createAnonymousContext(req?: any): EggContext;
-    /**
-     * Run async function in the anonymous context scope
-     * @see Context#runInAnonymousContextScope
-     * @param {Function} scope - the first args is an anonymous ctx, scope should be async function
-     * @param {Request} [req] - if you want to mock request like querystring, you can pass an object to this function.
-     */
-    runInAnonymousContextScope(scope: (ctx: Context) => Promise<void>, req?: unknown): Promise<void>;
-    /**
-     * Create egg context
-     * @function EggApplication#createContext
-     * @param  {Req} req - node native Request object
-     * @param  {Res} res - node native Response object
-     * @return {Context} context object
-     */
-    createContext(req: IncomingMessage, res: ServerResponse): Context;
-}
-declare module '@eggjs/core' {
-    interface EggCore {
-        inspect(): any;
-        get currentContext(): EggContext | undefined;
-        ctxStorage: AsyncLocalStorage<EggContext>;
-        getLogger(name: string): EggLogger;
-        get loggers(): EggLoggers;
-        createHttpClient(options?: HttpClientOptions): HttpClient;
-        HttpClient: typeof HttpClient;
-        get httpClient(): HttpClient;
-        curl<T = any>(url: HttpClientRequestURL, options?: HttpClientRequestOptions): Promise<HttpClientResponse<T>>;
-        createAnonymousContext(req?: any): EggContext;
-        runInAnonymousContextScope(scope: (ctx: Context) => Promise<void>, req?: unknown): Promise<void>;
-        readonly messenger: IMessenger;
-        Subscription: typeof BaseContextClass;
-        BaseHookClass: typeof BaseHookClass;
-        Boot: typeof BaseHookClass;
-    }
-}