egg 4.0.0-beta.4 → 4.0.0-beta.6

package/dist/commonjs/app/extend/context.d.ts

@@ -1,2 +1,151 @@
-declare const Context: any;
-export default Context;
+import { Context as EggCoreContext, Router, type ContextDelegation as EggCoreContextDelegation } from '@eggjs/core';
+import type { Cookies as ContextCookies } from '@eggjs/cookies';
+import type { Application } from '../../lib/application.js';
+import type { ContextHttpClient } from '../../lib/core/context_httpclient.js';
+import type { BaseContextClass } from '../../lib//core/base_context_class.js';
+import Request from './request.js';
+import Response from './response.js';
+import { EggLogger } from 'egg-logger';
+interface Cookies extends ContextCookies {
+    request: any;
+    response: any;
+}
+export default class Context extends EggCoreContext {
+    app: Application;
+    request: Request;
+    service: BaseContextClass;
+    /**
+     * Request start time
+     * @member {Number} Context#starttime
+     */
+    starttime: number;
+    /**
+     * Request start timer using `performance.now()`
+     * @member {Number} Context#performanceStarttime
+     */
+    performanceStarttime: number;
+    /**
+     * Get the current visitor's cookies.
+     */
+    get cookies(): Cookies;
+    /**
+     * Get a wrapper httpclient instance contain ctx in the hold request process
+     *
+     * @return {ContextHttpClient} the wrapper httpclient instance
+     */
+    get httpclient(): ContextHttpClient;
+    /**
+     * Alias to {@link Context#httpclient}
+     */
+    get httpClient(): ContextHttpClient;
+    /**
+     * Shortcut for httpclient.curl
+     *
+     * @function Context#curl
+     * @param {String|Object} url - request url address.
+     * @param {Object} [options] - options for request.
+     * @return {Object} see {@link ContextHttpClient#curl}
+     */
+    curl(url: string, options?: object): ReturnType<ContextHttpClient['curl']>;
+    /**
+     * Alias to {@link Application#router}
+     *
+     * @member {Router} Context#router
+     * @since 1.0.0
+     * @example
+     * ```js
+     * this.router.pathFor('post', { id: 12 });
+     * ```
+     */
+    get router(): Router;
+    /**
+     * Set router to Context, only use on EggRouter
+     * @param {Router} val router instance
+     */
+    set router(val: Router);
+    /**
+     * Get helper instance from {@link Application#Helper}
+     *
+     * @member {Helper} Context#helper
+     * @since 1.0.0
+     */
+    get helper(): unknown;
+    /**
+     * Wrap app.loggers with context information,
+     * if a custom logger is defined by naming aLogger, then you can `ctx.getLogger('aLogger')`
+     *
+     * @param {String} name - logger name
+     */
+    getLogger(name: string): EggLogger;
+    /**
+     * Logger for Application
+     *
+     * @member {Logger} Context#logger
+     * @since 1.0.0
+     * @example
+     * ```js
+     * this.logger.info('some request data: %j', this.request.body);
+     * this.logger.warn('WARNING!!!!');
+     * ```
+     */
+    get logger(): EggLogger;
+    /**
+     * Logger for frameworks and plugins
+     *
+     * @member {Logger} Context#coreLogger
+     * @since 1.0.0
+     */
+    get coreLogger(): EggLogger;
+    /**
+     * locals is an object for view, you can use `app.locals` and `ctx.locals` to set variables,
+     * which will be used as data when view is rendering.
+     * The difference between `app.locals` and `ctx.locals` is the context level, `app.locals` is global level, and `ctx.locals` is request level. when you get `ctx.locals`, it will merge `app.locals`.
+     *
+     * when you set locals, only object is available
+     *
+     * ```js
+     * this.locals = {
+     *   a: 1
+     * };
+     * this.locals = {
+     *   b: 1
+     * };
+     * this.locals.c = 1;
+     * console.log(this.locals);
+     * {
+     *   a: 1,
+     *   b: 1,
+     *   c: 1,
+     * };
+     * ```
+     *
+     * `ctx.locals` has cache, it only merges `app.locals` once in one request.
+     *
+     * @member {Object} Context#locals
+     */
+    get locals(): Record<string, any>;
+    set locals(val: Record<string, any>);
+    /**
+     * alias to {@link Context#locals}, compatible with koa that use this variable
+     * @member {Object} state
+     * @see Context#locals
+     */
+    get state(): Record<string, any>;
+    set state(val: Record<string, any>);
+    /**
+     * Run async function in the background
+     * @param {Function} scope - the first args is ctx
+     * ```js
+     * this.body = 'hi';
+     *
+     * this.runInBackground(async ctx => {
+     *   await ctx.mysql.query(sql);
+     *   await ctx.curl(url);
+     * });
+     * ```
+     */
+    runInBackground(scope: (ctx: ContextDelegation) => Promise<void>, taskName?: string): void;
+    _runInBackground(scope: (ctx: ContextDelegation) => Promise<void>, taskName: string): Promise<void>;
+}
+export type ContextDelegation = EggCoreContextDelegation & Context & Pick<Request, 'acceptJSON' | 'queries' | 'accept' | 'ip'> & Pick<Response, 'realStatus'>;
+export {};

package/dist/commonjs/app/extend/context.js

@@ -3,27 +3,37 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const node_perf_hooks_1 = require("node:perf_hooks");
 const delegates_1 = __importDefault(require("delegates"));
 const utility_1 = require("utility");
+const performance_ms_1 = require("performance-ms");
 const core_1 = require("@eggjs/core");
