Get WHATWG parsed URL object.
Similar to .throw(), adds assertion.
this.assert(this.user, 401, 'Please login!');
Get/Set response body.
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"';Check if the request is fresh, aka Last-Modified and/or the ETag still match.
Return request header.
Check if a header has been written to the socket.
Return request header, alias as request.header
Parse the "Host" header field host and support X-Forwarded-Host when a proxy is enabled.
Parse the "Host" header field hostname and support X-Forwarded-Host when a proxy is enabled.
Get full request URL.
Check if the request is idempotent.
Request remote address. Supports X-Forwarded-For when app.proxy is true.
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.
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';Return parsed response Content-Length when present.
Set Content-Length field to n.
Get response status message
Get/Set request method.
Get origin of URL.
Get request pathname. Set pathname, retaining the query-string when present.
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.
Get parsed query-string. Set query-string as an object.
Get/Set query string.
To bypass Koa's built-in response handling, you may explicitly set ctx.respond = false;
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.
Short-hand for:
this.protocol == 'https'
Return the request socket.
Check if the request is stale, aka "Last-Modified" and / or the "ETag" for the resource has changed.
Get/Set response status code.
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"].
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';Get/Set request URL.
Checks if the request is writable. Tests for the existence of the socket as node sometimes does not set it.
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"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']Return accepted encodings or best fit based on encodings.
Given Accept-Encoding: gzip, deflate
an array sorted by quality is returned:
['gzip', 'deflate']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']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');Set Content-Disposition header to "attachment" with optional filename.
Flush any set headers, and begin the body
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');
// => undefinedutil.inspect() implementation, which just returns the JSON output.
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'); // => falseDefault error handling.
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');
Remove header field.
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' });
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'));
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.
Vary on field.
Generated using TypeDoc
Custom properties.