Skip to main content

Class: request

A utility for managing requests.

Constructors​

new request()​

new request(): request

Returns​

request

Methods​

accepts()​

readonly accepts(request, type): string | false

Check if the given type(s) is acceptable, returning the best match when true, otherwise undefined, 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", a comma-delimited list such as "json, html, text/plain", 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
request.accepts('html');
// => "html"

// Accept: text/*, application/json
request.accepts('html');
// => "html"
request.accepts('text/html');
// => "text/html"
request.accepts('json, text');
// => "json"
request.accepts('application/json');
// => "application/json"

// Accept: text/*, application/json
request.accepts('image/png');
request.accepts('png');
// => false

// Accept: text/*;q=.5, application/json
request.accepts(['html', 'json']);
request.accepts('html, json');
// => "json"

Parameters​

• request: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

The ApplicationRequest object from your route handler.

• type: string

The Content Type

Returns​

string | false

Defined in​

utilities/exports/RequestUtil.ts:315

acceptsCharset()​

readonly acceptsCharset(request, 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​

• request: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

The ApplicationRequest object from your route handler.

• charset: string

The Content Charset

Returns​

string | false

Defined in​

utilities/exports/RequestUtil.ts:421

acceptsCharsets()​

readonly acceptsCharsets(request, ...charsets): 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​

• request: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

The ApplicationRequest object from your route handler.

• ...charsets: string[] | Charset[]

Returns​

string | false

Defined in​

utilities/exports/RequestUtil.ts:436

acceptsEncoding()​

readonly acceptsEncoding(request, 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​

• request: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

The ApplicationRequest object from your route handler.

• encoding: string

The Content Encoder

Returns​

string | false

Defined in​

utilities/exports/RequestUtil.ts:454

acceptsEncodings()​

readonly acceptsEncodings(request, ...encodings): 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​

• request: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

The ApplicationRequest object from your route handler.

• ...encodings: string[] | Encoder[]

Returns​

string | false

Defined in​

utilities/exports/RequestUtil.ts:469

acceptsLanguage()​

readonly acceptsLanguage(request, 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​

• request: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

The ApplicationRequest object from your route handler.

• lang: string

The Content Language

Returns​

string | false

Defined in​

utilities/exports/RequestUtil.ts:487

acceptsLanguages()​

readonly acceptsLanguages(request, ...langs): 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​

• request: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

The ApplicationRequest object from your route handler.

• ...langs: string[] | Language[]

Returns​

string | false

Defined in​

utilities/exports/RequestUtil.ts:502

acceptsType()​

readonly acceptsType(request, type): string | false

Check if the given type(s) is acceptable, returning the best match when true, otherwise undefined, 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", a comma-delimited list such as "json, html, text/plain", 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
request.accepts('html');
// => "html"

// Accept: text/*, application/json
request.accepts('html');
// => "html"
request.accepts('text/html');
// => "text/html"
request.accepts('json, text');
// => "json"
request.accepts('application/json');
// => "application/json"

// Accept: text/*, application/json
request.accepts('image/png');
request.accepts('png');
// => false

// Accept: text/*;q=.5, application/json
request.accepts(['html', 'json']);
request.accepts('html, json');
// => "json"

Parameters​

• request: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

The ApplicationRequest object from your route handler.

• type: string

The Content Type

Returns​

string | false

Defined in​

utilities/exports/RequestUtil.ts:360

acceptsTypes()​

readonly acceptsTypes(request, ...types): string | false

Check if the given type(s) is acceptable, returning the best match when true, otherwise undefined, 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", a comma-delimited list such as "json, html, text/plain", 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
request.accepts('html');
// => "html"

// Accept: text/*, application/json
request.accepts('html');
// => "html"
request.accepts('text/html');
// => "text/html"
request.accepts('json, text');
// => "json"
request.accepts('application/json');
// => "application/json"

// Accept: text/*, application/json
request.accepts('image/png');
request.accepts('png');
// => false

// Accept: text/*;q=.5, application/json
request.accepts(['html', 'json']);
request.accepts('html, json');
// => "json"

Parameters​

• request: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

The ApplicationRequest object from your route handler.

• ...types: string[] | ContentType[]

Returns​

string | false

Defined in​

utilities/exports/RequestUtil.ts:405

get()​

readonly get(request, field): undefined | string

Get value for header field.

Parameters​

• request: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

The ApplicationRequest object from your route handler.

• field: string

The HTTP request header field.

Returns​

undefined | string

Defined in​

utilities/exports/RequestUtil.ts:41

getHeader()​

readonly getHeader(request, field): undefined | string

Get value for header field.

Parameters​

• request: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

The ApplicationRequest object from your route handler.

• field: string

The HTTP request header field.

Returns​

undefined | string

Defined in​

utilities/exports/RequestUtil.ts:19

readonly header(request, field): undefined | string

Get value for header field.

Parameters​

• request: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

The ApplicationRequest object from your route handler.

• field: string

The HTTP request header field.

Returns​

undefined | string

Defined in​

utilities/exports/RequestUtil.ts:30

is()​

readonly is(request, type): null | string | false

Check if the incoming request contains the "Content-Type" header field, and it contains the give mime type.

Examples:

// With Content-Type: text/html; charset=utf-8
request.is('html');
request.is('text/html');
request.is('text/*');
// => true

// When Content-Type is application/json
request.is('json');
request.is('application/json');
request.is('application/*');
// => true

request.is('html');
// => false

Parameters​

• request: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

The ApplicationRequest object from your route handler.

• type: string | string[] | ContentType[]

The Content Type.

Returns​

null | string | false

Defined in​

utilities/exports/RequestUtil.ts:71

isContentType()​

readonly isContentType(request, type): null | string | false

Check if the incoming request contains the "Content-Type" header field, and it contains the give mime type.

Examples:

// With Content-Type: text/html; charset=utf-8
request.is('html');
request.is('text/html');
request.is('text/*');
// => true

// When Content-Type is application/json
request.is('json');
request.is('application/json');
request.is('application/*');
// => true

request.is('html');
// => false

Parameters​

• request: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

The ApplicationRequest object from your route handler.

• type: string | string[] | ContentType[]

The Content Type.

Returns​

null | string | false

Defined in​

utilities/exports/RequestUtil.ts:137

isType()​

readonly isType(request, type): null | string | false

Check if the incoming request contains the "Content-Type" header field, and it contains the give mime type.

Examples:

// With Content-Type: text/html; charset=utf-8
request.is('html');
request.is('text/html');
request.is('text/*');
// => true

// When Content-Type is application/json
request.is('json');
request.is('application/json');
request.is('application/*');
// => true

request.is('html');
// => false

Parameters​

• request: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

The ApplicationRequest object from your route handler.

• type: string | string[] | ContentType[]

The Content Type.

Returns​

null | string | false

Defined in​

utilities/exports/RequestUtil.ts:104

range()​

readonly range(request, size, options?): undefined | Ranges | Result

Parse Range header field, capping to the given size.

An array of ranges will be returned or negative numbers indicating an error parsing.

  • -2 signals a malformed header string
  • -1 signals an unsatisfiable range

Unspecified ranges such as "0-" require knowledge of your resource length. In the case of a byte range this is of course the total number of bytes. If the Range header field is not given undefined is returned. If the Range header field is given, return value is a result of range-parser. See more ./types/express/RangeParser.ts

NOTE: remember that ranges are inclusive, so for example "Range: users=0-3" should respond with 4 users when available, not 3.

Parameters​

• request: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

The ApplicationRequest object from your route handler.

• size: number

The maximum size of the resource.

• options?: Options

An object that can have the following properties:

  • combine: boolean - Specify if overlapping & adjacent ranges should be combined, defaults to false. When true, ranges will be combined and returned as if they were specified that way in the header.

Returns​

undefined | Ranges | Result

Defined in​

utilities/exports/RequestUtil.ts:267

verify()​

readonly verify(request, type): null | string | false

Check if the incoming request contains the "Content-Type" header field, and it contains the give mime type.

Examples:

// With Content-Type: text/html; charset=utf-8
request.is('html');
request.is('text/html');
request.is('text/*');
// => true

// When Content-Type is application/json
request.is('json');
request.is('application/json');
request.is('application/*');
// => true

request.is('html');
// => false

Parameters​

• request: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

The ApplicationRequest object from your route handler.

• type: string | string[] | ContentType[]

The Content Type.

Returns​

null | string | false

Defined in​

utilities/exports/RequestUtil.ts:170

verifyContentType()​

readonly verifyContentType(request, type): null | string | false

Check if the incoming request contains the "Content-Type" header field, and it contains the give mime type.

Examples:

// With Content-Type: text/html; charset=utf-8
request.is('html');
request.is('text/html');
request.is('text/*');
// => true

// When Content-Type is application/json
request.is('json');
request.is('application/json');
request.is('application/*');
// => true

request.is('html');
// => false

Parameters​

• request: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

The ApplicationRequest object from your route handler.

• type: string | string[] | ContentType[]

The Content Type.

Returns​

null | string | false

Defined in​

utilities/exports/RequestUtil.ts:236

verifyType()​

readonly verifyType(request, type): null | string | false

Check if the incoming request contains the "Content-Type" header field, and it contains the give mime type.

Examples:

// With Content-Type: text/html; charset=utf-8
request.is('html');
request.is('text/html');
request.is('text/*');
// => true

// When Content-Type is application/json
request.is('json');
request.is('application/json');
request.is('application/*');
// => true

request.is('html');
// => false

Parameters​

• request: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

The ApplicationRequest object from your route handler.

• type: string | string[] | ContentType[]

The Content Type.

Returns​

null | string | false

Defined in​

utilities/exports/RequestUtil.ts:203