-const HELPER = Symbol('Context#helper');
-const LOCALS = Symbol('Context#locals');
-const LOCALS_LIST = Symbol('Context#localsList');
-const COOKIES = Symbol('Context#cookies');
-const CONTEXT_LOGGERS = Symbol('Context#logger');
-const CONTEXT_HTTPCLIENT = Symbol('Context#httpclient');
-const CONTEXT_ROUTER = Symbol('Context#router');
-const Context = {
+const HELPER = Symbol('ctx helper');
+const LOCALS = Symbol('ctx locals');
+const LOCALS_LIST = Symbol('ctx localsList');
+const COOKIES = Symbol('ctx cookies');
+const CONTEXT_HTTPCLIENT = Symbol('ctx httpclient');
+const CONTEXT_ROUTER = Symbol('ctx router');
+class Context extends core_1.Context {
+    /**
+     * Request start time
+     * @member {Number} Context#starttime
+     */
+    starttime;
+    /**
+     * Request start timer using `performance.now()`
+     * @member {Number} Context#performanceStarttime
+     */
+    performanceStarttime;
     /**
      * Get the current visitor's cookies.
      */
     get cookies() {
-        if (!this[COOKIES]) {
-            this[COOKIES] = new this.app.ContextCookies(this, this.app.keys, this.app.config.cookies);
+        let cookies = this[COOKIES];
+        if (!cookies) {
+            this[COOKIES] = cookies = new this.app.ContextCookies(this, this.app.keys, this.app.config.cookies);
         }
-        return this[COOKIES];
-    },
+        return cookies;
+    }
     /**
      * Get a wrapper httpclient instance contain ctx in the hold request process
      *
@@ -34,7 +44,13 @@ const Context = {
             this[CONTEXT_HTTPCLIENT] = new this.app.ContextHttpClient(this);
         }
         return this[CONTEXT_HTTPCLIENT];
-    },
+    }
+    /**
+     * Alias to {@link Context#httpclient}
+     */
+    get httpClient() {
+        return this.httpclient;
+    }
     /**
      * Shortcut for httpclient.curl
      *
@@ -43,9 +59,9 @@ const Context = {
      * @param {Object} [options] - options for request.
      * @return {Object} see {@link ContextHttpClient#curl}
      */
-    curl(url, options) {
-        return this.httpclient.curl(url, options);
-    },
+    async curl(url, options) {
+        return await this.httpclient.curl(url, options);
+    }
     /**
      * Alias to {@link Application#router}
      *
@@ -57,18 +73,18 @@ const Context = {
      * ```
      */
     get router() {
-        if (!this[CONTEXT_ROUTER]) {
-            this[CONTEXT_ROUTER] = this.app.router;
+        if (this[CONTEXT_ROUTER]) {
+            return this[CONTEXT_ROUTER];
         }
-        return this[CONTEXT_ROUTER];
-    },
+        return this.app.router;
+    }
     /**
      * Set router to Context, only use on EggRouter
-     * @param {EggRouter} val router instance
+     * @param {Router} val router instance
      */
     set router(val) {
         this[CONTEXT_ROUTER] = val;
-    },
+    }
     /**
      * Get helper instance from {@link Application#Helper}
      *
@@ -80,37 +96,20 @@ const Context = {
             this[HELPER] = new this.app.Helper(this);
         }
         return this[HELPER];
-    },
+    }
     /**
      * Wrap app.loggers with context information,
      * if a custom logger is defined by naming aLogger, then you can `ctx.getLogger('aLogger')`
      *
      * @param {String} name - logger name
-     * @return {Logger} logger
      */
     getLogger(name) {
-        if (this.app.config.logger.enableFastContextLogger) {
-            return this.app.getLogger(name);
-        }
-        let cache = this[CONTEXT_LOGGERS];
-        if (!cache) {
-            cache = this[CONTEXT_LOGGERS] = {};
-        }
-        // read from cache
-        if (cache[name])
-            return cache[name];
-        // get no exist logger
-        const appLogger = this.app.getLogger(name);
-        if (!appLogger)
-            return null;
-        // write to cache
-        cache[name] = new this.app.ContextLogger(this, appLogger);
-        return cache[name];
-    },
+        return this.app.getLogger(name);
+    }
     /**
-     * Logger for Application, wrapping app.coreLogger with context infomation
+     * Logger for Application
      *
-     * @member {ContextLogger} Context#logger
+     * @member {Logger} Context#logger
      * @since 1.0.0
      * @example
      * ```js
@@ -120,17 +119,16 @@ const Context = {
      */
     get logger() {
         return this.getLogger('logger');
-    },
+    }
     /**
-     * Logger for frameworks and plugins,
-     * wrapping app.coreLogger with context infomation
+     * Logger for frameworks and plugins
      *
-     * @member {ContextLogger} Context#coreLogger
+     * @member {Logger} Context#coreLogger
      * @since 1.0.0
      */
     get coreLogger() {
         return this.getLogger('coreLogger');
-    },
+    }
     /**
      * locals is an object for view, you can use `app.locals` and `ctx.locals` to set variables,
      * which will be used as data when view is rendering.
@@ -162,18 +160,17 @@ const Context = {
         if (!this[LOCALS]) {
             this[LOCALS] = (0, utility_1.assign)({}, this.app.locals);
         }
-        if (this[LOCALS_LIST] && this[LOCALS_LIST].length) {
+        if (Array.isArray(this[LOCALS_LIST]) && this[LOCALS_LIST].length > 0) {
             (0, utility_1.assign)(this[LOCALS], this[LOCALS_LIST]);
             this[LOCALS_LIST] = null;
         }
         return this[LOCALS];
-    },
+    }
     set locals(val) {
-        if (!this[LOCALS_LIST]) {
-            this[LOCALS_LIST] = [];
-        }
-        this[LOCALS_LIST].push(val);
-    },
+        const localsList = this[LOCALS_LIST] ?? [];
+        localsList.push(val);
+        this[LOCALS_LIST] = localsList;
+    }
     /**
      * alias to {@link Context#locals}, compatible with koa that use this variable
      * @member {Object} state
@@ -181,10 +178,10 @@ const Context = {
      */
     get state() {
         return this.locals;
-    },
+    }
     set state(val) {
         this.locals = val;
-    },
+    }
     /**
      * Run async function in the background
      * @param {Function} scope - the first args is ctx
@@ -197,37 +194,38 @@ const Context = {
      * });
      * ```
      */
