@eggjs/koa 3.1.0-beta.35 → 3.1.0-beta.36

package/dist/application.d.ts

@@ -1,114 +1,117 @@
-import type { AsyncLocalStorage } from 'node:async_hooks';
-import Emitter from 'node:events';
-import http, { type IncomingMessage, type ServerResponse } from 'node:http';
-import { HttpError } from 'http-errors';
-import { Context } from './context.ts';
-import { Request } from './request.ts';
-import { Response } from './response.ts';
-import type { CustomError, AnyProto } from './types.ts';
-export { Context, Request, Response };
-export type ProtoImplClass<T = object> = new (...args: any[]) => T;
-export type Next = () => Promise<void>;
+import { Response } from "./response.js";
+import { Request } from "./request.js";
+import { AnyProto, CustomError } from "./types.js";
+import { Context } from "./context.js";
+import Emitter from "node:events";
+import http, { IncomingMessage, ServerResponse } from "node:http";
+import { HttpError } from "http-errors";
+import { AsyncLocalStorage } from "node:async_hooks";
+
+//#region src/application.d.ts
+type ProtoImplClass<T = object> = new (...args: any[]) => T;
+type Next = () => Promise<void>;
 type _MiddlewareFunc<T> = (ctx: T, next: Next) => Promise<void> | void;
