Interface Request

Readonly baseUrl

Readonly body

Readonly cookies

Readonly fullApiPath

Readonly fullPath

Readonly headers

Readonly hostname

Readonly ip

Readonly ips

Readonly method

Readonly originalUrl

Readonly params

Readonly path

Readonly protocol

Readonly query

Readonly secure

Readonly signedCookies

Readonly subdomains

Readonly xhr

accepts

• accepts(): string[]

• Checks if the specified content types are acceptable, based on the request’s Accept HTTP header field. The method returns the best match, or if none of the specified content types is acceptable, returns false (in which case, the application should respond with 406 "Not Acceptable").

  The type value may be a single MIME type string (such as “application/json”), an extension name such as “json”, a comma-delimited list, or an array. For a list or array, the method returns the best match (if any).

  Returns string[]
• accepts(type): string | false

• Checks if the specified content types are acceptable, based on the request’s Accept HTTP header field. The method returns the best match, or if none of the specified content types is acceptable, returns false (in which case, the application should respond with 406 "Not Acceptable").

  The type value may be a single MIME type string (such as “application/json”), an extension name such as “json”, a comma-delimited list, or an array. For a list or array, the method returns the best match (if any).

  Parameters

  • type: string | string[]

  Returns string | false

acceptsCharsets

• acceptsCharsets(): string[]

• Returns the first accepted charset of the specified character sets, based on the request’s Accept-Charset HTTP header field. If none of the specified charsets is accepted, returns false.

  For more information, or if you have issues or concerns, see accepts.

  Returns string[]
• acceptsCharsets(charset): string | false

• Returns the first accepted charset of the specified character sets, based on the request’s Accept-Charset HTTP header field. If none of the specified charsets is accepted, returns false.

  For more information, or if you have issues or concerns, see accepts.

  Parameters

  • charset: string | string[]

  Returns string | false

acceptsEncodings

• acceptsEncodings(): string[]

• Returns the first accepted encoding of the specified encodings, based on the request’s Accept-Encoding HTTP header field. If none of the specified encodings is accepted, returns false.

  For more information, or if you have issues or concerns, see accepts.

  Returns string[]
• acceptsEncodings(encoding): string | false

• Returns the first accepted encoding of the specified encodings, based on the request’s Accept-Encoding HTTP header field. If none of the specified encodings is accepted, returns false.

  For more information, or if you have issues or concerns, see accepts.

  Parameters

  • encoding: string | string[]

  Returns string | false

acceptsLanguages

• acceptsLanguages(): string[]

• Returns the first accepted language of the specified languages, based on the request’s Accept-Language HTTP header field. If none of the specified languages is accepted, returns false.

  For more information, or if you have issues or concerns, see accepts.

  Returns string[]
• acceptsLanguages(lang): string | false

• Returns the first accepted language of the specified languages, based on the request’s Accept-Language HTTP header field. If none of the specified languages is accepted, returns false.

  For more information, or if you have issues or concerns, see accepts.

  Parameters

  • lang: string | string[]

  Returns string | false

get

• get(field): undefined | string

• Parameters

  • field: string

    The header field name.

  Returns undefined | string

  • The header field value.

header

• header(field): string

• Parameters

  • field: string

    The header field name.

  Returns string

  • The header field value.

is

• is(type): null | string | false

• Parameters

  • type: string | string[]

  Returns null | string | false

  • The header field value.