-    runInBackground(scope) {
+    runInBackground(scope, taskName) {
         // try to use custom function name first
-        /* istanbul ignore next */
-        const taskName = Reflect.get(scope, '_name') || scope.name || core_1.utils.getCalleeFromStack(true);
-        this._runInBackground(scope, taskName);
-    },
+        if (!taskName) {
+            taskName = Reflect.get(scope, '_name') || scope.name || core_1.utils.getCalleeFromStack(true);
+        }
+        // use setImmediate to ensure all sync logic will run async
+        setImmediate(() => {
+            this._runInBackground(scope, taskName);
+        });
+    }
     // let plugins or frameworks to reuse _runInBackground in some cases.
     // e.g.: https://github.com/eggjs/egg-mock/pull/78
-    _runInBackground(scope, taskName) {
-        // eslint-disable-next-line @typescript-eslint/no-this-alias
-        const ctx = this;
-        const start = node_perf_hooks_1.performance.now();
-        // use setImmediate to ensure all sync logic will run async
-        return new Promise(resolve => setImmediate(resolve))
-            .then(() => scope(ctx))
-            .then(() => {
-            ctx.coreLogger.info('[egg:background] task:%s success (%dms)', taskName, Math.floor((node_perf_hooks_1.performance.now() - start) * 1000) / 1000);
-        })
-            .catch(err => {
+    async _runInBackground(scope, taskName) {
+        const startTime = (0, performance_ms_1.now)();
+        try {
+            await scope(this);
+            this.coreLogger.info('[egg:background] task:%s success (%dms)', taskName, (0, performance_ms_1.diff)(startTime));
+        }
+        catch (err) {
             // background task process log
-            ctx.coreLogger.info('[egg:background] task:%s fail (%dms)', taskName, Math.floor((node_perf_hooks_1.performance.now() - start) * 1000) / 1000);
+            this.coreLogger.info('[egg:background] task:%s fail (%dms)', taskName, (0, performance_ms_1.diff)(startTime));
             // emit error when promise catch, and set err.runInBackground flag
             err.runInBackground = true;
-            ctx.app.emit('error', err, ctx);
-        });
-    },
-};
+            this.app.emit('error', err, this);
+        }
+    }
+}
+exports.default = Context;
 /**
  * Context delegation.
  */
-(0, delegates_1.default)(Context, 'request')
+(0, delegates_1.default)(Context.prototype, 'request')
     /**
      * @member {Boolean} Context#acceptJSON
      * @see Request#acceptJSON
@@ -252,12 +250,11 @@ const Context = {
      * @since 1.0.0
      */
     .access('ip');
-(0, delegates_1.default)(Context, 'response')
+(0, delegates_1.default)(Context.prototype, 'response')
     /**
      * @member {Number} Context#realStatus
      * @see Response#realStatus
      * @since 1.0.0
      */
     .access('realStatus');
