KoaRequestAdapter
Defined in: koa/adapter.ts:16
Adapter that converts Koa Context to GenericRequest
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new KoaRequestAdapter(
ctx):KoaRequestAdapter
Defined in: koa/adapter.ts:17
Parameters
Section titled “Parameters”Context
Returns
Section titled “Returns”KoaRequestAdapter
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get body():
any
Defined in: koa/adapter.ts:41
Parsed request body (null if not yet parsed)
Returns
Section titled “Returns”any
Parsed request body (null if not yet parsed)
Implementation of
Section titled “Implementation of”headers
Section titled “headers”Get Signature
Section titled “Get Signature”get headers():
Record<string,string>
Defined in: koa/adapter.ts:27
Request headers (normalized to lowercase keys)
Returns
Section titled “Returns”Record<string, string>
Request headers (normalized to lowercase keys)
Implementation of
Section titled “Implementation of”Get Signature
Section titled “Get Signature”get ip():
string|undefined
Defined in: koa/adapter.ts:68
Client IP address
Returns
Section titled “Returns”string | undefined
Client IP address
Implementation of
Section titled “Implementation of”method
Section titled “method”Get Signature
Section titled “Get Signature”get method():
string
Defined in: koa/adapter.ts:19
HTTP method (GET, POST, etc.)
Returns
Section titled “Returns”string
HTTP method (GET, POST, etc.)
Implementation of
Section titled “Implementation of”params
Section titled “params”Get Signature
Section titled “Get Signature”get params():
Record<string,string> |undefined
Defined in: koa/adapter.ts:46
URL parameters (e.g., /users/:id -> { id: ‘123’ })
Returns
Section titled “Returns”Record<string, string> | undefined
URL parameters (e.g., /users/:id -> { id: ‘123’ })
Implementation of
Section titled “Implementation of”Get Signature
Section titled “Get Signature”get query():
Record<string,string> |undefined
Defined in: koa/adapter.ts:51
Query string parameters
Returns
Section titled “Returns”Record<string, string> | undefined
Query string parameters
Implementation of
Section titled “Implementation of”Get Signature
Section titled “Get Signature”get raw():
Context
Defined in: koa/adapter.ts:76
Get the underlying Koa context object
Returns
Section titled “Returns”Context
Get Signature
Section titled “Get Signature”get url():
string
Defined in: koa/adapter.ts:23
Full request URL
Returns
Section titled “Returns”string
Full request URL