@eggjs/koa 3.1.0-beta.3 → 3.1.0-beta.31

package/dist/response.d.ts

@@ -1,231 +1,211 @@
-import { Request } from "./request.js";
-import { Context } from "./context.js";
-import { Application } from "./application.js";
-import util from "node:util";
-import Stream from "node:stream";
-import { IncomingMessage, ServerResponse } from "node:http";
-import { Options } from "content-disposition";
-import * as http0 from "http";
-import * as net0 from "net";
-
-//#region src/response.d.ts
-declare class Response {
-  [key: symbol]: unknown;
-  app: Application;
-  req: IncomingMessage;
-  res: ServerResponse;
-  ctx: Context;
-  request: Request;
-  constructor(app: Application, ctx: Context, req: IncomingMessage, res: ServerResponse);
-  /**
-   * Return the request socket.
-   */
-  get socket(): net0.Socket | null;
-  /**
-   * Return response header.
-   */
-  get header(): http0.OutgoingHttpHeaders;
-  /**
-   * Return response header, alias as response.header
-   */
-  get headers(): http0.OutgoingHttpHeaders;
-  _explicitStatus: boolean;
-  /**
-   * Get response status code.
-   */
-  get status(): number;
-  /**
-   * Set response status code.
-   */
-  set status(code: number);
-  /**
-   * Get response status message
-   */
-  get message(): string;
-  /**
-   * Set response status message
-   */
-  set message(msg: string);
-  _body: any;
-  _explicitNullBody: boolean;
-  /**
-   * Get response body.
-   */
-  get body(): string | Buffer | object | Stream | null | undefined | boolean;
-  /**
-   * Set response body.
-   */
-  set body(val: string | Buffer | object | Stream | null | undefined | boolean);
-  /**
-   * Set Content-Length field to `n`.
-   */
-  set length(n: number | string | undefined);
-  /**
-   * Return parsed response Content-Length when present.
-   *
-   * When Content-Length is not defined it will return `undefined`.
-   */
-  get length(): number | undefined;
-  /**
-   * Check if a header has been written to the socket.
-   */
-  get headerSent(): boolean;
-  /**
-   * Vary on `field`.
-   */
-  vary(field: string): void;
-  _getBackReferrer(): string | undefined;
-  /**
-   * Perform a 302 redirect to `url`.
-   *
-   * The string "back" is special-cased
-   * to provide Referrer support, when Referrer
-   * is not present `alt` or "/" is used.
-   *
-   * Examples:
-   *
-   *    this.redirect('back');
-   *    this.redirect('back', '/index.html');
-   *    this.redirect('/login');
-   *    this.redirect('http://google.com'); // will format to 'http://google.com/'
-   */
-  redirect(url: string, alt?: string): void;
-  /**
-   * Set Content-Disposition header to "attachment" with optional `filename`.
-   */
-  attachment(filename?: string, options?: Options): void;
-  /**
-   * Set Content-Type response header with `type` through `mime.lookup()`
-   * when it does not contain a charset.
-   *
-   * Examples:
-   *
-   *     this.type = '.html';
-   *     this.type = 'html';
-   *     this.type = 'json';
-   *     this.type = 'application/json';
-   *     this.type = 'png';
-   */
-  set type(type: string | null | undefined);
-  /**
-   * Return the response mime type void of
-   * parameters such as "charset".
-   */
-  get type(): string;
-  /**
-   * Check whether the response is one of the listed types.
-   * Pretty much the same as `this.request.is()`.
-   *
-   *     this.response.is('html')
-   *     this.response.is('html', 'json')
-   */
-  is(type?: string | string[], ...types: string[]): string | false;
-  /**
-   * Set the Last-Modified date using a string or a Date.
-   *
-   *     this.response.lastModified = new Date();
-   *     this.response.lastModified = '2013-09-13';
-   */
-  set lastModified(val: string | Date | undefined);
-  /**
-   * Get the Last-Modified date in Date form, if it exists.
-   */
-  get lastModified(): Date | undefined;
-  /**
-   * Set the ETag of a response.
-   * This will normalize the quotes if necessary.
-   *
-   *     this.response.etag = 'md5-hash-sum';
-   *     this.response.etag = '"md5-hash-sum"';
-   *     this.response.etag = 'W/"123456789"';
-   */
-  set etag(val: string);
-  /**
-   * Get the ETag of a response.
-   */
-  get etag(): string;
-  /**
-   * Return response header.
-   *
-   * Examples:
-   *
-   *     this.get('Content-Type');
-   *     // => "text/plain"
-   *
-   *     this.get('content-type');
-   *     // => "text/plain"
-   */
-  get<T = string | string[] | number>(field: string): T;
-  /**
-   * Returns true if the header identified by name is currently set in the outgoing headers.
-   * The header name matching is case-insensitive.
-   *
-   * Examples:
-   *
-   *     this.has('Content-Type');
-   *     // => true
-   *
-   *     this.get('content-type');
-   *     // => true
-   */
-  has(field: string): boolean;
-  /**
-   * Set header `field` to `val` or pass
-   * an object of header fields.
-   *
-   * Examples:
-   *
-   *    this.set('Foo', ['bar', 'baz']);
-   *    this.set('Accept', 'application/json');
-   *    this.set({ Accept: 'text/plain', 'X-API-Key': 'tobi' });
-   */
-  set(field: string | Record<string, string>, val?: string | number | unknown[]): void;
-  /**
-   * Append additional header `field` with value `val`.
-   *
-   * Examples:
-   *
-   * ```
-   * this.append('Link', ['<http://localhost/>', '<http://localhost:3000/>']);
-   * this.append('Set-Cookie', 'foo=bar; Path=/; HttpOnly');
-   * this.append('Warning', '199 Miscellaneous warning');
-   */
-  append(field: string, val: string | string[]): void;
-  /**
-   * Remove header `field`.
-   */
-  remove(field: string): void;
-  /**
-   * Checks if the request is writable.
-   * Tests for the existence of the socket
-   * as node sometimes does not set it.
-   */
-  get writable(): boolean;
-  /**
-   * Inspect implementation.
-   */
-  inspect(): {
-    status: number;
-    message: string;
-    header: http0.OutgoingHttpHeaders;
-  } | undefined;
-  [util.inspect.custom](): {
-    status: number;
-    message: string;
-    header: http0.OutgoingHttpHeaders;
-  } | undefined;
-  /**
-   * Return JSON representation.
-   */
-  toJSON(): {
-    status: number;
-    message: string;
-    header: http0.OutgoingHttpHeaders;
-  };
-  /**
-   * Flush any set headers and begin the body
-   */
-  flushHeaders(): void;
+import Stream from 'node:stream';
+import type { IncomingMessage, OutgoingHttpHeaders, ServerResponse } from 'node:http';
+import { type Options as ContentDispositionOptions } from 'content-disposition';
+import type { Application } from './application.ts';
+import type { Context } from './context.ts';
+import type { Request } from './request.ts';
+export declare class Response {
+    [key: symbol]: unknown;
+    app: Application;
+    req: IncomingMessage;
+    res: ServerResponse;
+    ctx: Context;
+    request: Request;
+    constructor(app: Application, ctx: Context, req: IncomingMessage, res: ServerResponse);
+    /**
+     * Return the request socket.
+     */
+    get socket(): ServerResponse['socket'];
+    /**
+     * Return response header.
+     */
+    get header(): OutgoingHttpHeaders;
+    /**
+     * Return response header, alias as response.header
+     */
+    get headers(): OutgoingHttpHeaders;
+    _explicitStatus: boolean;
+    /**
+     * Get response status code.
+     */
+    get status(): number;
+    /**
+     * Set response status code.
+     */
+    set status(code: number);
+    /**
+     * Get response status message
+     */
+    get message(): string;
+    /**
+     * Set response status message
+     */
+    set message(msg: string);
+    _body: any;
+    _explicitNullBody: boolean;
+    /**
+     * Get response body.
+     */
+    get body(): string | Buffer | object | Stream | null | undefined | boolean;
+    /**
+     * Set response body.
+     */
+    set body(val: string | Buffer | object | Stream | null | undefined | boolean);
+    /**
+     * Set Content-Length field to `n`.
+     */
+    set length(n: number | string | undefined);
+    /**
+     * Return parsed response Content-Length when present.
+     *
+     * When Content-Length is not defined it will return `undefined`.
+     */
+    get length(): number | undefined;
+    /**
+     * Check if a header has been written to the socket.
+     */
+    get headerSent(): boolean;
+    /**
+     * Vary on `field`.
+     */
+    vary(field: string): void;
+    protected _getBackReferrer(): string | undefined;
+    /**
+     * Perform a 302 redirect to `url`.
+     *
+     * The string "back" is special-cased
+     * to provide Referrer support, when Referrer
+     * is not present `alt` or "/" is used.
+     *
+     * Examples:
+     *
+     *    this.redirect('back');
+     *    this.redirect('back', '/index.html');
+     *    this.redirect('/login');
+     *    this.redirect('http://google.com'); // will format to 'http://google.com/'
+     */
+    redirect(url: string, alt?: string): void;
+    /**
+     * Set Content-Disposition header to "attachment" with optional `filename`.
+     */
+    attachment(filename?: string, options?: ContentDispositionOptions): void;
+    /**
+     * Set Content-Type response header with `type` through `mime.lookup()`
+     * when it does not contain a charset.
+     *
+     * Examples:
+     *
+     *     this.type = '.html';
+     *     this.type = 'html';
+     *     this.type = 'json';
+     *     this.type = 'application/json';
+     *     this.type = 'png';
+     */
+    set type(type: string | null | undefined);
+    /**
+     * Return the response mime type void of
+     * parameters such as "charset".
+     */
+    get type(): string;
+    /**
+     * Check whether the response is one of the listed types.
+     * Pretty much the same as `this.request.is()`.
+     *
+     *     this.response.is('html')
+     *     this.response.is('html', 'json')
+     */
+    is(type?: string | string[], ...types: string[]): string | false;
+    /**
+     * Set the Last-Modified date using a string or a Date.
+     *
+     *     this.response.lastModified = new Date();
+     *     this.response.lastModified = '2013-09-13';
+     */
+    set lastModified(val: string | Date | undefined);
+    /**
+     * Get the Last-Modified date in Date form, if it exists.
+     */
+    get lastModified(): Date | undefined;
+    /**
+     * Set the ETag of a response.
+     * This will normalize the quotes if necessary.
+     *
+     *     this.response.etag = 'md5-hash-sum';
+     *     this.response.etag = '"md5-hash-sum"';
+     *     this.response.etag = 'W/"123456789"';
+     */
+    set etag(val: string);
+    /**
+     * Get the ETag of a response.
+     */
+    get etag(): string;
+    /**
+     * Return response header.
+     *
+     * Examples:
+     *
+     *     this.get('Content-Type');
+     *     // => "text/plain"
+     *
+     *     this.get('content-type');
+     *     // => "text/plain"
+     */
+    get<T = string | string[] | number>(field: string): T;
+    /**
+     * Returns true if the header identified by name is currently set in the outgoing headers.
+     * The header name matching is case-insensitive.
+     *
+     * Examples:
+     *
+     *     this.has('Content-Type');
+     *     // => true
+     *
+     *     this.get('content-type');
+     *     // => true
+     */
+    has(field: string): boolean;
+    /**
+     * Set header `field` to `val` or pass
+     * an object of header fields.
+     *
+     * Examples:
+     *
+     *    this.set('Foo', ['bar', 'baz']);
+     *    this.set('Accept', 'application/json');
+     *    this.set({ Accept: 'text/plain', 'X-API-Key': 'tobi' });
+     */
+    set(field: string | Record<string, string>, val?: string | number | unknown[]): void;
+    /**
+     * Append additional header `field` with value `val`.
+     *
+     * Examples:
+     *
+     * ```
+     * this.append('Link', ['<http://localhost/>', '<http://localhost:3000/>']);
+     * this.append('Set-Cookie', 'foo=bar; Path=/; HttpOnly');
+     * this.append('Warning', '199 Miscellaneous warning');
+     */
+    append(field: string, val: string | string[]): void;
+    /**
+     * Remove header `field`.
+     */
+    remove(field: string): void;
+    /**
+     * Checks if the request is writable.
+     * Tests for the existence of the socket
+     * as node sometimes does not set it.
+     */
+    get writable(): boolean;
+    /**
+     * Inspect implementation.
+     */
+    inspect(): object | undefined;
+    /**
+     * Return JSON representation.
+     */
+    toJSON(): object;
+    /**
+     * Flush any set headers and begin the body
+     */
+    flushHeaders(): void;
 }
-//#endregion
-export { Response };