-exports.default = Context;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udGV4dC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9hcHAvZXh0ZW5kL2NvbnRleHQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSxxREFBOEM7QUFDOUMsMERBQWlDO0FBQ2pDLHFDQUFpQztBQUNqQyxzQ0FBb0M7QUFFcEMsTUFBTSxNQUFNLEdBQUcsTUFBTSxDQUFDLGdCQUFnQixDQUFDLENBQUM7QUFDeEMsTUFBTSxNQUFNLEdBQUcsTUFBTSxDQUFDLGdCQUFnQixDQUFDLENBQUM7QUFDeEMsTUFBTSxXQUFXLEdBQUcsTUFBTSxDQUFDLG9CQUFvQixDQUFDLENBQUM7QUFDakQsTUFBTSxPQUFPLEdBQUcsTUFBTSxDQUFDLGlCQUFpQixDQUFDLENBQUM7QUFDMUMsTUFBTSxlQUFlLEdBQUcsTUFBTSxDQUFDLGdCQUFnQixDQUFDLENBQUM7QUFDakQsTUFBTSxrQkFBa0IsR0FBRyxNQUFNLENBQUMsb0JBQW9CLENBQUMsQ0FBQztBQUN4RCxNQUFNLGNBQWMsR0FBRyxNQUFNLENBQUMsZ0JBQWdCLENBQUMsQ0FBQztBQUVoRCxNQUFNLE9BQU8sR0FBRztJQUNkOztPQUVHO0lBQ0gsSUFBSSxPQUFPO1FBQ1QsSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsRUFBRSxDQUFDO1lBQ25CLElBQUksQ0FBQyxPQUFPLENBQUMsR0FBRyxJQUFJLElBQUksQ0FBQyxHQUFHLENBQUMsY0FBYyxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUM1RixDQUFDO1FBQ0QsT0FBTyxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDdkIsQ0FBQztJQUVEOzs7O09BSUc7SUFDSCxJQUFJLFVBQVU7UUFDWixJQUFJLENBQUMsSUFBSSxDQUFDLGtCQUFrQixDQUFDLEVBQUUsQ0FBQztZQUM5QixJQUFJLENBQUMsa0JBQWtCLENBQUMsR0FBRyxJQUFJLElBQUksQ0FBQyxHQUFHLENBQUMsaUJBQWlCLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDbEUsQ0FBQztRQUNELE9BQU8sSUFBSSxDQUFDLGtCQUFrQixDQUFDLENBQUM7SUFDbEMsQ0FBQztJQUVEOzs7Ozs7O09BT0c7SUFDSCxJQUFJLENBQUMsR0FBVyxFQUFFLE9BQWdCO1FBQ2hDLE9BQU8sSUFBSSxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLE9BQU8sQ0FBQyxDQUFDO0lBQzVDLENBQUM7SUFFRDs7Ozs7Ozs7O09BU0c7SUFDSCxJQUFJLE1BQU07UUFDUixJQUFJLENBQUMsSUFBSSxDQUFDLGNBQWMsQ0FBQyxFQUFFLENBQUM7WUFDMUIsSUFBSSxDQUFDLGNBQWMsQ0FBQyxHQUFHLElBQUksQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDO1FBQ3pDLENBQUM7UUFDRCxPQUFPLElBQUksQ0FBQyxjQUFjLENBQUMsQ0FBQztJQUM5QixDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsSUFBSSxNQUFNLENBQUMsR0FBRztRQUNaLElBQUksQ0FBQyxjQUFjLENBQUMsR0FBRyxHQUFHLENBQUM7SUFDN0IsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0gsSUFBSSxNQUFNO1FBQ1IsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUFDO1lBQ2xCLElBQUksQ0FBQyxNQUFNLENBQUMsR0FBRyxJQUFJLElBQUksQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQzNDLENBQUM7UUFDRCxPQUFPLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUN0QixDQUFDO0lBRUQ7Ozs7OztPQU1HO0lBQ0gsU0FBUyxDQUFDLElBQVk7UUFDcEIsSUFBSSxJQUFJLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsdUJBQXVCLEVBQUUsQ0FBQztZQUNuRCxPQUFPLElBQUksQ0FBQyxHQUFHLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQ2xDLENBQUM7UUFDRCxJQUFJLEtBQUssR0FBRyxJQUFJLENBQUMsZUFBZSxDQUFDLENBQUM7UUFDbEMsSUFBSSxDQUFDLEtBQUssRUFBRSxDQUFDO1lBQ1gsS0FBSyxHQUFHLElBQUksQ0FBQyxlQUFlLENBQUMsR0FBRyxFQUFFLENBQUM7UUFDckMsQ0FBQztRQUVELGtCQUFrQjtRQUNsQixJQUFJLEtBQUssQ0FBQyxJQUFJLENBQUM7WUFBRSxPQUFPLEtBQUssQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUVwQyxzQkFBc0I7UUFDdEIsTUFBTSxTQUFTLEdBQUcsSUFBSSxDQUFDLEdBQUcsQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDM0MsSUFBSSxDQUFDLFNBQVM7WUFBRSxPQUFPLElBQUksQ0FBQztRQUU1QixpQkFBaUI7UUFDakIsS0FBSyxDQUFDLElBQUksQ0FBQyxHQUFHLElBQUksSUFBSSxDQUFDLEdBQUcsQ0FBQyxhQUFhLENBQUMsSUFBSSxFQUFFLFNBQVMsQ0FBQyxDQUFDO1FBQzFELE9BQU8sS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQ3JCLENBQUM7SUFFRDs7Ozs7Ozs7OztPQVVHO0lBQ0gsSUFBSSxNQUFNO1FBQ1IsT0FBTyxJQUFJLENBQUMsU0FBUyxDQUFDLFFBQVEsQ0FBQyxDQUFDO0lBQ2xDLENBQUM7SUFFRDs7Ozs7O09BTUc7SUFDSCxJQUFJLFVBQVU7UUFDWixPQUFPLElBQUksQ0FBQyxTQUFTLENBQUMsWUFBWSxDQUFDLENBQUM7SUFDdEMsQ0FBQztJQUVEOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztPQTBCRztJQUNILElBQUksTUFBTTtRQUNSLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQztZQUNsQixJQUFJLENBQUMsTUFBTSxDQUFDLEdBQUcsSUFBQSxnQkFBTSxFQUFDLEVBQUUsRUFBRSxJQUFJLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxDQUFDO1FBQzdDLENBQUM7UUFDRCxJQUFJLElBQUksQ0FBQyxXQUFXLENBQUMsSUFBSSxJQUFJLENBQUMsV0FBVyxDQUFDLENBQUMsTUFBTSxFQUFFLENBQUM7WUFDbEQsSUFBQSxnQkFBTSxFQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsRUFBRSxJQUFJLENBQUMsV0FBVyxDQUFDLENBQUMsQ0FBQztZQUN4QyxJQUFJLENBQUMsV0FBVyxDQUFDLEdBQUcsSUFBSSxDQUFDO1FBQzNCLENBQUM7UUFDRCxPQUFPLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUN0QixDQUFDO0lBRUQsSUFBSSxNQUFNLENBQUMsR0FBRztRQUNaLElBQUksQ0FBQyxJQUFJLENBQUMsV0FBVyxDQUFDLEVBQUUsQ0FBQztZQUN2QixJQUFJLENBQUMsV0FBVyxDQUFDLEdBQUcsRUFBRSxDQUFDO1FBQ3pCLENBQUM7UUFDRCxJQUFJLENBQUMsV0FBVyxDQUFDLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQzlCLENBQUM7SUFFRDs7OztPQUlHO0lBQ0gsSUFBSSxLQUFLO1FBQ1AsT0FBTyxJQUFJLENBQUMsTUFBTSxDQUFDO0lBQ3JCLENBQUM7SUFFRCxJQUFJLEtBQUssQ0FBQyxHQUFHO1FBQ1gsSUFBSSxDQUFDLE1BQU0sR0FBRyxHQUFHLENBQUM7SUFDcEIsQ0FBQztJQUVEOzs7Ozs7Ozs7OztPQVdHO0lBQ0gsZUFBZSxDQUFDLEtBQWtDO1FBQ2hELHdDQUF3QztRQUN4QywwQkFBMEI7UUFDMUIsTUFBTSxRQUFRLEdBQUcsT0FBTyxDQUFDLEdBQUcsQ0FBQyxLQUFLLEVBQUUsT0FBTyxDQUFDLElBQUksS0FBSyxDQUFDLElBQUksSUFBSSxZQUFLLENBQUMsa0JBQWtCLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDN0YsSUFBSSxDQUFDLGdCQUFnQixDQUFDLEtBQUssRUFBRSxRQUFRLENBQUMsQ0FBQztJQUN6QyxDQUFDO0lBRUQscUVBQXFFO0lBQ3JFLGtEQUFrRDtJQUNsRCxnQkFBZ0IsQ0FBQyxLQUFrQyxFQUFFLFFBQWdCO1FBQ25FLDREQUE0RDtRQUM1RCxNQUFNLEdBQUcsR0FBRyxJQUFJLENBQUM7UUFDakIsTUFBTSxLQUFLLEdBQUcsNkJBQVcsQ0FBQyxHQUFHLEVBQUUsQ0FBQztRQUNoQywyREFBMkQ7UUFDM0QsT0FBTyxJQUFJLE9BQU8sQ0FBQyxPQUFPLENBQUMsRUFBRSxDQUFDLFlBQVksQ0FBQyxPQUFPLENBQUMsQ0FBQzthQUNqRCxJQUFJLENBQUMsR0FBRyxFQUFFLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDO2FBQ3RCLElBQUksQ0FBQyxHQUFHLEVBQUU7WUFDVCxHQUFHLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyx5Q0FBeUMsRUFDM0QsUUFBUSxFQUFFLElBQUksQ0FBQyxLQUFLLENBQUMsQ0FBQyw2QkFBVyxDQUFDLEdBQUcsRUFBRSxHQUFHLEtBQUssQ0FBQyxHQUFHLElBQUksQ0FBQyxHQUFHLElBQUksQ0FBQyxDQUFDO1FBQ3JFLENBQUMsQ0FBQzthQUNELEtBQUssQ0FBQyxHQUFHLENBQUMsRUFBRTtZQUNYLDhCQUE4QjtZQUM5QixHQUFHLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxzQ0FBc0MsRUFDeEQsUUFBUSxFQUFFLElBQUksQ0FBQyxLQUFLLENBQUMsQ0FBQyw2QkFBVyxDQUFDLEdBQUcsRUFBRSxHQUFHLEtBQUssQ0FBQyxHQUFHLElBQUksQ0FBQyxHQUFHLElBQUksQ0FBQyxDQUFDO1lBRW5FLGtFQUFrRTtZQUNsRSxHQUFHLENBQUMsZUFBZSxHQUFHLElBQUksQ0FBQztZQUMzQixHQUFHLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxPQUFPLEVBQUUsR0FBRyxFQUFFLEdBQUcsQ0FBQyxDQUFDO1FBQ2xDLENBQUMsQ0FBQyxDQUFDO0lBQ1AsQ0FBQztDQUNLLENBQUM7QUFFVDs7R0FFRztBQUVILElBQUEsbUJBQVEsRUFBQyxPQUFPLEVBQUUsU0FBUyxDQUFDO0lBQzFCOzs7O09BSUc7S0FDRixNQUFNLENBQUMsWUFBWSxDQUFDO0lBQ3JCOzs7O09BSUc7S0FDRixNQUFNLENBQUMsU0FBUyxDQUFDO0lBQ2xCOzs7O09BSUc7S0FDRixNQUFNLENBQUMsUUFBUSxDQUFDO0lBQ2pCOzs7O09BSUc7S0FDRixNQUFNLENBQUMsSUFBSSxDQUFDLENBQUM7QUFFaEIsSUFBQSxtQkFBUSxFQUFDLE9BQU8sRUFBRSxVQUFVLENBQUM7SUFDM0I7Ozs7T0FJRztLQUNGLE1BQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQztBQUV4QixrQkFBZSxPQUFPLENBQUMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udGV4dC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9hcHAvZXh0ZW5kL2NvbnRleHQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSwwREFBaUM7QUFDakMscUNBQWlDO0FBQ2pDLG1EQUEyQztBQUMzQyxzQ0FHcUI7QUFTckIsTUFBTSxNQUFNLEdBQUcsTUFBTSxDQUFDLFlBQVksQ0FBQyxDQUFDO0FBQ3BDLE1BQU0sTUFBTSxHQUFHLE1BQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQztBQUNwQyxNQUFNLFdBQVcsR0FBRyxNQUFNLENBQUMsZ0JBQWdCLENBQUMsQ0FBQztBQUM3QyxNQUFNLE9BQU8sR0FBRyxNQUFNLENBQUMsYUFBYSxDQUFDLENBQUM7QUFDdEMsTUFBTSxrQkFBa0IsR0FBRyxNQUFNLENBQUMsZ0JBQWdCLENBQUMsQ0FBQztBQUNwRCxNQUFNLGNBQWMsR0FBRyxNQUFNLENBQUMsWUFBWSxDQUFDLENBQUM7QUFPNUMsTUFBcUIsT0FBUSxTQUFRLGNBQWM7SUFLakQ7OztPQUdHO0lBQ0gsU0FBUyxDQUFTO0lBQ2xCOzs7T0FHRztJQUNILG9CQUFvQixDQUFTO0lBRTdCOztPQUVHO0lBQ0gsSUFBSSxPQUFPO1FBQ1QsSUFBSSxPQUFPLEdBQUcsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDO1FBQzVCLElBQUksQ0FBQyxPQUFPLEVBQUUsQ0FBQztZQUNiLElBQUksQ0FBQyxPQUFPLENBQUMsR0FBRyxPQUFPLEdBQUcsSUFBSSxJQUFJLENBQUMsR0FBRyxDQUFDLGNBQWMsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLEdBQUcsQ0FBQyxNQUFNLENBQUMsT0FBTyxDQUFDLENBQUM7UUFDdEcsQ0FBQztRQUNELE9BQU8sT0FBa0IsQ0FBQztJQUM1QixDQUFDO0lBRUQ7Ozs7T0FJRztJQUNILElBQUksVUFBVTtRQUNaLElBQUksQ0FBQyxJQUFJLENBQUMsa0JBQWtCLENBQUMsRUFBRSxDQUFDO1lBQzlCLElBQUksQ0FBQyxrQkFBa0IsQ0FBQyxHQUFHLElBQUksSUFBSSxDQUFDLEdBQUcsQ0FBQyxpQkFBaUIsQ0FBQyxJQUFXLENBQUMsQ0FBQztRQUN6RSxDQUFDO1FBQ0QsT0FBTyxJQUFJLENBQUMsa0JBQWtCLENBQXNCLENBQUM7SUFDdkQsQ0FBQztJQUVEOztPQUVHO0lBQ0gsSUFBSSxVQUFVO1FBQ1osT0FBTyxJQUFJLENBQUMsVUFBVSxDQUFDO0lBQ3pCLENBQUM7SUFFRDs7Ozs7OztPQU9HO0lBQ0gsS0FBSyxDQUFDLElBQUksQ0FBQyxHQUFXLEVBQUUsT0FBZ0I7UUFDdEMsT0FBTyxNQUFNLElBQUksQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRSxPQUFPLENBQUMsQ0FBQztJQUNsRCxDQUFDO0lBRUQ7Ozs7Ozs7OztPQVNHO0lBQ0gsSUFBSSxNQUFNO1FBQ1IsSUFBSSxJQUFJLENBQUMsY0FBYyxDQUFDLEVBQUUsQ0FBQztZQUN6QixPQUFPLElBQUksQ0FBQyxjQUFjLENBQVcsQ0FBQztRQUN4QyxDQUFDO1FBQ0QsT0FBTyxJQUFJLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQztJQUN6QixDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsSUFBSSxNQUFNLENBQUMsR0FBVztRQUNwQixJQUFJLENBQUMsY0FBYyxDQUFDLEdBQUcsR0FBRyxDQUFDO0lBQzdCLENBQUM7SUFFRDs7Ozs7T0FLRztJQUNILElBQUksTUFBTTtRQUNSLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQztZQUNsQixJQUFJLENBQUMsTUFBTSxDQUFDLEdBQUcsSUFBSSxJQUFJLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxJQUFXLENBQUMsQ0FBQztRQUNsRCxDQUFDO1FBQ0QsT0FBTyxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUM7SUFDdEIsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0gsU0FBUyxDQUFDLElBQVk7UUFDcEIsT0FBTyxJQUFJLENBQUMsR0FBRyxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUNsQyxDQUFDO0lBRUQ7Ozs7Ozs7Ozs7T0FVRztJQUNILElBQUksTUFBTTtRQUNSLE9BQU8sSUFBSSxDQUFDLFNBQVMsQ0FBQyxRQUFRLENBQUMsQ0FBQztJQUNsQyxDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSCxJQUFJLFVBQVU7UUFDWixPQUFPLElBQUksQ0FBQyxTQUFTLENBQUMsWUFBWSxDQUFDLENBQUM7SUFDdEMsQ0FBQztJQUVEOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztPQTBCRztJQUNILElBQUksTUFBTTtRQUNSLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQztZQUNsQixJQUFJLENBQUMsTUFBTSxDQUFDLEdBQUcsSUFBQSxnQkFBTSxFQUFDLEVBQUUsRUFBRSxJQUFJLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxDQUFDO1FBQzdDLENBQUM7UUFDRCxJQUFJLEtBQUssQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFDLElBQUksSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFDLE1BQU0sR0FBRyxDQUFDLEVBQUUsQ0FBQztZQUNyRSxJQUFBLGdCQUFNLEVBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxFQUFFLElBQUksQ0FBQyxXQUFXLENBQUMsQ0FBQyxDQUFDO1lBQ3hDLElBQUksQ0FBQyxXQUFXLENBQUMsR0FBRyxJQUFJLENBQUM7UUFDM0IsQ0FBQztRQUNELE9BQU8sSUFBSSxDQUFDLE1BQU0sQ0FBd0IsQ0FBQztJQUM3QyxDQUFDO0lBRUQsSUFBSSxNQUFNLENBQUMsR0FBRztRQUNaLE1BQU0sVUFBVSxHQUFHLElBQUksQ0FBQyxXQUFXLENBQTBCLElBQUksRUFBRSxDQUFDO1FBQ3BFLFVBQVUsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLENBQUM7UUFDckIsSUFBSSxDQUFDLFdBQVcsQ0FBQyxHQUFHLFVBQVUsQ0FBQztJQUNqQyxDQUFDO0lBRUQ7Ozs7T0FJRztJQUNILElBQUksS0FBSztRQUNQLE9BQU8sSUFBSSxDQUFDLE1BQU0sQ0FBQztJQUNyQixDQUFDO0lBRUQsSUFBSSxLQUFLLENBQUMsR0FBRztRQUNYLElBQUksQ0FBQyxNQUFNLEdBQUcsR0FBRyxDQUFDO0lBQ3BCLENBQUM7SUFFRDs7Ozs7Ozs7Ozs7T0FXRztJQUNILGVBQWUsQ0FBQyxLQUFnRCxFQUFFLFFBQWlCO1FBQ2pGLHdDQUF3QztRQUN4QyxJQUFJLENBQUMsUUFBUSxFQUFFLENBQUM7WUFDZCxRQUFRLEdBQUcsT0FBTyxDQUFDLEdBQUcsQ0FBQyxLQUFLLEVBQUUsT0FBTyxDQUFDLElBQUksS0FBSyxDQUFDLElBQUksSUFBSSxZQUFLLENBQUMsa0JBQWtCLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDekYsQ0FBQztRQUNELDJEQUEyRDtRQUMzRCxZQUFZLENBQUMsR0FBRyxFQUFFO1lBQ2hCLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxLQUFLLEVBQUUsUUFBUyxDQUFDLENBQUM7UUFDMUMsQ0FBQyxDQUFDLENBQUM7SUFDTCxDQUFDO0lBRUQscUVBQXFFO0lBQ3JFLGtEQUFrRDtJQUNsRCxLQUFLLENBQUMsZ0JBQWdCLENBQUMsS0FBZ0QsRUFBRSxRQUFnQjtRQUN2RixNQUFNLFNBQVMsR0FBRyxJQUFBLG9CQUFHLEdBQUUsQ0FBQztRQUN4QixJQUFJLENBQUM7WUFDSCxNQUFNLEtBQUssQ0FBQyxJQUFXLENBQUMsQ0FBQztZQUN6QixJQUFJLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyx5Q0FBeUMsRUFBRSxRQUFRLEVBQUUsSUFBQSxxQkFBSSxFQUFDLFNBQVMsQ0FBQyxDQUFDLENBQUM7UUFDN0YsQ0FBQztRQUFDLE9BQU8sR0FBUSxFQUFFLENBQUM7WUFDbEIsOEJBQThCO1lBQzlCLElBQUksQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLHNDQUFzQyxFQUFFLFFBQVEsRUFBRSxJQUFBLHFCQUFJLEVBQUMsU0FBUyxDQUFDLENBQUMsQ0FBQztZQUV4RixrRUFBa0U7WUFDbEUsR0FBRyxDQUFDLGVBQWUsR0FBRyxJQUFJLENBQUM7WUFDM0IsSUFBSSxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsT0FBTyxFQUFFLEdBQUcsRUFBRSxJQUFJLENBQUMsQ0FBQztRQUNwQyxDQUFDO0lBQ0gsQ0FBQztDQUNGO0FBbk9ELDBCQW1PQztBQUVEOztHQUVHO0FBRUgsSUFBQSxtQkFBUSxFQUFDLE9BQU8sQ0FBQyxTQUFTLEVBQUUsU0FBUyxDQUFDO0lBQ3BDOzs7O09BSUc7S0FDRixNQUFNLENBQUMsWUFBWSxDQUFDO0lBQ3JCOzs7O09BSUc7S0FDRixNQUFNLENBQUMsU0FBUyxDQUFDO0lBQ2xCOzs7O09BSUc7S0FDRixNQUFNLENBQUMsUUFBUSxDQUFDO0lBQ2pCOzs7O09BSUc7S0FDRixNQUFNLENBQUMsSUFBSSxDQUFDLENBQUM7QUFFaEIsSUFBQSxtQkFBUSxFQUFDLE9BQU8sQ0FBQyxTQUFTLEVBQUUsVUFBVSxDQUFDO0lBQ3JDOzs7O09BSUc7S0FDRixNQUFNLENBQUMsWUFBWSxDQUFDLENBQUMifQ==

