@eggjs/koa 3.1.0-beta.9 → 3.1.2-beta.0

package/dist/request.d.ts

@@ -1,12 +1,10 @@
 import { Response } from "./response.js";
 import { Context } from "./context.js";
 import { Application } from "./application.js";
-import util from "node:util";
 import { IncomingMessage, ServerResponse } from "node:http";
 import { Socket } from "node:net";
 import { ParsedUrlQuery } from "node:querystring";
 import { Accepts } from "accepts";
-import * as http0 from "http";
 
 //#region src/request.d.ts
 interface RequestSocket extends Socket {
@@ -22,322 +20,306 @@ declare class Request {
   originalUrl: string;
   constructor(app: Application, ctx: Context, req: IncomingMessage, res: ServerResponse);
   /**
-   * Return request header.
-   */
-  get header(): http0.IncomingHttpHeaders;
+  * Return request header.
+  */
+  get header(): IncomingMessage["headers"];
   /**
-   * Set request header.
-   */
-  set header(val: http0.IncomingHttpHeaders);
+  * Set request header.
+  */
+  set header(val: IncomingMessage["headers"]);
   /**
-   * Return request header, alias as request.header
-   */
-  get headers(): http0.IncomingHttpHeaders;
+  * Return request header, alias as request.header
+  */
+  get headers(): IncomingMessage["headers"];
   /**
-   * Set request header, alias as request.header
-   */
-  set headers(val: http0.IncomingHttpHeaders);
+  * Set request header, alias as request.header
+  */
+  set headers(val: IncomingMessage["headers"]);
   /**
-   * Get request URL.
-   */
+  * Get request URL.
+  */
   get url(): string;
   /**
-   * Set request URL.
-   */
+  * Set request URL.
+  */
   set url(val: string);
   /**
-   * Get origin of URL.
-   */
+  * Get origin of URL.
+  */
   get origin(): string;
   /**
-   * Get full request URL.
-   */
+  * Get full request URL.
+  */
   get href(): string;
   /**
-   * Get request method.
-   */
+  * Get request method.
+  */
   get method(): string;
   /**
-   * Set request method.
-   */
+  * Set request method.
+  */
   set method(val: string);
   /**
-   * Get request pathname.
-   */
+  * Get request pathname.
+  */
   get path(): string;
   /**
-   * Set pathname, retaining the query string when present.
-   */
+  * Set pathname, retaining the query string when present.
+  */
   set path(pathname: string);
   protected _parsedUrlQueryCache: Record<string, ParsedUrlQuery> | undefined;
   /**
-   * Get parsed query string.
-   */
+  * Get parsed query string.
+  */
   get query(): ParsedUrlQuery;
   /**
-   * Set query string as an object.
-   */
+  * Set query string as an object.
+  */
   set query(obj: ParsedUrlQuery);
   /**
-   * Get query string.
-   */
+  * Get query string.
+  */
   get querystring(): string;
   /**
-   * Set query string.
-   */
+  * Set query string.
+  */
   set querystring(str: string);
   /**
-   * Get the search string. Same as the query string
-   * except it includes the leading ?.
-   */
+  * Get the search string. Same as the query string
+  * except it includes the leading ?.
+  */
   get search(): string;
   /**
-   * Set the search string. Same as
-   * request.querystring= but included for ubiquity.
-   */
+  * Set the search string. Same as
+  * request.querystring= but included for ubiquity.
+  */
   set search(str: string);
   /**
-   * Parse the "Host" header field host
-   * and support X-Forwarded-Host when a
-   * proxy is enabled.
-   * return `hostname:port` format
-   */
+  * Parse the "Host" header field host
+  * and support X-Forwarded-Host when a
+  * proxy is enabled.
+  * return `hostname:port` format
+  */
   get host(): string;
   /**
-   * Parse the "Host" header field hostname
-   * and support X-Forwarded-Host when a
-   * proxy is enabled.
-   */
+  * Parse the "Host" header field hostname
+  * and support X-Forwarded-Host when a
+  * proxy is enabled.
+  */
   get hostname(): string;
   protected _memoizedURL: URL | undefined;
   /**
-   * Get WHATWG parsed URL.
-   * Lazily memoized.
-   */
+  * Get WHATWG parsed URL.
+  * Lazily memoized.
+  */
   get URL(): URL;
   /**
-   * Check if the request is fresh, aka
-   * Last-Modified and/or the ETag
-   * still match.
-   */
+  * Check if the request is fresh, aka
+  * Last-Modified and/or the ETag
+  * still match.
+  */
   get fresh(): boolean;
   /**
-   * Check if the request is stale, aka
-   * "Last-Modified" and / or the "ETag" for the
-   * resource has changed.
-   */
+  * Check if the request is stale, aka
+  * "Last-Modified" and / or the "ETag" for the
+  * resource has changed.
+  */
   get stale(): boolean;
   /**
-   * Check if the request is idempotent.
-   */
+  * Check if the request is idempotent.
+  */
   get idempotent(): boolean;
   /**
-   * Return the request socket.
-   */
+  * Return the request socket.
+  */
   get socket(): RequestSocket;
   /**
-   * Get the charset when present or undefined.
-   */
-  get charset(): string;
+  * Get the charset when present or undefined.
+  */
+  get charset(): string | undefined;
   /**
-   * Return parsed Content-Length when present.
-   */
+  * Return parsed Content-Length when present.
+  */
   get length(): number | undefined;
   /**
-   * Return the protocol string "http" or "https"
-   * when requested with TLS. When the proxy setting
-   * is enabled the "X-Forwarded-Proto" header
-   * field will be trusted. If you're running behind
-   * a reverse proxy that supplies https for you this
-   * may be enabled.
-   */
+  * Return the protocol string "http" or "https"
+  * when requested with TLS. When the proxy setting
+  * is enabled the "X-Forwarded-Proto" header
+  * field will be trusted. If you're running behind
+  * a reverse proxy that supplies https for you this
+  * may be enabled.
+  */
   get protocol(): string;
   /**
-   * Shorthand for:
-   *
-   *    this.protocol == 'https'
-   */
+  * Shorthand for:
+  *
+  *    this.protocol == 'https'
+  */
   get secure(): boolean;
   /**
-   * When `app.proxy` is `true`, parse
-   * the "X-Forwarded-For" ip address list.
-   *
-   * For example if the value was "client, proxy1, proxy2"
-   * you would receive the array `["client", "proxy1", "proxy2"]`
-   * where "proxy2" is the furthest down-stream.
-   */
+  * When `app.proxy` is `true`, parse
+  * the "X-Forwarded-For" ip address list.
+  *
+  * For example if the value was "client, proxy1, proxy2"
+  * you would receive the array `["client", "proxy1", "proxy2"]`
+  * where "proxy2" is the furthest down-stream.
+  */
   get ips(): string[];
   protected _ip: string;
   /**
-   * Return request's remote address
-   * When `app.proxy` is `true`, parse
-   * the "X-Forwarded-For" ip address list and return the first one
-   */
+  * Return request's remote address
+  * When `app.proxy` is `true`, parse
+  * the "X-Forwarded-For" ip address list and return the first one
+  */
   get ip(): string;
   set ip(ip: string);
   /**
-   * Return subdomains as an array.
-   *
-   * Subdomains are the dot-separated parts of the host before the main domain
-   * of the app. By default, the domain of the app is assumed to be the last two
-   * parts of the host. This can be changed by setting `app.subdomainOffset`.
-   *
-   * For example, if the domain is "tobi.ferrets.example.com":
-   * If `app.subdomainOffset` is not set, this.subdomains is
-   * `["ferrets", "tobi"]`.
-   * If `app.subdomainOffset` is 3, this.subdomains is `["tobi"]`.
-   */
+  * Return subdomains as an array.
+  *
+  * Subdomains are the dot-separated parts of the host before the main domain
+  * of the app. By default, the domain of the app is assumed to be the last two
+  * parts of the host. This can be changed by setting `app.subdomainOffset`.
+  *
+  * For example, if the domain is "tobi.ferrets.example.com":
+  * If `app.subdomainOffset` is not set, this.subdomains is
+  * `["ferrets", "tobi"]`.
+  * If `app.subdomainOffset` is 3, this.subdomains is `["tobi"]`.
+  */
   get subdomains(): string[];
   protected _accept: Accepts;
   /**
-   * Get accept object.
-   * Lazily memoized.
-   */
+  * Get accept object.
+  * Lazily memoized.
+  */
   get accept(): Accepts;
   /**
-   * Set accept object.
-   */
+  * Set accept object.
+  */
   set accept(obj: Accepts);
   /**
-   * Check if the given `type(s)` is acceptable, returning
-   * the best match when true, otherwise `false`, in which
-   * case you should respond with 406 "Not Acceptable".
-   *
-   * The `type` value may be a single mime type string
-   * such as "application/json", the extension name
-   * such as "json" or an array `["json", "html", "text/plain"]`. When a list
-   * or array is given the _best_ match, if any is returned.
-   *
-   * Examples:
-   *
-   *     // Accept: text/html
-   *     this.accepts('html');
-   *     // => "html"
-   *
-   *     // Accept: text/*, application/json
-   *     this.accepts('html');
-   *     // => "html"
-   *     this.accepts('text/html');
-   *     // => "text/html"
-   *     this.accepts('json', 'text');
-   *     // => "json"
-   *     this.accepts('application/json');
-   *     // => "application/json"
-   *
-   *     // Accept: text/*, application/json
-   *     this.accepts('image/png');
-   *     this.accepts('png');
-   *     // => false
-   *
-   *     // Accept: text/*;q=.5, application/json
-   *     this.accepts(['html', 'json']);
-   *     this.accepts('html', 'json');
-   *     // => "json"
-   */
+  * Check if the given `type(s)` is acceptable, returning
+  * the best match when true, otherwise `false`, in which
+  * case you should respond with 406 "Not Acceptable".
+  *
+  * The `type` value may be a single mime type string
+  * such as "application/json", the extension name
+  * such as "json" or an array `["json", "html", "text/plain"]`. When a list
+  * or array is given the _best_ match, if any is returned.
+  *
+  * Examples:
+  *
+  *     // Accept: text/html
+  *     this.accepts('html');
+  *     // => "html"
+  *
+  *     // Accept: text/*, application/json
+  *     this.accepts('html');
+  *     // => "html"
+  *     this.accepts('text/html');
+  *     // => "text/html"
+  *     this.accepts('json', 'text');
+  *     // => "json"
+  *     this.accepts('application/json');
+  *     // => "application/json"
+  *
+  *     // Accept: text/*, application/json
+  *     this.accepts('image/png');
+  *     this.accepts('png');
+  *     // => false
+  *
+  *     // Accept: text/*;q=.5, application/json
+  *     this.accepts(['html', 'json']);
+  *     this.accepts('html', 'json');
+  *     // => "json"
+  */
   accepts(args: string[]): string | string[] | false;
   accepts(...args: string[]): string | string[] | false;
   /**
-   * Return accepted encodings or best fit based on `encodings`.
-   *
-   * Given `Accept-Encoding: gzip, deflate`
-   * an array sorted by quality is returned:
-   *
-   *     ['gzip', 'deflate']
-   */
+  * Return accepted encodings or best fit based on `encodings`.
+  *
+  * Given `Accept-Encoding: gzip, deflate`
+  * an array sorted by quality is returned:
+  *
+  *     ['gzip', 'deflate']
+  */
   acceptsEncodings(): string[];
   acceptsEncodings(encodings: string[]): string | false;
   acceptsEncodings(...encodings: string[]): string | false;
   /**
-   * Return accepted charsets or best fit based on `charsets`.
-   *
-   * Given `Accept-Charset: utf-8, iso-8859-1;q=0.2, utf-7;q=0.5`
-   * an array sorted by quality is returned:
-   *
-   *     ['utf-8', 'utf-7', 'iso-8859-1']
-   */
+  * Return accepted charsets or best fit based on `charsets`.
+  *
+  * Given `Accept-Charset: utf-8, iso-8859-1;q=0.2, utf-7;q=0.5`
+  * an array sorted by quality is returned:
+  *
+  *     ['utf-8', 'utf-7', 'iso-8859-1']
+  */
   acceptsCharsets(): string[];
   acceptsCharsets(charsets: string[]): string | false;
   acceptsCharsets(...charsets: string[]): string | false;
   /**
-   * Return accepted languages or best fit based on `langs`.
-   *
-   * Given `Accept-Language: en;q=0.8, es, pt`
-   * an array sorted by quality is returned:
-   *
-   *     ['es', 'pt', 'en']
-   */
+  * Return accepted languages or best fit based on `langs`.
+  *
+  * Given `Accept-Language: en;q=0.8, es, pt`
+  * an array sorted by quality is returned:
+  *
+  *     ['es', 'pt', 'en']
+  */
   acceptsLanguages(): string[];
   acceptsLanguages(languages: string[]): string | false;
   acceptsLanguages(...languages: string[]): string | false;
   /**
-   * Check if the incoming request contains the "Content-Type"
-   * header field and if it contains any of the given mime `type`s.
-   * If there is no request body, `null` is returned.
-   * If there is no content type, `false` is returned.
-   * Otherwise, it returns the first `type` that matches.
-   *
-   * Examples:
-   *
-   *     // With Content-Type: text/html; charset=utf-8
-   *     this.is('html'); // => 'html'
-   *     this.is('text/html'); // => 'text/html'
-   *     this.is('text/*', 'application/json'); // => 'text/html'
-   *
-   *     // When Content-Type is application/json
-   *     this.is('json', 'urlencoded'); // => 'json'
-   *     this.is('application/json'); // => 'application/json'
-   *     this.is('html', 'application/*'); // => 'application/json'
-   *
-   *     this.is('html'); // => false
-   */
+  * Check if the incoming request contains the "Content-Type"
+  * header field and if it contains any of the given mime `type`s.
+  * If there is no request body, `null` is returned.
+  * If there is no content type, `false` is returned.
+  * Otherwise, it returns the first `type` that matches.
+  *
+  * Examples:
+  *
+  *     // With Content-Type: text/html; charset=utf-8
+  *     this.is('html'); // => 'html'
+  *     this.is('text/html'); // => 'text/html'
+  *     this.is('text/*', 'application/json'); // => 'text/html'
+  *
+  *     // When Content-Type is application/json
+  *     this.is('json', 'urlencoded'); // => 'json'
+  *     this.is('application/json'); // => 'application/json'
+  *     this.is('html', 'application/*'); // => 'application/json'
+  *
+  *     this.is('html'); // => false
+  */
   is(type?: string | string[], ...types: string[]): string | false | null;
   /**
-   * Return the request mime type void of
-   * parameters such as "charset".
-   */
+  * Return the request mime type void of
+  * parameters such as "charset".
+  */
   get type(): string;
   /**
-   * Return request header.
-   *
-   * The `Referrer` header field is special-cased,
-   * both `Referrer` and `Referer` are interchangeable.
-   *
-   * Examples:
-   *
-   *     this.get('Content-Type');
-   *     // => "text/plain"
-   *
-   *     this.get('content-type');
-   *     // => "text/plain"
-   *
-   *     this.get('Something');
-   *     // => ''
-   */
+  * Return request header.
+  *
+  * The `Referrer` header field is special-cased,
+  * both `Referrer` and `Referer` are interchangeable.
+  *
+  * Examples:
+  *
+  *     this.get('Content-Type');
+  *     // => "text/plain"
+  *
+  *     this.get('content-type');
+  *     // => "text/plain"
+  *
+  *     this.get('Something');
+  *     // => ''
+  */
   get<T = string | string[]>(field: string): T;
   /**
-   * Inspect implementation.
-   */
-  inspect(): {
-    method: string;
-    url: string;
-    header: http0.IncomingHttpHeaders;
-  } | undefined;
-  /**
-   * Custom inspection implementation for newer Node.js versions.
-   */
-  [util.inspect.custom](): {
-    method: string;
-    url: string;
-    header: http0.IncomingHttpHeaders;
-  } | undefined;
-  /**
-   * Return JSON representation.
-   */
-  toJSON(): {
-    method: string;
-    url: string;
-    header: http0.IncomingHttpHeaders;
-  };
+  * Inspect implementation.
+  */
+  inspect(): object | undefined;
+  /**
+  * Return JSON representation.
+  */
+  toJSON(): object;
 }
 //#endregion
 export { Request, RequestSocket };

package/dist/request.js

@@ -1,12 +1,12 @@
 import util from "node:util";
 import net from "node:net";
-import { format } from "node:url";
 import qs from "node:querystring";
+import { format } from "node:url";
 import accepts from "accepts";
 import contentType from "content-type";
+import fresh from "fresh";
 import parse from "parseurl";
 import typeis from "type-is";
-import fresh from "fresh";
 
 //#region src/request.ts
 var Request = class {
@@ -22,6 +22,7 @@ var Request = class {
 		this.res = res;
 		this.ctx = ctx;
 		this.originalUrl = req.url ?? "/";
+		this[util.inspect.custom] = this.inspect.bind(this);
 	}
 	/**
 	* Return request header.
@@ -427,12 +428,6 @@ var Request = class {
 		return this.toJSON();
 	}
 	/**
-	* Custom inspection implementation for newer Node.js versions.
-	*/
-	[util.inspect.custom]() {
-		return this.inspect();
-	}
-	/**
 	* Return JSON representation.
 	*/
 	toJSON() {