`Interface` ContextInterface

Hierarchy

Context

↳ ContextInterface

Indexable

[key: string]: any

Index

Properties

Methods

Properties

URL

URL: URL

Inherited from ContextDelegatedRequest.URL

Get WHATWG parsed URL object.

accept

accept: Accepts

Inherited from Context.accept

app

app: Application

Inherited from Context.app

assert

assert: assert

Inherited from BaseContext.assert

Similar to .throw(), adds assertion.

this.assert(this.user, 401, 'Please login!');

See: https://github.com/jshttp/http-assert

body

body: any

Inherited from ContextDelegatedResponse.body

Get/Set response body.

cookies

cookies: Cookies

Inherited from Context.cookies

etag

etag: string

Inherited from ContextDelegatedResponse.etag

Get/Set the ETag of a response. This will normalize the quotes if necessary.

this.response.etag = 'md5hashsum';
this.response.etag = '"md5hashsum"';
this.response.etag = 'W/"123456789"';

param:

api: public

fresh

fresh: boolean

Inherited from ContextDelegatedRequest.fresh

Check if the request is fresh, aka Last-Modified and/or the ETag still match.

header

header: any

Inherited from ContextDelegatedRequest.header

Return request header.

headerSent

headerSent: boolean

Inherited from ContextDelegatedResponse.headerSent

Check if a header has been written to the socket.

headers

headers: any

Inherited from ContextDelegatedRequest.headers

Return request header, alias as request.header

host

host: string

Inherited from ContextDelegatedRequest.host

Parse the "Host" header field host and support X-Forwarded-Host when a proxy is enabled.

hostname

hostname: string

Inherited from ContextDelegatedRequest.hostname

Parse the "Host" header field hostname and support X-Forwarded-Host when a proxy is enabled.

href

href: string

Inherited from ContextDelegatedRequest.href

Get full request URL.

idempotent

idempotent: boolean

Inherited from ContextDelegatedRequest.idempotent

Check if the request is idempotent.

ip

ip: string

Inherited from ContextDelegatedRequest.ip

Request remote address. Supports X-Forwarded-For when app.proxy is true.

ips

ips: string[]

Inherited from ContextDelegatedRequest.ips

When app.proxy is true, parse the "X-Forwarded-For" ip address list.

For example if the value were "client, proxy1, proxy2" you would receive the array ["client", "proxy1", "proxy2"] where "proxy2" is the furthest down-stream.

lastModified

lastModified: Date

Inherited from ContextDelegatedResponse.lastModified

Get the Last-Modified date in Date form, if it exists. Set the Last-Modified date using a string or a Date.

this.response.lastModified = new Date();
this.response.lastModified = '2013-09-13';

length

length: number

Inherited from ContextDelegatedResponse.length

Return parsed response Content-Length when present. Set Content-Length field to n.

message

message: string

Inherited from ContextDelegatedResponse.message

Get response status message

method

method: string

Inherited from ContextDelegatedRequest.method

Get/Set request method.

origin

origin: string

Inherited from ContextDelegatedRequest.origin

Get origin of URL.

originalUrl

originalUrl: string

Inherited from Context.originalUrl

path

path: string

Inherited from ContextDelegatedRequest.path

Get request pathname. Set pathname, retaining the query-string when present.

protocol

protocol: string

Inherited from ContextDelegatedRequest.protocol

Return the protocol string "http" or "https" when requested with TLS. When the proxy setting is enabled the "X-Forwarded-Proto" header field will be trusted. If you're running behind a reverse proxy that supplies https for you this may be enabled.

query

query: any

Inherited from ContextDelegatedRequest.query

Get parsed query-string. Set query-string as an object.

querystring

querystring: string

Inherited from ContextDelegatedRequest.querystring

Get/Set query string.

req

req: IncomingMessage

Inherited from Context.req

request

request: Request

Inherited from Context.request

res

res: ServerResponse

Inherited from Context.res

`Optional` respond

respond: boolean

Inherited from Context.respond

To bypass Koa's built-in response handling, you may explicitly set ctx.respond = false;

response

response: Response

Inherited from Context.response

search

search: string

Inherited from ContextDelegatedRequest.search

Get the search string. Same as the querystring except it includes the leading ?.

Set the search string. Same as response.querystring= but included for ubiquity.

secure

secure: boolean

Inherited from ContextDelegatedRequest.secure

Short-hand for:

this.protocol == 'https'

socket

socket: Socket