package/dist/commonjs/app/extend/helper.d.ts

@@ -0,0 +1,37 @@
+import { BaseContextClass } from '../../lib/core/base_context_class.js';
+/**
+ * The Helper class which can be used as utility function.
+ * We support developers to extend Helper through ${baseDir}/app/extend/helper.js ,
+ * then you can use all method on `ctx.helper` that is a instance of Helper.
+ */
+export default class Helper extends BaseContextClass {
+    /**
+     * Generate URL path(without host) for route. Takes the route name and a map of named params.
+     * @function Helper#pathFor
+     * @param {String} name - Router Name
+     * @param {Object} params - Other params
+     *
+     * @example
+     * ```js
+     * app.get('home', '/index.htm', 'home.index');
+     * ctx.helper.pathFor('home', { by: 'recent', limit: 20 })
+     * => /index.htm?by=recent&limit=20
+     * ```
+     * @return {String} url path(without host)
+     */
+    pathFor(name: string, params: Record<string, any>): string;
+    /**
+     * Generate full URL(with host) for route. Takes the route name and a map of named params.
+     * @function Helper#urlFor
+     * @param {String} name - Router name
+     * @param {Object} params - Other params
+     * @example
+     * ```js
+     * app.get('home', '/index.htm', 'home.index');
+     * ctx.helper.urlFor('home', { by: 'recent', limit: 20 })
+     * => http://127.0.0.1:7001/index.htm?by=recent&limit=20
+     * ```
+     * @return {String} full url(with host)
+     */
+    urlFor(name: string, params: Record<string, any>): string;
+}