-export type MiddlewareFunc<T extends Context = Context> = _MiddlewareFunc<T> & {
-    _name?: string;
+type MiddlewareFunc<T extends Context = Context> = _MiddlewareFunc<T> & {
+  _name?: string;
 };
 /**
- * Expose `Application` class.
- * Inherits from `Emitter.prototype`.
- */
-export declare class Application extends Emitter {
-    [key: symbol]: unknown;
-    /**
-     * Make HttpError available to consumers of the library so that consumers don't
-     * have a direct dependency upon `http-errors`
-     */
-    static HttpError: typeof HttpError;
-    protected _proxy: boolean;
-    protected _env: string;
-    subdomainOffset: number;
-    proxyIpHeader: string;
-    maxIpsCount: number;
-    protected _keys?: string[];
-    middleware: MiddlewareFunc<Context>[];
-    ctxStorage: AsyncLocalStorage<Context>;
-    silent: boolean;
-    ContextClass: ProtoImplClass<Context>;
-    context: AnyProto;
-    RequestClass: ProtoImplClass<Request>;
-    request: AnyProto;
-    ResponseClass: ProtoImplClass<Response>;
-    response: AnyProto;
-    /**
-     * Initialize a new `Application`.
-     *
-     * @param {object} [options] Application options
-     * @param {string} [options.env] Environment, default is `development`
-     * @param {string[]} [options.keys] Signed cookie keys
-     * @param {boolean} [options.proxy] Trust proxy headers
-     * @param {number} [options.subdomainOffset] Subdomain offset
-     * @param {string} [options.proxyIpHeader] Proxy IP header, defaults to X-Forwarded-For
-     * @param {number} [options.maxIpsCount] Max IPs read from proxy IP header, default to 0 (means infinity)
-     */
-    constructor(options?: {
-        proxy?: boolean;
-        subdomainOffset?: number;
-        proxyIpHeader?: string;
-        maxIpsCount?: number;
-        env?: string;
-        keys?: string[];
-    });
-    get keys(): string[] | undefined;
-    set keys(value: string[] | undefined);
-    get env(): string;
-    set env(value: string);
-    get proxy(): boolean;
-    set proxy(value: boolean);
-    /**
-     * Shorthand for:
-     *
-     *    http.createServer(app.callback()).listen(...)
-     */
-    listen(...args: any[]): http.Server;
-    /**
-     * Return JSON representation.
-     * We only bother showing settings.
-     */
-    toJSON(): object;
-    /**
-     * Inspect implementation.
-     */
-    inspect(): object;
-    /**
-     * Use the given middleware `fn`.
-     */
-    use<T extends Context = Context>(fn: MiddlewareFunc<T>): this;
-    /**
-     * Return a request handler callback
-     * for node's native http server.
-     */
-    callback(): (req: IncomingMessage, res: ServerResponse) => Promise<void>;
-    /**
-     * return current context from async local storage
-     */
-    get currentContext(): Context | undefined;
-    /**
-     * Handle request in callback.
-     * @private
-     */
-    protected handleRequest(ctx: Context, fnMiddleware: (ctx: Context) => Promise<void>): Promise<void>;
-    /**
-     * Initialize a new context.
-     * @private
-     */
-    createContext(req: IncomingMessage, res: ServerResponse): Context;
-    /**
-     * Default error handler.
-     * @private
-     */
-    protected onerror(err: CustomError): void;
-    /**
-     * Response helper.
-     */
-    protected _respond(ctx: Context): void;
+* Expose `Application` class.
+* Inherits from `Emitter.prototype`.
+*/
+declare class Application extends Emitter {
+  [key: symbol]: unknown;
+  /**
+  * Make HttpError available to consumers of the library so that consumers don't
+  * have a direct dependency upon `http-errors`
+  */
+  static HttpError: typeof HttpError;
+  protected _proxy: boolean;
+  protected _env: string;
+  subdomainOffset: number;
+  proxyIpHeader: string;
+  maxIpsCount: number;
+  protected _keys?: string[];
+  middleware: MiddlewareFunc<Context>[];
+  ctxStorage: AsyncLocalStorage<Context>;
+  silent: boolean;
+  ContextClass: ProtoImplClass<Context>;
+  context: AnyProto;
+  RequestClass: ProtoImplClass<Request>;
+  request: AnyProto;
+  ResponseClass: ProtoImplClass<Response>;
+  response: AnyProto;
+  /**
+  * Initialize a new `Application`.
+  *
+  * @param {object} [options] Application options
+  * @param {string} [options.env] Environment, default is `development`
+  * @param {string[]} [options.keys] Signed cookie keys
+  * @param {boolean} [options.proxy] Trust proxy headers
+  * @param {number} [options.subdomainOffset] Subdomain offset
+  * @param {string} [options.proxyIpHeader] Proxy IP header, defaults to X-Forwarded-For
+  * @param {number} [options.maxIpsCount] Max IPs read from proxy IP header, default to 0 (means infinity)
+  */
+  constructor(options?: {
+    proxy?: boolean;
+    subdomainOffset?: number;
+    proxyIpHeader?: string;
+    maxIpsCount?: number;
+    env?: string;
+    keys?: string[];
+  });
+  get keys(): string[] | undefined;
+  set keys(value: string[] | undefined);
+  get env(): string;
+  set env(value: string);
+  get proxy(): boolean;
+  set proxy(value: boolean);
+  /**
+  * Shorthand for:
+  *
+  *    http.createServer(app.callback()).listen(...)
+  */
+  listen(...args: any[]): http.Server;
+  /**
+  * Return JSON representation.
+  * We only bother showing settings.
+  */
+  toJSON(): object;
+  /**
+  * Inspect implementation.
+  */
+  inspect(): object;
+  /**
+  * Use the given middleware `fn`.
+  */
+  use<T extends Context = Context>(fn: MiddlewareFunc<T>): this;
+  /**
+  * Return a request handler callback
+  * for node's native http server.
+  */
+  callback(): (req: IncomingMessage, res: ServerResponse) => Promise<void>;
+  /**
+  * return current context from async local storage
+  */
+  get currentContext(): Context | undefined;
+  /**
+  * Handle request in callback.
+  * @private
+  */
+  protected handleRequest(ctx: Context, fnMiddleware: (ctx: Context) => Promise<void>): Promise<void>;
+  /**
+  * Initialize a new context.
+  * @private
+  */
+  createContext(req: IncomingMessage, res: ServerResponse): Context;
+  /**
+  * Default error handler.
+  * @private
+  */
+  protected onerror(err: CustomError): void;
+  /**
+  * Response helper.
+  */
+  protected _respond(ctx: Context): void;
 }
+//#endregion
+export { Application, MiddlewareFunc, Next, ProtoImplClass };