Inherited from ContextDelegatedRequest.socket

Return the request socket.

stale

stale: boolean

Inherited from ContextDelegatedRequest.stale

Check if the request is stale, aka "Last-Modified" and / or the "ETag" for the resource has changed.

state

state: object

Overrides Context.state

Defined in Library/Interface/ContextInterface.ts:6

Type declaration

Optional dispatch: object

action: string

controller: AbstractActionController

controllerName: string

Optional params: object

Optional response: Response

status

status: number

Inherited from ContextDelegatedResponse.status

Get/Set response status code.

subdomains

subdomains: string[]

Inherited from ContextDelegatedRequest.subdomains

Return subdomains as an array.

Subdomains are the dot-separated parts of the host before the main domain of the app. By default, the domain of the app is assumed to be the last two parts of the host. This can be changed by setting app.subdomainOffset.

For example, if the domain is "tobi.ferrets.example.com": If app.subdomainOffset is not set, this.subdomains is ["ferrets", "tobi"]. If app.subdomainOffset is 3, this.subdomains is ["tobi"].

type

type: string

Inherited from ContextDelegatedResponse.type

Return the response mime type void of parameters such as "charset".

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';

url

url: string

Inherited from ContextDelegatedRequest.url

Get/Set request URL.

writable

writable: boolean

Inherited from ContextDelegatedResponse.writable

Checks if the request is writable. Tests for the existence of the socket as node sometimes does not set it.

Methods

accepts

accepts(): string[] | boolean

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

accepts(types: string[]): string | boolean

Inherited from ContextDelegatedRequest.accepts

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" 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
this.accepts('html');
// => "html"

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

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

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

Returns: string[] | boolean

Inherited from ContextDelegatedRequest.accepts

Parameters:

Name	Type
`Rest` types	`string`[]

Returns: string | boolean

Inherited from ContextDelegatedRequest.accepts

Parameters:

Name	Type
types	`string`[]

Returns: string | boolean

acceptsCharsets

acceptsCharsets(): string[] | boolean

acceptsCharsets(...charsets: string[]): string | boolean

acceptsCharsets(charsets: string[]): string | boolean

Inherited from ContextDelegatedRequest.acceptsCharsets

Return accepted charsets or best fit based on charsets.

Given Accept-Charset: utf-8, iso-8859-1;q=0.2, utf-7;q=0.5 an array sorted by quality is returned:

['utf-8', 'utf-7', 'iso-8859-1']

Returns: string[] | boolean

Inherited from ContextDelegatedRequest.acceptsCharsets

Parameters:

Name	Type
`Rest` charsets	`string`[]

Returns: string | boolean

Inherited from ContextDelegatedRequest.acceptsCharsets

Parameters:

Name	Type
charsets	`string`[]

Returns: string | boolean

acceptsEncodings

acceptsEncodings(): string[] | boolean

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

acceptsEncodings(encodings: string[]): string | boolean

Inherited from ContextDelegatedRequest.acceptsEncodings

Return accepted encodings or best fit based on encodings.

Given Accept-Encoding: gzip, deflate an array sorted by quality is returned:

['gzip', 'deflate']

Returns: string[] | boolean

Inherited from ContextDelegatedRequest.acceptsEncodings

Parameters:

Name	Type
`Rest` encodings	`string`[]

Returns: string | boolean

Inherited from ContextDelegatedRequest.acceptsEncodings

Parameters:

Name	Type
encodings	`string`[]

Returns: string | boolean

acceptsLanguages

acceptsLanguages(): string[] | boolean

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

acceptsLanguages(langs: string[]): string | boolean

Inherited from ContextDelegatedRequest.acceptsLanguages

Return accepted languages or best fit based on langs.

Given Accept-Language: en;q=0.8, es, pt an array sorted by quality is returned:

['es', 'pt', 'en']

Returns: string[] | boolean

Inherited from ContextDelegatedRequest.acceptsLanguages

Parameters:

Name	Type
`Rest` langs	`string`[]

Returns: string | boolean

Inherited from ContextDelegatedRequest.acceptsLanguages

Parameters:

Name	Type
langs	`string`[]

Returns: string | boolean

append

append(field: string, val: * string | string[]*): void

Inherited from ContextDelegatedResponse.append

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');

Parameters:

Name	Type
field	`string`
val	`string` \| `string`[]

Returns: void

attachment

attachment(filename: string): void

Inherited from ContextDelegatedResponse.attachment

Set Content-Disposition header to "attachment" with optional filename.

