KoaResponseAdapter
Defined in: koa/adapter.ts:84
Adapter that converts GenericResponse methods to Koa Context
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new KoaResponseAdapter(
ctx):KoaResponseAdapter
Defined in: koa/adapter.ts:88
Parameters
Section titled “Parameters”Context
Returns
Section titled “Returns”KoaResponseAdapter
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get raw():
Context
Defined in: koa/adapter.ts:168
Get the underlying Koa context object
Returns
Section titled “Returns”Context
Methods
Section titled “Methods”header()
Section titled “header()”header(
name,value):void
Defined in: koa/adapter.ts:97
Set response header
Parameters
Section titled “Parameters”string
string
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”isWritable()
Section titled “isWritable()”isWritable():
boolean
Defined in: koa/adapter.ts:161
Check if response is writable
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”send()
Section titled “send()”send(
data):void
Defined in: koa/adapter.ts:103
Send JSON response
Parameters
Section titled “Parameters”any
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”status()
Section titled “status()”status(
code):void
Defined in: koa/adapter.ts:90
Set HTTP status code
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”stream()
Section titled “stream()”stream(
generator):Promise<void>
Defined in: koa/adapter.ts:121
Send streaming response (SSE)
Parameters
Section titled “Parameters”generator
Section titled “generator”AsyncGenerator<any, void, undefined>
Returns
Section titled “Returns”Promise<void>