package/dist/commonjs/app/extend/helper.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_url_1 = __importDefault(require("node:url"));
+const base_context_class_js_1 = require("../../lib/core/base_context_class.js");
+/**
+ * The Helper class which can be used as utility function.
+ * We support developers to extend Helper through ${baseDir}/app/extend/helper.js ,
+ * then you can use all method on `ctx.helper` that is a instance of Helper.
+ */
+class Helper extends base_context_class_js_1.BaseContextClass {
+    /**
+     * Generate URL path(without host) for route. Takes the route name and a map of named params.
+     * @function Helper#pathFor
+     * @param {String} name - Router Name
+     * @param {Object} params - Other params
+     *
+     * @example
+     * ```js
+     * app.get('home', '/index.htm', 'home.index');
+     * ctx.helper.pathFor('home', { by: 'recent', limit: 20 })
+     * => /index.htm?by=recent&limit=20
+     * ```
+     * @return {String} url path(without host)
+     */
+    pathFor(name, params) {
+        return this.app.router.url(name, params);
+    }
+    /**
+     * Generate full URL(with host) for route. Takes the route name and a map of named params.
+     * @function Helper#urlFor
+     * @param {String} name - Router name
+     * @param {Object} params - Other params
+     * @example
+     * ```js
+     * app.get('home', '/index.htm', 'home.index');
+     * ctx.helper.urlFor('home', { by: 'recent', limit: 20 })
+     * => http://127.0.0.1:7001/index.htm?by=recent&limit=20
+     * ```
+     * @return {String} full url(with host)
+     */
+    urlFor(name, params) {
+        return this.ctx.protocol + '://' + this.ctx.host + node_url_1.default.resolve('/', this.pathFor(name, params));
+    }
+}
+exports.default = Helper;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVscGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2FwcC9leHRlbmQvaGVscGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBQUEsd0RBQTJCO0FBQzNCLGdGQUF3RTtBQUV4RTs7OztHQUlHO0FBQ0gsTUFBcUIsTUFBTyxTQUFRLHdDQUFnQjtJQUNsRDs7Ozs7Ozs7Ozs7OztPQWFHO0lBQ0gsT0FBTyxDQUFDLElBQVksRUFBRSxNQUEyQjtRQUMvQyxPQUFPLElBQUksQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsTUFBTSxDQUFDLENBQUM7SUFDM0MsQ0FBQztJQUVEOzs7Ozs7Ozs7Ozs7T0FZRztJQUNILE1BQU0sQ0FBQyxJQUFZLEVBQUUsTUFBMkI7UUFDOUMsT0FBTyxJQUFJLENBQUMsR0FBRyxDQUFDLFFBQVEsR0FBRyxLQUFLLEdBQUcsSUFBSSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEdBQUcsa0JBQUcsQ0FBQyxPQUFPLENBQUMsR0FBRyxFQUFFLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxFQUFFLE1BQU0sQ0FBQyxDQUFDLENBQUM7SUFDbEcsQ0FBQztDQUNGO0FBbkNELHlCQW1DQyJ9

