Koa.BaseContext.md

nextjs-koa-api / Koa / BaseContext

Interface: BaseContext

Koa.BaseContext

Hierarchy

• ContextDelegatedRequest

• ContextDelegatedResponse

  ↳ BaseContext

  ↳↳ ExtendableContext

Table of contents

Properties

• URL
• assert
• body
• etag
• fresh
• header
• headerSent
• headers
• host
• hostname
• href
• idempotent
• ip
• ips
• lastModified
• length
• message
• method
• origin
• path
• protocol
• query
• querystring
• search
• secure
• socket
• stale
• status
• subdomains
• type
• url
• writable

Methods

• accepts
• acceptsCharsets
• acceptsEncodings
• acceptsLanguages
• append
• attachment
• flushHeaders
• get
• inspect
• is
• onerror
• redirect
• remove
• set
• throw
• toJSON
• vary

Properties

URL

• URL: URL

Get WHATWG parsed URL object.

Inherited from

ContextDelegatedRequest.URL

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:113

---

assert

• assert: typeof assert

Similar to .throw(), adds assertion.

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

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

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:676

---

body

• body: unknown

Get/Set response body.

Inherited from

ContextDelegatedResponse.body

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:321

---

etag

• etag: string

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

Inherited from

ContextDelegatedResponse.etag

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:398

---

fresh

• fresh: boolean

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

Inherited from

ContextDelegatedRequest.fresh

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:120

---

header

• header: IncomingHttpHeaders

Return request header.

Inherited from

ContextDelegatedRequest.header

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:43

---

headerSent

• headerSent: boolean

Check if a header has been written to the socket.

Inherited from

ContextDelegatedResponse.headerSent

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:332

---

headers

• headers: IncomingHttpHeaders

Return request header, alias as request.header

Inherited from

ContextDelegatedRequest.headers

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:48

---

host

• host: string

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

Inherited from

ContextDelegatedRequest.host

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:101

---

hostname

• hostname: string

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

Inherited from

ContextDelegatedRequest.hostname

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:108

---

href

• href: string

Get full request URL.

Inherited from

ContextDelegatedRequest.href

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:63

---

idempotent

• idempotent: boolean

Check if the request is idempotent.

Inherited from

ContextDelegatedRequest.idempotent

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:132

---

ip

• ip: string

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

Inherited from

ContextDelegatedRequest.ip

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:159

---

ips

• ips: string[]

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.

Inherited from

ContextDelegatedRequest.ips

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:169

---

lastModified

• lastModified: Date

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

Inherited from

ContextDelegatedResponse.lastModified

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:385

---

length

• length: number

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

Inherited from

ContextDelegatedResponse.length

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:327

---

message

• message: string

Get response status message

Inherited from

ContextDelegatedResponse.message

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:316

---

method

• method: string

Get/Set request method.

Inherited from

ContextDelegatedRequest.method

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:68

---

origin

• origin: string

Get origin of URL.

Inherited from

ContextDelegatedRequest.origin

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:58

---

path

• path: string

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

Inherited from

ContextDelegatedRequest.path

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:74

---

protocol

• protocol: string

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.

Inherited from

ContextDelegatedRequest.protocol

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:147

---

query

• query: ParsedUrlQuery

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

Inherited from

ContextDelegatedRequest.query

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:80

---

querystring

• querystring: string

Get/Set query string.

Inherited from

ContextDelegatedRequest.querystring

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:85

---

search

• search: string

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.

Inherited from

ContextDelegatedRequest.search

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:94

---

secure

• secure: boolean

Short-hand for:

this.protocol == 'https'

Inherited from

ContextDelegatedRequest.secure

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:154

---

socket

• socket: Socket

Return the request socket.

Inherited from

ContextDelegatedRequest.socket

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:137

---

stale

• stale: boolean

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

Inherited from

ContextDelegatedRequest.stale

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:127

---

status

• status: number

Get/Set response status code.

Inherited from

ContextDelegatedResponse.status

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:311

---

subdomains

• subdomains: string[]

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"].

Inherited from

ContextDelegatedRequest.subdomains

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:183

---

type

• type: string

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

Inherited from

ContextDelegatedResponse.type

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:376

---

url

• url: string

Get/Set request URL.

Inherited from

ContextDelegatedRequest.url

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:53

---

writable

• writable: boolean

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

Inherited from

ContextDelegatedResponse.writable

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:436

Methods

accepts

▸ accepts(): string[]

Check if the given type(s) is acceptable, returning the best match when true, otherwise false, 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[]

Inherited from