Parameters:

Name	Type
filename	`string`

Returns: void

flushHeaders

flushHeaders(): void

Inherited from ContextDelegatedResponse.flushHeaders

Flush any set headers, and begin the body

Returns: void

get

get(field: string): string

Inherited from ContextDelegatedRequest.get

Return request header.

The Referrer header field is special-cased, both Referrer and Referer are interchangeable.

Examples:

this.get('Content-Type');
// => "text/plain"

this.get('content-type');
// => "text/plain"

this.get('Something');
// => undefined

Parameters:

Name	Type
field	`string`

Returns: string

inspect

inspect(): any

Inherited from BaseContext.inspect

util.inspect() implementation, which just returns the JSON output.

Returns: any

is

is(...types: string[]): string | boolean

is(types: string[]): string | boolean

Inherited from ContextDelegatedRequest.is

Check if the incoming request contains the "Content-Type" header field, and it contains any of the give mime types. If there is no request body, null is returned. If there is no content type, false is returned. Otherwise, it returns the first type that matches.

Examples:

// With Content-Type: text/html; charset=utf-8
this.is('html'); // => 'html'
this.is('text/html'); // => 'text/html'
this.is('text/*', 'application/json'); // => 'text/html'

// When Content-Type is application/json
this.is('json', 'urlencoded'); // => 'json'
this.is('application/json'); // => 'application/json'
this.is('html', 'application/*'); // => 'application/json'

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

Parameters:

Name	Type
`Rest` types	`string`[]

Returns: string | boolean

Inherited from ContextDelegatedRequest.is

Parameters:

Name	Type
types	`string`[]

Returns: string | boolean

onerror

onerror(err: Error): void

Inherited from BaseContext.onerror

Default error handling.

Parameters:

Name	Type
err	`Error`

Returns: void

redirect

redirect(url: string, alt?: string): void

Inherited from ContextDelegatedResponse.redirect

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'));

Parameters:

Name	Type
url	`string`
`Optional` alt	`string`

Returns: void

remove

remove(field: string): void

Inherited from ContextDelegatedResponse.remove

Remove header field.

Parameters:

Name	Type
field	`string`

Returns: void

set

set(field: object): void

set(field: string, val: * string | string[]*): void

Inherited from ContextDelegatedResponse.set

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' });

Parameters:

Name	Type
field	`object`

Returns: void

Inherited from ContextDelegatedResponse.set

Parameters:

Name	Type
field	`string`
val	`string` \| `string`[]

Returns: void

throw

throw(message: string, code?: number, properties?: __type): never

throw(status: number): never

throw(...properties: Array< number | string | __type>): never

Inherited from BaseContext.throw

Throw an error with msg and optional status defaulting to 500. Note that these are user-level errors, and the message may be exposed to the client.

this.throw(403) this.throw('name required', 400) this.throw(400, 'name required') this.throw('something exploded') this.throw(new Error('invalid'), 400); this.throw(400, new Error('invalid'));

See: https://github.com/jshttp/http-errors

Parameters:

Name	Type
message	`string`
`Optional` code	`number`
`Optional` properties	`__type`

Returns: never

Inherited from BaseContext.throw

Parameters:

Name	Type
status	`number`

Returns: never

Inherited from BaseContext.throw

Parameters:

Name	Type
`Rest` properties	`Array`< `number` \| `string` \| `__type`>

Returns: never

toJSON

toJSON(): any

Inherited from BaseContext.toJSON

Return JSON representation.

Here we explicitly invoke .toJSON() on each object, as iteration will otherwise fail due to the getters and cause utilities such as clone() to fail.

Returns: any

vary

vary(field: string): void

Inherited from ContextDelegatedResponse.vary

Vary on field.

Parameters:

Name	Type
field	`string`

Returns: void

Interface ContextInterface

Hierarchy

Indexable

Index

Properties

Methods

Properties

URL

accept

app

assert

body

cookies

etag

fresh

header

headerSent

headers

host

hostname

href

idempotent

ip

ips

lastModified

length

message

method

origin

originalUrl

path

protocol

query

querystring

req

request

res

Optional respond

response

search

secure

socket

stale

state

Type declaration

status

subdomains

type

url

writable

Methods

accepts

acceptsCharsets

acceptsEncodings

acceptsLanguages

append

attachment

flushHeaders

get

inspect

is

onerror

redirect

remove

set

throw

toJSON

vary

`Interface` ContextInterface

`Optional` respond