HttpResponse
Defined in: index.cts:79
Outgoing HTTP response passed to handleHttpRequest.
Instances are proper Node.js stream.Writable objects — someReadable.pipe(res) works.
Chunks from write() / end() and piped data are buffered; the complete response is sent
once the handler’s Promise resolves. Real-time streaming to the client is not supported;
for push-based patterns use WebSockets instead.
setHeader(), getHeader(), removeHeader(), writeHead(status, [reason,] [headers]),
statusCode = N, write(chunk) and end([chunk]) all work as expected.
Array values for setHeader() produce multiple header lines (e.g. for Set-Cookie).
There are no trailers and no upgrade hook for non-WebSocket upgrades.
Extends
Section titled “Extends”EventEmitter
Properties
Section titled “Properties”statusCode
Section titled “statusCode”statusCode:
number
Defined in: index.cts:80
writableEnded
Section titled “writableEnded”
readonlywritableEnded:boolean
Defined in: index.cts:91
True once end() has been called.
writableFinished
Section titled “writableFinished”
readonlywritableFinished:boolean
Defined in: index.cts:93
True once the ‘finish’ event has fired.
Methods
Section titled “Methods”setHeader()
Section titled “setHeader()”setHeader(
name,value):void
Defined in: index.cts:81
Parameters
Section titled “Parameters”string
string | string[]
Returns
Section titled “Returns”void
getHeader()
Section titled “getHeader()”getHeader(
name):string|string[]
Defined in: index.cts:82
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”string | string[]
getHeaders()
Section titled “getHeaders()”getHeaders():
Record<string,string|string[]>
Defined in: index.cts:83
Returns
Section titled “Returns”Record<string, string | string[]>
hasHeader()
Section titled “hasHeader()”hasHeader(
name):boolean
Defined in: index.cts:84
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean
removeHeader()
Section titled “removeHeader()”removeHeader(
name):void
Defined in: index.cts:85
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
writeHead()
Section titled “writeHead()”Call Signature
Section titled “Call Signature”writeHead(
statusCode,headers?):this
Defined in: index.cts:86
Parameters
Section titled “Parameters”statusCode
Section titled “statusCode”number
headers?
Section titled “headers?”Record<string, string | string[]>
Returns
Section titled “Returns”this
Call Signature
Section titled “Call Signature”writeHead(
statusCode,reasonPhrase,headers?):this
Defined in: index.cts:87
Parameters
Section titled “Parameters”statusCode
Section titled “statusCode”number
reasonPhrase
Section titled “reasonPhrase”string
headers?
Section titled “headers?”Record<string, string | string[]>
Returns
Section titled “Returns”this
write()
Section titled “write()”write(
chunk,encoding?,cb?):boolean
Defined in: index.cts:88
Parameters
Section titled “Parameters”any
encoding?
Section titled “encoding?”string
() => void
Returns
Section titled “Returns”boolean
end(
chunk?,encoding?,cb?):this
Defined in: index.cts:89
Parameters
Section titled “Parameters”chunk?
Section titled “chunk?”any
encoding?
Section titled “encoding?”string
() => void
Returns
Section titled “Returns”this