ContextDelegatedRequest.accepts

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:221

▸ accepts(...types): string | false

Parameters

Name	Type
...types	string[]

Returns

string | false

Inherited from

ContextDelegatedRequest.accepts

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:222

▸ accepts(types): string | false

Parameters

Name	Type
types	string[]

Returns

string | false

Inherited from

ContextDelegatedRequest.accepts

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:223

---

acceptsCharsets

▸ acceptsCharsets(): string[]

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[]

Inherited from

ContextDelegatedRequest.acceptsCharsets

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:245

▸ acceptsCharsets(...charsets): string | false

Parameters

Name	Type
...charsets	string[]

Returns

string | false

Inherited from

ContextDelegatedRequest.acceptsCharsets

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:246

▸ acceptsCharsets(charsets): string | false

Parameters

Name	Type
charsets	string[]

Returns

string | false

Inherited from

ContextDelegatedRequest.acceptsCharsets

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:247

---

acceptsEncodings

▸ acceptsEncodings(): string[]

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[]

Inherited from

ContextDelegatedRequest.acceptsEncodings

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:233

▸ acceptsEncodings(...encodings): string | false

Parameters

Name	Type
...encodings	string[]

Returns

string | false

Inherited from

ContextDelegatedRequest.acceptsEncodings

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:234

▸ acceptsEncodings(encodings): string | false

Parameters

Name	Type
encodings	string[]

Returns

string | false

Inherited from

ContextDelegatedRequest.acceptsEncodings

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:235

---

acceptsLanguages

▸ acceptsLanguages(): string[]

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[]

Inherited from

ContextDelegatedRequest.acceptsLanguages

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:257

▸ acceptsLanguages(...langs): string | false

Parameters

Name	Type
...langs	string[]

Returns

string | false

Inherited from

ContextDelegatedRequest.acceptsLanguages

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:258

▸ acceptsLanguages(langs): string | false

Parameters

Name	Type
langs	string[]

Returns

string | false

Inherited from

ContextDelegatedRequest.acceptsLanguages

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:259

---

append

▸ append(field, val): void

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

Inherited from

ContextDelegatedResponse.append

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:424

---

attachment

▸ attachment(filename?, options?): void

Set Content-Disposition to "attachment" to signal the client to prompt for download. Optionally specify the filename of the download and some options.

Parameters

Name	Type
filename?	string
options?	Options

Returns

void

Inherited from

ContextDelegatedResponse.attachment

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:359

---

flushHeaders

▸ flushHeaders(): void

Flush any set headers, and begin the body

Returns

void

Inherited from

ContextDelegatedResponse.flushHeaders

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:441

---

get

▸ get(field): string

Return request header. If the header is not set, will return an empty string.

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

Parameters

Name	Type
field	string

Returns

string

Inherited from

ContextDelegatedRequest.get

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:304

---

inspect

▸ inspect(): any

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

Returns

any

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:657

---

is

▸ is(...types): null | string | false

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
...types	string[]

Returns

null | string | false

Inherited from

ContextDelegatedRequest.is

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:283

▸ is(types): null | string | false

Parameters

Name	Type
types	string[]

Returns

null | string | false

Inherited from

ContextDelegatedRequest.is

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:284

---

onerror

▸ onerror(err): void

Default error handling.

Parameters

Name	Type
err	Error

Returns

void

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:699

---

redirect

▸ redirect(url, alt?): void

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
alt?	string

Returns

void

Inherited from

ContextDelegatedResponse.redirect

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:353

---

remove

▸ remove(field): void

Remove header field.

Parameters

Name	Type
field	string

Returns

void

Inherited from

ContextDelegatedResponse.remove

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:429

---

set

▸ set(field): void

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

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:410

▸ set(field, val): void

Parameters

Name	Type
field	string
val	string | string[]

Returns

void

Inherited from

ContextDelegatedResponse.set

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:411

---

throw

▸ throw(message, code?, properties?): never

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
code?	number
properties?	Object

Returns

never

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:692

▸ throw(status): never

Parameters

Name	Type
status	number

Returns

never

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:693

▸ throw(...properties): never

Parameters

Name	Type
...properties	(string | number | {})[]

Returns

never

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:694

---

toJSON

▸ toJSON(): any

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

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:667

---

vary

▸ vary(field): void

Vary on field.

Parameters

Name	Type
field	string

Returns

void

Inherited from

ContextDelegatedResponse.vary

Defined in

node_modules/.pnpm/@types+koa@2.13.4/node_modules/@types/koa/index.d.ts:337