Request | /request.ts | oak@v12.0.1

class Request

import { Request } from "https://dotland.deno.dev/x/oak@v12.0.1/request.ts";

An interface which provides information about the current request. The instance related to the current request is available on the {@link Context}'s .request property.

The interface contains several properties to get information about the request as well as several methods, which include content negotiation and the ability to decode a request body.

Constructors

new

Request(serverRequest: ServerRequest, unnamed 1?: OakRequestOptions)

Properties

readonly

hasBody: boolean

Is true if the request might have a body, otherwise false.

WARNING this is an unreliable API. In HTTP/2 in many situations you cannot determine if a request has a body or not unless you attempt to read the body, due to the streaming nature of HTTP/2. As of Deno 1.16.1, for HTTP/1.1, Deno also reflects that behaviour. The only reliable way to determine if a request has a body or not is to attempt to read the body.

readonly

headers: Headers

The Headers supplied in the request.

readonly

ip: string

Request remote address. When the application's .proxy is true, the X-Forwarded-For will be used to determine the requesting remote address.

readonly

ips: string[]

When the application's .proxy is true, this will be set to an array of IPs, ordered from upstream to downstream, based on the value of the header X-Forwarded-For. When false an empty array is returned.

readonly

method: HTTPMethods

The HTTP Method used by the request.

readonly

originalRequest: ServerRequest

Set to the value of the original Deno server request.

readonly

secure: boolean

Shortcut to request.url.protocol === "https:".

readonly

url: URL

A parsed URL for the request which complies with the browser standards. When the application's .proxy is true, this value will be based off of the X-Forwarded-Proto and X-Forwarded-Host header values if present in the request.

Methods

accepts(): string[] | undefined

Returns an array of media types, accepted by the requestor, in order of preference. If there are no encodings supplied by the requestor, then accepting any is implied is returned.

accepts(...types: string[]): string | undefined

For a given set of media types, return the best match accepted by the requestor. If there are no encoding that match, then the method returns undefined.

acceptsEncodings(): string[] | undefined

Returns an array of encodings, accepted by the requestor, in order of preference. If there are no encodings supplied by the requestor, then ["*"] is returned, matching any.

acceptsEncodings(...encodings: string[]): string | undefined

For a given set of encodings, return the best match accepted by the requestor. If there are no encodings that match, then the method returns undefined.

NOTE: You should always supply identity as one of the encodings to ensure that there is a match when the Accept-Encoding header is part of the request.

acceptsLanguages(): string[] | undefined

Returns an array of languages, accepted by the requestor, in order of preference. If there are no languages supplied by the requestor, ["*"] is returned, indicating any language is accepted.

acceptsLanguages(...langs: string[]): string | undefined

For a given set of languages, return the best match accepted by the requestor. If there are no languages that match, then the method returns undefined.

body(options: BodyOptions<"bytes">): BodyBytes

body(options: BodyOptions<"form">): BodyForm

body(options: BodyOptions<"form-data">): BodyFormData

body(options: BodyOptions<"json">): BodyJson

body(options: BodyOptions<"reader">): BodyReader

body(options: BodyOptions<"stream">): BodyStream

body(options: BodyOptions<"text">): BodyText

body(options?: BodyOptions): Body

[Symbol.for("Deno.customInspect")](inspect: (value: unknown) => string)

[Symbol.for("nodejs.util.inspect.custom")](

depth: number,

options: any,

inspect: (value: unknown, options?: unknown) => string,

)