@eggjs/koa 3.0.1 → 3.1.0-beta.11

package/dist/context.d.ts

@@ -1,225 +1,230 @@
-import util from 'node:util';
-import type { IncomingMessage, ServerResponse } from 'node:http';
-import type { ParsedUrlQuery } from 'node:querystring';
-import Cookies from 'cookies';
-import type { Accepts } from 'accepts';
-import type { Application } from './application.ts';
-import type { Request } from './request.ts';
-import type { Response } from './response.ts';
-import type { CustomError, AnyProto } from './types.ts';
-export declare class Context {
-    #private;
-    [key: symbol | string]: unknown;
-    app: Application;
-    req: IncomingMessage;
-    res: ServerResponse;
-    request: Request & AnyProto;
-    response: Response & AnyProto;
+import { Response } from "./response.js";
+import { Request, RequestSocket } from "./request.js";
+import { AnyProto, CustomError } from "./types.js";
+import { Application } from "./application.js";
+import util from "node:util";
+import { IncomingMessage, ServerResponse } from "node:http";
+import Cookies from "cookies";
+import { ParsedUrlQuery } from "node:querystring";
+import { Accepts } from "accepts";
+import * as http0 from "http";
+
+//#region src/context.d.ts
+declare class Context {
+  #private;
+  [key: symbol | string]: unknown;
+  app: Application;
+  req: IncomingMessage;
+  res: ServerResponse;
+  request: Request & AnyProto;
+  response: Response & AnyProto;
+  originalUrl: string;
+  respond?: boolean;
+  constructor(app: Application, req: IncomingMessage, res: ServerResponse);
+  /**
+   * util.inspect() implementation, which
+   * just returns the JSON output.
+   */
+  inspect(): {
+    request: {
+      method: string;
+      url: string;
+      header: http0.IncomingHttpHeaders;
+    };
+    response: {
+      status: number;
+      message: string;
+      header: http0.OutgoingHttpHeaders;
+    };
+    app: {
+      subdomainOffset: number;
+      proxy: boolean;
+      env: string;
+    };
+    originalUrl: string;
+    req: string;
+    res: string;
+    socket: string;
+  };
+  /**
+   * Custom inspection implementation for newer Node.js versions.
+   */
+  [util.inspect.custom](): {
+    request: {
+      method: string;
+      url: string;
+      header: http0.IncomingHttpHeaders;
+    };
+    response: {
+      status: number;
+      message: string;
+      header: http0.OutgoingHttpHeaders;
+    };
+    app: {
+      subdomainOffset: number;
+      proxy: boolean;
+      env: string;
+    };
     originalUrl: string;
-    respond?: boolean;
-    constructor(app: Application, req: IncomingMessage, res: ServerResponse);
-    /**
-     * util.inspect() implementation, which
-     * just returns the JSON output.
-     */
-    inspect(): {
-        request: {
-            method: string;
-            url: string;
-            header: import("http").IncomingHttpHeaders;
-        };
-        response: {
-            status: number;
-            message: string;
-            header: import("http").OutgoingHttpHeaders;
-        };
-        app: {
-            subdomainOffset: number;
-            proxy: boolean;
-            env: string;
-        };
-        originalUrl: string;
-        req: string;
-        res: string;
-        socket: string;
+    req: string;
+    res: string;
+    socket: string;
+  };
+  /**
+   * Return JSON representation.
+   *
+   * Here we explicitly invoke .toJSON() on each
+   * object, as iteration will otherwise fail due
+   * to the getters and cause utilities such as
+   * clone() to fail.
+   */
+  toJSON(): {
+    request: {
+      method: string;
+      url: string;
+      header: http0.IncomingHttpHeaders;
     };
-    /**
-     * Custom inspection implementation for newer Node.js versions.
-     */
-    [util.inspect.custom](): {
-        request: {
-            method: string;
-            url: string;
-            header: import("http").IncomingHttpHeaders;
-        };
-        response: {
-            status: number;
-            message: string;
-            header: import("http").OutgoingHttpHeaders;
-        };
-        app: {
-            subdomainOffset: number;
-            proxy: boolean;
-            env: string;
-        };
-        originalUrl: string;
-        req: string;
-        res: string;
-        socket: string;
+    response: {
+      status: number;
+      message: string;
+      header: http0.OutgoingHttpHeaders;
     };
-    /**
-     * Return JSON representation.
-     *
-     * Here we explicitly invoke .toJSON() on each
-     * object, as iteration will otherwise fail due
-     * to the getters and cause utilities such as
-     * clone() to fail.
-     */
-    toJSON(): {
-        request: {
-            method: string;
-            url: string;
-            header: import("http").IncomingHttpHeaders;
-        };
-        response: {
-            status: number;
-            message: string;
-            header: import("http").OutgoingHttpHeaders;
-        };
-        app: {
-            subdomainOffset: number;
-            proxy: boolean;
-            env: string;
-        };
-        originalUrl: string;
-        req: string;
-        res: string;
-        socket: string;
+    app: {
+      subdomainOffset: number;
+      proxy: boolean;
+      env: string;
     };
-    /**
-     * Similar to .throw(), adds assertion.
-     *
-     * ```ts
-     * this.assert(this.user, 401, 'Please login!');
-     * ```
-     */
-    assert(value: unknown, status?: number, errorProps?: Record<string, unknown>): void;
-    assert(value: unknown, status?: number, errorMessage?: string, errorProps?: Record<string, unknown>): void;
-    /**
-     * Throw an error with `status` (default 500) and
-     * `msg`. Note that these are user-level
-     * errors, and the message may be exposed to the client.
-     *
-     *    this.throw(403)
-     *    this.throw(400, 'name required')
-     *    this.throw('something exploded')
-     *    this.throw(new Error('invalid'))
-     *    this.throw(400, new Error('invalid'))
-     *    this.throw(400, new Error('invalid'), { foo: 'bar' })
-     *    this.throw(new Error('invalid'), { foo: 'bar' })
-     *
-     * See: https://github.com/jshttp/http-errors
-     *
-     * Note: `status` should only be passed as the first parameter.
-     *
-     * @param {String|Number|Error} status error, msg or status
-     * @param {String|Number|Error|Object} [error] error, msg, status or errorProps
-     * @param {Object} [errorProps] error object properties
-     */
-    throw(status: number): void;
-    throw(status: number, errorProps: object): void;
-    throw(status: number, errorMessage: string): void;
-    throw(status: number, errorMessage: string, errorProps: object): void;
-    throw(status: number, error: Error): void;
-    throw(status: number, error: Error, errorProps: object): void;
-    throw(errorMessage: string): void;
-    throw(errorMessage: string, errorProps: object): void;
-    throw(errorMessage: string, status: number): void;
-    throw(errorMessage: string, status: number, errorProps: object): void;
-    throw(error: Error): void;
-    throw(error: Error, errorProps: object): void;
-    throw(error: Error, status: number): void;
-    throw(error: Error, status: number, errorProps: object): void;
-    /**
-     * Default error handling.
-     * @private
-     */
-    onerror(err: CustomError): void;
-    protected _cookies: Cookies | undefined;
-    get cookies(): Cookies;
-    set cookies(cookies: Cookies);
-    get state(): Record<string, any>;
-    /**
-     * Request delegation.
-     */
-    acceptsLanguages(): string[];
-    acceptsLanguages(languages: string[]): string | false;
-    acceptsLanguages(...languages: string[]): string | false;
-    acceptsEncodings(): string[];
-    acceptsEncodings(encodings: string[]): string | false;
-    acceptsEncodings(...encodings: string[]): string | false;
-    acceptsCharsets(): string[];
-    acceptsCharsets(charsets: string[]): string | false;
-    acceptsCharsets(...charsets: string[]): string | false;
-    accepts(args: string[]): string | string[] | false;
-    accepts(...args: string[]): string | string[] | false;
-    get<T = string | string[]>(field: string): T;
-    is(type?: string | string[], ...types: string[]): string | false | null;
-    get querystring(): string;
-    set querystring(str: string);
-    get idempotent(): boolean;
-    get socket(): import("./request.ts").RequestSocket;
-    get search(): string;
-    set search(str: string);
-    get method(): string;
-    set method(method: string);
-    get query(): ParsedUrlQuery;
-    set query(obj: ParsedUrlQuery);
-    get path(): string;
-    set path(path: string);
-    get url(): string;
-    set url(url: string);
-    get accept(): Accepts;
-    set accept(accept: Accepts);
-    get origin(): string;
-    get href(): string;
-    get subdomains(): string[];
-    get protocol(): string;
-    get host(): string;
-    get hostname(): string;
-    get URL(): URL;
-    get header(): import("http").IncomingHttpHeaders;
-    get headers(): import("http").IncomingHttpHeaders;
-    get secure(): boolean;
-    get stale(): boolean;
-    get fresh(): boolean;
-    get ips(): string[];
-    get ip(): string;
-    /**
-     * Response delegation.
-     */
-    attachment(...args: Parameters<Response['attachment']>): void;
-    redirect(...args: Parameters<Response['redirect']>): void;
-    remove(...args: Parameters<Response['remove']>): void;
-    vary(...args: Parameters<Response['vary']>): void;
-    has(...args: Parameters<Response['has']>): boolean;
-    set(...args: Parameters<Response['set']>): void;
-    append(...args: Parameters<Response['append']>): void;
-    flushHeaders(...args: Parameters<Response['flushHeaders']>): void;
-    get status(): number;
-    set status(status: number);
-    get message(): string;
-    set message(msg: string);
-    get body(): any;
-    set body(val: any);
-    get length(): number | undefined;
-    set length(n: number | string | undefined);
-    get type(): string;
-    set type(type: string | null | undefined);
-    get lastModified(): string | Date | undefined;
-    set lastModified(val: string | Date | undefined);
-    get etag(): string;
-    set etag(val: string);
-    get headerSent(): boolean;
-    get writable(): boolean;
+    originalUrl: string;
+    req: string;
+    res: string;
+    socket: string;
+  };
+  /**
+   * Similar to .throw(), adds assertion.
+   *
+   * ```ts
+   * this.assert(this.user, 401, 'Please login!');
+   * ```
+   */
+  assert(value: unknown, status?: number, errorProps?: Record<string, unknown>): void;
+  assert(value: unknown, status?: number, errorMessage?: string, errorProps?: Record<string, unknown>): void;
+  /**
+   * Throw an error with `status` (default 500) and
+   * `msg`. Note that these are user-level
+   * errors, and the message may be exposed to the client.
+   *
+   *    this.throw(403)
+   *    this.throw(400, 'name required')
+   *    this.throw('something exploded')
+   *    this.throw(new Error('invalid'))
+   *    this.throw(400, new Error('invalid'))
+   *    this.throw(400, new Error('invalid'), { foo: 'bar' })
+   *    this.throw(new Error('invalid'), { foo: 'bar' })
+   *
+   * See: https://github.com/jshttp/http-errors
+   *
+   * Note: `status` should only be passed as the first parameter.
+   *
+   * @param {String|Number|Error} status error, msg or status
+   * @param {String|Number|Error|Object} [error] error, msg, status or errorProps
+   * @param {Object} [errorProps] error object properties
+   */
+  throw(status: number): void;
+  throw(status: number, errorProps: object): void;
+  throw(status: number, errorMessage: string): void;
+  throw(status: number, errorMessage: string, errorProps: object): void;
+  throw(status: number, error: Error): void;
+  throw(status: number, error: Error, errorProps: object): void;
+  throw(errorMessage: string): void;
+  throw(errorMessage: string, errorProps: object): void;
+  throw(errorMessage: string, status: number): void;
+  throw(errorMessage: string, status: number, errorProps: object): void;
+  throw(error: Error): void;
+  throw(error: Error, errorProps: object): void;
+  throw(error: Error, status: number): void;
+  throw(error: Error, status: number, errorProps: object): void;
+  /**
+   * Default error handling.
+   * @private
+   */
+  onerror(err: CustomError): void;
+  protected _cookies: Cookies | undefined;
+  get cookies(): Cookies;
+  set cookies(cookies: Cookies);
+  get state(): Record<string, any>;
+  /**
+   * Request delegation.
+   */
+  acceptsLanguages(): string[];
+  acceptsLanguages(languages: string[]): string | false;
+  acceptsLanguages(...languages: string[]): string | false;
+  acceptsEncodings(): string[];
+  acceptsEncodings(encodings: string[]): string | false;
+  acceptsEncodings(...encodings: string[]): string | false;
+  acceptsCharsets(): string[];
+  acceptsCharsets(charsets: string[]): string | false;
+  acceptsCharsets(...charsets: string[]): string | false;
+  accepts(args: string[]): string | string[] | false;
+  accepts(...args: string[]): string | string[] | false;
+  get<T = string | string[]>(field: string): T;
+  is(type?: string | string[], ...types: string[]): string | false | null;
+  get querystring(): string;
+  set querystring(str: string);
+  get idempotent(): boolean;
+  get socket(): RequestSocket;
+  get search(): string;
+  set search(str: string);
+  get method(): string;
+  set method(method: string);
+  get query(): ParsedUrlQuery;
+  set query(obj: ParsedUrlQuery);
+  get path(): string;
+  set path(path: string);
+  get url(): string;
+  set url(url: string);
+  get accept(): Accepts;
+  set accept(accept: Accepts);
+  get origin(): string;
+  get href(): string;
+  get subdomains(): string[];
+  get protocol(): string;
+  get host(): string;
+  get hostname(): string;
+  get URL(): URL;
+  get header(): http0.IncomingHttpHeaders;
+  get headers(): http0.IncomingHttpHeaders;
+  get secure(): boolean;
+  get stale(): boolean;
+  get fresh(): boolean;
+  get ips(): string[];
+  get ip(): string;
+  /**
+   * Response delegation.
+   */
+  attachment(...args: Parameters<Response['attachment']>): void;
+  redirect(...args: Parameters<Response['redirect']>): void;
+  remove(...args: Parameters<Response['remove']>): void;
+  vary(...args: Parameters<Response['vary']>): void;
+  has(...args: Parameters<Response['has']>): boolean;
+  set(...args: Parameters<Response['set']>): void;
+  append(...args: Parameters<Response['append']>): void;
+  flushHeaders(...args: Parameters<Response['flushHeaders']>): void;
+  get status(): number;
+  set status(status: number);
+  get message(): string;
+  set message(msg: string);
+  get body(): any;
+  set body(val: any);
+  get length(): number | undefined;
+  set length(n: number | string | undefined);
+  get type(): string;
+  set type(type: string | null | undefined);
+  get lastModified(): string | Date | undefined;
+  set lastModified(val: string | Date | undefined);
+  get etag(): string;
+  set etag(val: string);
+  get headerSent(): boolean;
+  get writable(): boolean;
 }
+//#endregion
+export { Context };