Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Response

Response class.

Hierarchy

  • Response

Implements

  • any

Index

Properties

app

body

headers

headers: Headers = new Headers()

locals

locals: any

req

req: Request

status

status: Status = 200

Methods

append

  • append(field: string, value: string): this
  • Append additional header field with value val.

    Example:

    res.append('Set-Cookie', 'foo=bar; Path=/; HttpOnly'); res.append('Warning', '199 Miscellaneous warning');

    Parameters

    • field: string
    • value: string

    Returns this

    for chaining

attachment

  • attachment(filename: string): this
  • Set Content-Disposition header to attachment with optional filename.

    Parameters

    • filename: string

    Returns this

    for chaining

clearCookie

  • clearCookie(cookie: string | Cookie): this
  • Clear a cookie.

    Parameters

    Returns this

    for chaining

cookie

  • cookie(cookie: Cookie): this
  • Set a cookie. Sets the cookie path to "/" if not defined.

    Examples:

    // "Remember Me" for 15 minutes res.cookie({ name: "rememberme", value: "1", expires: new Date(Date.now() + 900000), httpOnly: true });

    Parameters

    Returns this

    for chaining

download

  • download(path: string, filename?: string): Promise<this | void>
  • Transfer the file at the given path as an attachment.

    Optionally providing an alternate attachment filename.

    This function will set the Content-Disposition header, overriding any existing Content-Disposition header in order to set the attachment and filename.

    This method uses res.sendFile().

    Parameters

    • path: string
    • Optional filename: string

    Returns Promise<this | void>

end

etag

  • etag(chunk: string | Uint8Array | Deno.FileInfo): this
  • Sets an ETag header.

    publics

    Parameters

    • chunk: string | Uint8Array | Deno.FileInfo

    Returns this

    for chaining

get

  • get(field: string): string
  • Get value for header field.

    Parameters

    • field: string

    Returns string

    the header

json

  • Send JSON response.

    Examples:

    res.json(null);
    res.json({ user: 'tj' });

    Parameters

    Returns this

    for chaining

jsonp

  • Send JSON response with JSONP callback support.

    Examples:

    res.jsonp(null);
    res.jsonp({ user: 'tj' });

    Parameters

    Returns this

    for chaining

links

  • links(links: any): this

location

  • location(url: string): this
  • Set the location header to url.

    The given url can also be "back", which redirects to the Referrer or Referer headers or "/".

    Examples:

    res.location('/foo/bar').; res.location('http://example.com'); res.location('../login');

    Parameters

    • url: string

    Returns this

    for chaining

send

  • Send a response.

    Examples:

    res.send({ some: 'json' });
    res.send('<p>some html</p>');

    Parameters

    Returns this

    for chaining

sendFile

  • sendFile(path: string): Promise<this>
  • Transfer the file at the given path.

    Automatically sets the Content-Type response header field.

    Parameters

    • path: string

    Returns Promise<this>

sendStatus

  • sendStatus(code: Status): this
  • Send given HTTP status code.

    Sets the response status to code and the body of the response to the standard description from deno's http_status.STATUS_TEXT or the code number if no description.

    Examples:

    res.sendStatus(200);

    Parameters

    • code: Status

    Returns this

    for chaining

set

  • set(field: string, value: string): this
  • Set header field to value, or pass an object of header fields.

    Examples:

    res.set('Accept', 'application/json');

    Parameters

    • field: string
    • value: string

    Returns this

    for chaining

setStatus

  • setStatus(code: Status): this
  • Set status code.

    This method deviates from Express due to the naming clash with Deno.Response status property.

    Parameters

    • code: Status

    Returns this

    for chaining

type

  • type(type: string): this
  • Set Content-Type response header with type.

    Examples:

    res.type('.html');
    res.type('html');
    res.type('json');
    res.type('application/json');
    res.type('png');

    Parameters

    • type: string

    Returns this

    for chaining

unset

  • unset(field: string): this
  • Deletes a header.

    Parameters

    • field: string

    Returns this

    for chaining

Generated using TypeDoc