package/dist/commonjs/app/extend/request.d.ts

@@ -0,0 +1,128 @@
+import { Request as EggCoreRequest } from '@eggjs/core';
+import type { Application } from '../../lib/application.js';
+import type { ContextDelegation } from './context.js';
+import Response from './response.js';
+export default class Request extends EggCoreRequest {
+    app: Application;
+    ctx: ContextDelegation;
+    response: Response;
+    /**
+     * Parse the "Host" header field host
+     * and support X-Forwarded-Host when a
+     * proxy is enabled.
+     * @member {String} Request#host
+     * @example
+     * ip + port
+     * ```js
+     * this.request.host
+     * => '127.0.0.1:7001'
+     * ```
+     * or domain
+     * ```js
+     * this.request.host
+     * => 'demo.eggjs.org'
+     * ```
+     */
+    get host(): string;
+    /**
+     * @member {String} Request#protocol
+     * @example
+     * ```js
+     * this.request.protocol
+     * => 'https'
+     * ```
+     */
+    get protocol(): string;
+    /**
+     * Get all pass through ip addresses from the request.
+     * Enable only on `app.config.proxy = true`
+     *
+     * @member {Array} Request#ips
+     * @example
+     * ```js
+     * this.request.ips
+     * => ['100.23.1.2', '201.10.10.2']
+     * ```
+     */
+    get ips(): string[];
+    /**
+     * Get the request remote IPv4 address
+     * @member {String} Request#ip
+     * @return {String} IPv4 address
+     * @example
+     * ```js
+     * this.request.ip
+     * => '127.0.0.1'
+     * => '111.10.2.1'
+     * ```
+     */
+    get ip(): string;
+    /**
+     * Set the request remote IPv4 address
+     * @member {String} Request#ip
+     * @param {String} ip - IPv4 address
+     * @example
+     * ```js
+     * this.request.ip
+     * => '127.0.0.1'
+     * => '111.10.2.1'
+     * ```
+     */
+    set ip(ip: string);
+    /**
+     * detect if response should be json
+     * 1. url path ends with `.json`
+     * 2. response type is set to json
+     * 3. detect by request accept header
+     *
+     * @member {Boolean} Request#acceptJSON
+     * @since 1.0.0
+     */
+    get acceptJSON(): boolean;
+    _customQuery(cacheName: symbol, filter: (value: string | string[]) => string | string[]): Record<string, string | string[]>;
+    /**
+     * get params pass by querystring, all values are of string type.
+     * @member {Object} Request#query
+     * @example
+     * ```js
+     * GET http://127.0.0.1:7001?name=Foo&age=20&age=21
+     * this.query
+     * => { 'name': 'Foo', 'age': '20' }
+     *
+     * GET http://127.0.0.1:7001?a=b&a=c&o[foo]=bar&b[]=1&b[]=2&e=val
+     * this.query
+     * =>
+     * {
+     *   "a": "b",
+     *   "o[foo]": "bar",
+     *   "b[]": "1",
+     *   "e": "val"
+     * }
+     * ```
+     */
+    get query(): Record<string, string>;
+    /**
+     * get params pass by querystring, all value are Array type. {@link Request#query}
+     * @member {Array} Request#queries
+     * @example
+     * ```js
+     * GET http://127.0.0.1:7001?a=b&a=c&o[foo]=bar&b[]=1&b[]=2&e=val
+     * this.queries
+     * =>
+     * {
+     *   "a": ["b", "c"],
+     *   "o[foo]": ["bar"],
+     *   "b[]": ["1", "2"],
+     *   "e": ["val"]
+     * }
+     * ```
+     */
+    get queries(): Record<string, string[]>;
+    /**
+     * Set query-string as an object.
+     *
+     * @function Request#query
+     * @param {Object} obj set querystring and query object for request.
+     */
+    set query(obj: Record<string, string>);
+}