2019-02-10 22:06:30 +00:00
<!doctype html>
< html class = "default no-js" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
2021-08-16 00:34:38 +00:00
< title > HttpResponse | uWebSockets.js v19.3.0 documentation< / title >
< meta name = "description" content = "Documentation for uWebSockets.js v19.3.0 documentation" >
2019-02-10 22:06:30 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< link rel = "stylesheet" href = "../assets/css/main.css" >
2021-08-16 00:34:38 +00:00
< script async src = "../assets/js/search.js" id = "search-script" > < / script >
2019-02-10 22:06:30 +00:00
< / head >
< body >
< header >
< div class = "tsd-page-toolbar" >
< div class = "container" >
< div class = "table-wrap" >
2020-06-20 19:55:17 +00:00
< div class = "table-cell" id = "tsd-search" data-index = "../assets/js/search.json" data-base = ".." >
2019-02-10 22:06:30 +00:00
< div class = "field" >
< label for = "tsd-search-field" class = "tsd-widget search no-caption" > Search< / label >
< input id = "tsd-search-field" type = "text" / >
< / div >
< ul class = "results" >
< li class = "state loading" > Preparing search index...< / li >
< li class = "state failure" > The search index is not available< / li >
< / ul >
2021-08-16 00:34:38 +00:00
< a href = "../index.html" class = "title" > uWebSockets.js v19.3.0 documentation< / a >
2019-02-10 22:06:30 +00:00
< / div >
< div class = "table-cell" id = "tsd-widgets" >
< div id = "tsd-filter" >
< a href = "#" class = "tsd-widget options no-caption" data-toggle = "options" > Options< / a >
< div class = "tsd-filter-group" >
< div class = "tsd-select" id = "tsd-filter-visibility" >
< span class = "tsd-select-label" > All< / span >
< ul class = "tsd-select-list" >
< li data-value = "public" > Public< / li >
< li data-value = "protected" > Public/Protected< / li >
< li data-value = "private" class = "selected" > All< / li >
< / ul >
< / div >
< input type = "checkbox" id = "tsd-filter-inherited" checked / >
< label class = "tsd-widget" for = "tsd-filter-inherited" > Inherited< / label >
< / div >
< / div >
< a href = "#" class = "tsd-widget menu no-caption" data-toggle = "menu" > Menu< / a >
< / div >
< / div >
< / div >
< / div >
< div class = "tsd-page-title" >
< div class = "container" >
< ul class = "tsd-breadcrumb" >
< li >
2021-08-16 00:34:38 +00:00
< a href = "../index.html" > uWebSockets.js v19.3.0 documentation< / a >
2019-02-10 22:06:30 +00:00
< / li >
< li >
2021-08-16 00:34:38 +00:00
< a href = "HttpResponse.html" > HttpResponse< / a >
2019-02-10 22:06:30 +00:00
< / li >
< / ul >
< h1 > Interface HttpResponse< / h1 >
< / div >
< / div >
< / header >
< div class = "container container-main" >
< div class = "row" >
< div class = "col-8 col-content" >
< section class = "tsd-panel tsd-comment" >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > An HttpResponse is valid until either onAborted callback or any of the .end/.tryEnd calls succeed. You may attach user data to this object.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-hierarchy" >
< h3 > Hierarchy< / h3 >
< ul class = "tsd-hierarchy" >
< li >
< span class = "target" > HttpResponse< / span >
< / li >
< / ul >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-kind-interface" >
2019-03-10 11:52:42 +00:00
< h3 class = "tsd-before-signature" > Indexable< / h3 >
< div class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > [< / span > key: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ]: < / span > < span class = "tsd-signature-type" > any< / span > < / div >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Arbitrary user data may be attached to this object< / p >
< / div >
< / div >
< / section >
2019-02-10 22:06:30 +00:00
< section class = "tsd-panel-group tsd-index-group" >
< h2 > Index< / h2 >
< section class = "tsd-panel tsd-index-panel" >
< div class = "tsd-index-content" >
2019-12-21 19:46:31 +00:00
< section class = "tsd-index-section " >
2019-02-10 22:06:30 +00:00
< h3 > Methods< / h3 >
< ul class = "tsd-index-list" >
2021-08-16 00:34:38 +00:00
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "HttpResponse.html#close" class = "tsd-kind-icon" > close< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "HttpResponse.html#cork" class = "tsd-kind-icon" > cork< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "HttpResponse.html#end" class = "tsd-kind-icon" > end< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "HttpResponse.html#getProxiedRemoteAddress" class = "tsd-kind-icon" > get< wbr > Proxied< wbr > Remote< wbr > Address< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "HttpResponse.html#getProxiedRemoteAddressAsText" class = "tsd-kind-icon" > get< wbr > Proxied< wbr > Remote< wbr > Address< wbr > AsText< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "HttpResponse.html#getRemoteAddress" class = "tsd-kind-icon" > get< wbr > Remote< wbr > Address< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "HttpResponse.html#getRemoteAddressAsText" class = "tsd-kind-icon" > get< wbr > Remote< wbr > Address< wbr > AsText< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "HttpResponse.html#getWriteOffset" class = "tsd-kind-icon" > get< wbr > Write< wbr > Offset< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "HttpResponse.html#onAborted" class = "tsd-kind-icon" > on< wbr > Aborted< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "HttpResponse.html#onData" class = "tsd-kind-icon" > on< wbr > Data< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "HttpResponse.html#onWritable" class = "tsd-kind-icon" > on< wbr > Writable< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "HttpResponse.html#tryEnd" class = "tsd-kind-icon" > try< wbr > End< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter" > < a href = "HttpResponse.html#upgrade" class = "tsd-kind-icon" > upgrade< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "HttpResponse.html#write" class = "tsd-kind-icon" > write< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "HttpResponse.html#writeHeader" class = "tsd-kind-icon" > write< wbr > Header< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "HttpResponse.html#writeStatus" class = "tsd-kind-icon" > write< wbr > Status< / a > < / li >
2019-02-10 22:06:30 +00:00
< / ul >
< / section >
< / div >
< / section >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel-group tsd-member-group " >
2019-02-10 22:06:30 +00:00
< h2 > Methods< / h2 >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a name = "close" class = "tsd-anchor" > < / a >
< h3 > close< / h3 >
2019-12-21 19:46:31 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< li class = "tsd-signature tsd-kind-icon" > close< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "HttpResponse.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > HttpResponse< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2021-08-16 00:34:38 +00:00
< li > Defined in < a href = "https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L154" > index.d.ts:154< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
2020-06-20 19:55:17 +00:00
< p > Immediately force closes the connection. Any onAborted callback will run.< / p >
2019-02-13 03:13:35 +00:00
< / div >
< / div >
2021-08-16 00:34:38 +00:00
< h4 class = "tsd-returns-title" > Returns < a href = "HttpResponse.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > HttpResponse< / a > < / h4 >
2019-02-13 03:13:35 +00:00
< / li >
< / ul >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "cork" class = "tsd-anchor" > < / a >
< h3 > cork< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
2020-06-20 19:55:17 +00:00
< li class = "tsd-signature tsd-kind-icon" > cork< span class = "tsd-signature-symbol" > (< / span > cb< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
2019-12-21 19:46:31 +00:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2021-08-16 00:34:38 +00:00
< li > Defined in < a href = "https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L199" > index.d.ts:199< / a > < / li >
2019-12-21 19:46:31 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Corking a response is a performance improvement in both CPU and network, as you ready the IO system for writing multiple chunks at once.
By default, you' re corked in the immediately executing top portion of the route handler. In all other cases, such as when returning from
await, or when being called back from an async database request or anything that isn' t directly executing in the route handler, you' ll want
to cork before calling writeStatus, writeHeader or just write. Corking takes a callback in which you execute the writeHeader, writeStatus and
such calls, in one atomic IO operation. This is important, not only for TCP but definitely for TLS where each write would otherwise result
in one TLS block being sent off, each with one send syscall.< / p >
< / div >
< p > Example usage:< / p >
< p > res.cork(() => {
res.writeStatus(" 200 OK" ).writeHeader(" Some" , " Value" ).write(" Hello world!" );
});< / p >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2020-06-20 19:55:17 +00:00
< h5 > cb: < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > void< / span > < / h5 >
2019-12-21 19:46:31 +00:00
< ul class = "tsd-parameters" >
2020-06-20 19:55:17 +00:00
< li class = "tsd-parameter-signature" >
< ul class = "tsd-signatures tsd-kind-type-literal" >
2019-12-21 19:46:31 +00:00
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
2019-02-10 22:06:30 +00:00
< a name = "end" class = "tsd-anchor" > < / a >
< h3 > end< / h3 >
2019-12-21 19:46:31 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< li class = "tsd-signature tsd-kind-icon" > end< span class = "tsd-signature-symbol" > (< / span > body< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../index.html#RecognizedString" class = "tsd-signature-type" data-tsd-kind = "Type alias" > RecognizedString< / a > , closeConnection< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "HttpResponse.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > HttpResponse< / a > < / li >
2019-02-10 22:06:30 +00:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2021-08-16 00:34:38 +00:00
< li > Defined in < a href = "https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L149" > index.d.ts:149< / a > < / li >
2019-02-10 22:06:30 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Ends this response by copying the contents of body.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2021-08-16 00:34:38 +00:00
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > body: < a href = "../index.html#RecognizedString" class = "tsd-signature-type" data-tsd-kind = "Type alias" > RecognizedString< / a > < / h5 >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > closeConnection: < span class = "tsd-signature-type" > boolean< / span > < / h5 >
2019-02-10 22:06:30 +00:00
< / li >
< / ul >
2021-08-16 00:34:38 +00:00
< h4 class = "tsd-returns-title" > Returns < a href = "HttpResponse.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > HttpResponse< / a > < / h4 >
2019-02-13 03:13:35 +00:00
< / li >
< / ul >
< / section >
2020-06-08 12:29:54 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a name = "getProxiedRemoteAddress" class = "tsd-anchor" > < / a >
2020-06-08 12:29:54 +00:00
< h3 > get< wbr > Proxied< wbr > Remote< wbr > Address< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > get< wbr > Proxied< wbr > Remote< wbr > Address< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > ArrayBuffer< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2021-08-16 00:34:38 +00:00
< li > Defined in < a href = "https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L181" > index.d.ts:181< / a > < / li >
2020-06-08 12:29:54 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Returns the remote IP address in binary format (4 or 16 bytes), as reported by the PROXY Protocol v2 compatible proxy.< / p >
< / div >
< / div >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > ArrayBuffer< / span > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a name = "getProxiedRemoteAddressAsText" class = "tsd-anchor" > < / a >
2020-06-08 12:29:54 +00:00
< h3 > get< wbr > Proxied< wbr > Remote< wbr > Address< wbr > AsText< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > get< wbr > Proxied< wbr > Remote< wbr > Address< wbr > AsText< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > ArrayBuffer< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2021-08-16 00:34:38 +00:00
< li > Defined in < a href = "https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L184" > index.d.ts:184< / a > < / li >
2020-06-08 12:29:54 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Returns the remote IP address as text, as reported by the PROXY Protocol v2 compatible proxy.< / p >
< / div >
< / div >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > ArrayBuffer< / span > < / h4 >
< / li >
< / ul >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a name = "getRemoteAddress" class = "tsd-anchor" > < / a >
2019-03-03 07:15:48 +00:00
< h3 > get< wbr > Remote< wbr > Address< / h3 >
2019-12-21 19:46:31 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
2019-03-03 07:15:48 +00:00
< li class = "tsd-signature tsd-kind-icon" > get< wbr > Remote< wbr > Address< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > ArrayBuffer< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2021-08-16 00:34:38 +00:00
< li > Defined in < a href = "https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L175" > index.d.ts:175< / a > < / li >
2019-03-03 07:15:48 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
2020-06-08 12:29:54 +00:00
< p > Returns the remote IP address in binary format (4 or 16 bytes).< / p >
< / div >
< / div >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > ArrayBuffer< / span > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a name = "getRemoteAddressAsText" class = "tsd-anchor" > < / a >
2020-06-08 12:29:54 +00:00
< h3 > get< wbr > Remote< wbr > Address< wbr > AsText< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > get< wbr > Remote< wbr > Address< wbr > AsText< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > ArrayBuffer< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2021-08-16 00:34:38 +00:00
< li > Defined in < a href = "https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L178" > index.d.ts:178< / a > < / li >
2020-06-08 12:29:54 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Returns the remote IP address as text.< / p >
2019-03-03 07:15:48 +00:00
< / div >
< / div >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > ArrayBuffer< / span > < / h4 >
< / li >
< / ul >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a name = "getWriteOffset" class = "tsd-anchor" > < / a >
2019-02-13 03:13:35 +00:00
< h3 > get< wbr > Write< wbr > Offset< / h3 >
2019-12-21 19:46:31 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< li class = "tsd-signature tsd-kind-icon" > get< wbr > Write< wbr > Offset< span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2021-08-16 00:34:38 +00:00
< li > Defined in < a href = "https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L157" > index.d.ts:157< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Returns the global byte write offset for this response. Use with onWritable.< / p >
< / div >
< / div >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > number< / span > < / h4 >
< / li >
< / ul >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a name = "onAborted" class = "tsd-anchor" > < / a >
2019-02-13 03:13:35 +00:00
< h3 > on< wbr > Aborted< / h3 >
2019-12-21 19:46:31 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< li class = "tsd-signature tsd-kind-icon" > on< wbr > Aborted< span class = "tsd-signature-symbol" > (< / span > handler< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "HttpResponse.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > HttpResponse< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2021-08-16 00:34:38 +00:00
< li > Defined in < a href = "https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L169" > index.d.ts:169< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Every HttpResponse MUST have an attached abort handler IF you do not respond
to it immediately inside of the callback. Returning from an Http request handler
without attaching (by calling onAborted) an abort handler is ill-use and will termiante.
When this event emits, the response has been aborted and may not be used.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2020-06-20 19:55:17 +00:00
< h5 > handler: < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > void< / span > < / h5 >
2019-02-13 03:13:35 +00:00
< ul class = "tsd-parameters" >
2020-06-20 19:55:17 +00:00
< li class = "tsd-parameter-signature" >
< ul class = "tsd-signatures tsd-kind-type-literal" >
2019-11-18 18:37:30 +00:00
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
2021-08-16 00:34:38 +00:00
< h4 class = "tsd-returns-title" > Returns < a href = "HttpResponse.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > HttpResponse< / a > < / h4 >
2019-02-13 03:13:35 +00:00
< / li >
< / ul >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a name = "onData" class = "tsd-anchor" > < / a >
2019-02-13 03:13:35 +00:00
< h3 > on< wbr > Data< / h3 >
2019-12-21 19:46:31 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< li class = "tsd-signature tsd-kind-icon" > on< wbr > Data< span class = "tsd-signature-symbol" > (< / span > handler< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > chunk< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > ArrayBuffer< / span > , isLast< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "HttpResponse.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > HttpResponse< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2021-08-16 00:34:38 +00:00
< li > Defined in < a href = "https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L172" > index.d.ts:172< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Handler for reading data from POST and such requests. You MUST copy the data of chunk if isLast is not true. We Neuter ArrayBuffers on return, making it zero length.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2020-06-20 19:55:17 +00:00
< h5 > handler: < span class = "tsd-signature-symbol" > (< / span > chunk< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > ArrayBuffer< / span > , isLast< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > void< / span > < / h5 >
2019-02-13 03:13:35 +00:00
< ul class = "tsd-parameters" >
2020-06-20 19:55:17 +00:00
< li class = "tsd-parameter-signature" >
< ul class = "tsd-signatures tsd-kind-type-literal" >
2019-03-10 11:52:42 +00:00
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > chunk< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > ArrayBuffer< / span > , isLast< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > chunk: < span class = "tsd-signature-type" > ArrayBuffer< / span > < / h5 >
< / li >
< li >
< h5 > isLast: < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
2021-08-16 00:34:38 +00:00
< h4 class = "tsd-returns-title" > Returns < a href = "HttpResponse.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > HttpResponse< / a > < / h4 >
2019-02-13 03:13:35 +00:00
< / li >
< / ul >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a name = "onWritable" class = "tsd-anchor" > < / a >
2019-02-13 03:13:35 +00:00
< h3 > on< wbr > Writable< / h3 >
2019-12-21 19:46:31 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< li class = "tsd-signature tsd-kind-icon" > on< wbr > Writable< span class = "tsd-signature-symbol" > (< / span > handler< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > (< / span > offset< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "HttpResponse.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > HttpResponse< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2021-08-16 00:34:38 +00:00
< li > Defined in < a href = "https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L163" > index.d.ts:163< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Registers a handler for writable events. Continue failed write attempts in here.
You MUST return true for success, false for failure.
Writing nothing is always success, so by default you must return true.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2020-06-20 19:55:17 +00:00
< h5 > handler: < span class = "tsd-signature-symbol" > (< / span > offset< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > => < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 >
2019-02-13 03:13:35 +00:00
< ul class = "tsd-parameters" >
2020-06-20 19:55:17 +00:00
< li class = "tsd-parameter-signature" >
< ul class = "tsd-signatures tsd-kind-type-literal" >
2019-03-10 11:52:42 +00:00
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > offset< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2019-03-10 11:52:42 +00:00
< h5 > offset: < span class = "tsd-signature-type" > number< / span > < / h5 >
2019-02-13 03:13:35 +00:00
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > boolean< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
2021-08-16 00:34:38 +00:00
< h4 class = "tsd-returns-title" > Returns < a href = "HttpResponse.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > HttpResponse< / a > < / h4 >
2019-02-10 22:06:30 +00:00
< / li >
< / ul >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a name = "tryEnd" class = "tsd-anchor" > < / a >
2019-02-10 22:06:30 +00:00
< h3 > try< wbr > End< / h3 >
2019-12-21 19:46:31 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< li class = "tsd-signature tsd-kind-icon" > try< wbr > End< span class = "tsd-signature-symbol" > (< / span > fullBodyOrChunk< span class = "tsd-signature-symbol" > : < / span > < a href = "../index.html#RecognizedString" class = "tsd-signature-type" data-tsd-kind = "Type alias" > RecognizedString< / a > , totalSize< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-symbol" > [< / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > , < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ]< / span > < / li >
2019-02-10 22:06:30 +00:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2021-08-16 00:34:38 +00:00
< li > Defined in < a href = "https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L151" > index.d.ts:151< / a > < / li >
2019-02-10 22:06:30 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Ends this response, or tries to, by streaming appropriately sized chunks of body. Use in conjunction with onWritable. Returns tuple [ok, hasResponded].< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2021-08-16 00:34:38 +00:00
< h5 > fullBodyOrChunk: < a href = "../index.html#RecognizedString" class = "tsd-signature-type" data-tsd-kind = "Type alias" > RecognizedString< / a > < / h5 >
2019-02-10 22:06:30 +00:00
< / li >
< li >
< h5 > totalSize: < span class = "tsd-signature-type" > number< / span > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-symbol" > [< / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > , < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ]< / span > < / h4 >
< / li >
< / ul >
< / section >
2020-06-08 12:29:54 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter" >
< a name = "upgrade" class = "tsd-anchor" > < / a >
< h3 > upgrade< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter" >
2021-08-16 00:34:38 +00:00
< li class = "tsd-signature tsd-kind-icon" > upgrade< T> < span class = "tsd-signature-symbol" > (< / span > userData< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > T< / span > , secWebSocketKey< span class = "tsd-signature-symbol" > : < / span > < a href = "../index.html#RecognizedString" class = "tsd-signature-type" data-tsd-kind = "Type alias" > RecognizedString< / a > , secWebSocketProtocol< span class = "tsd-signature-symbol" > : < / span > < a href = "../index.html#RecognizedString" class = "tsd-signature-type" data-tsd-kind = "Type alias" > RecognizedString< / a > , secWebSocketExtensions< span class = "tsd-signature-symbol" > : < / span > < a href = "../index.html#RecognizedString" class = "tsd-signature-type" data-tsd-kind = "Type alias" > RecognizedString< / a > , context< span class = "tsd-signature-symbol" > : < / span > < a href = "us_socket_context_t.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > us_socket_context_t< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > void< / span > < / li >
2020-06-08 12:29:54 +00:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2021-08-16 00:34:38 +00:00
< li > Defined in < a href = "https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L202" > index.d.ts:202< / a > < / li >
2020-06-08 12:29:54 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Upgrades a HttpResponse to a WebSocket. See UpgradeAsync, UpgradeSync example files.< / p >
< / div >
< / div >
< h4 class = "tsd-type-parameters-title" > Type parameters< / h4 >
< ul class = "tsd-type-parameters" >
< li >
< h4 > T< / h4 >
< / li >
< / ul >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > userData: < span class = "tsd-signature-type" > T< / span > < / h5 >
< / li >
< li >
2021-08-16 00:34:38 +00:00
< h5 > secWebSocketKey: < a href = "../index.html#RecognizedString" class = "tsd-signature-type" data-tsd-kind = "Type alias" > RecognizedString< / a > < / h5 >
2020-06-08 12:29:54 +00:00
< / li >
< li >
2021-08-16 00:34:38 +00:00
< h5 > secWebSocketProtocol: < a href = "../index.html#RecognizedString" class = "tsd-signature-type" data-tsd-kind = "Type alias" > RecognizedString< / a > < / h5 >
2020-06-08 12:29:54 +00:00
< / li >
< li >
2021-08-16 00:34:38 +00:00
< h5 > secWebSocketExtensions: < a href = "../index.html#RecognizedString" class = "tsd-signature-type" data-tsd-kind = "Type alias" > RecognizedString< / a > < / h5 >
2020-06-08 12:29:54 +00:00
< / li >
< li >
2021-08-16 00:34:38 +00:00
< h5 > context: < a href = "us_socket_context_t.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > us_socket_context_t< / a > < / h5 >
2020-06-08 12:29:54 +00:00
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 >
< / li >
< / ul >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
2019-02-13 03:13:35 +00:00
< a name = "write" class = "tsd-anchor" > < / a >
< h3 > write< / h3 >
2019-12-21 19:46:31 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< li class = "tsd-signature tsd-kind-icon" > write< span class = "tsd-signature-symbol" > (< / span > chunk< span class = "tsd-signature-symbol" > : < / span > < a href = "../index.html#RecognizedString" class = "tsd-signature-type" data-tsd-kind = "Type alias" > RecognizedString< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "HttpResponse.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > HttpResponse< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2021-08-16 00:34:38 +00:00
< li > Defined in < a href = "https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L147" > index.d.ts:147< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Enters or continues chunked encoding mode. Writes part of the response. End with zero length write.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2021-08-16 00:34:38 +00:00
< h5 > chunk: < a href = "../index.html#RecognizedString" class = "tsd-signature-type" data-tsd-kind = "Type alias" > RecognizedString< / a > < / h5 >
2019-02-13 03:13:35 +00:00
< / li >
< / ul >
2021-08-16 00:34:38 +00:00
< h4 class = "tsd-returns-title" > Returns < a href = "HttpResponse.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > HttpResponse< / a > < / h4 >
2019-02-13 03:13:35 +00:00
< / li >
< / ul >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a name = "writeHeader" class = "tsd-anchor" > < / a >
2019-02-10 22:06:30 +00:00
< h3 > write< wbr > Header< / h3 >
2019-12-21 19:46:31 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< li class = "tsd-signature tsd-kind-icon" > write< wbr > Header< span class = "tsd-signature-symbol" > (< / span > key< span class = "tsd-signature-symbol" > : < / span > < a href = "../index.html#RecognizedString" class = "tsd-signature-type" data-tsd-kind = "Type alias" > RecognizedString< / a > , value< span class = "tsd-signature-symbol" > : < / span > < a href = "../index.html#RecognizedString" class = "tsd-signature-type" data-tsd-kind = "Type alias" > RecognizedString< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "HttpResponse.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > HttpResponse< / a > < / li >
2019-02-10 22:06:30 +00:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2021-08-16 00:34:38 +00:00
< li > Defined in < a href = "https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L145" > index.d.ts:145< / a > < / li >
2019-02-10 22:06:30 +00:00
< / ul >
< / aside >
2019-02-13 03:13:35 +00:00
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
2020-06-20 19:55:17 +00:00
< p > Writes key and value to HTTP response.
See writeStatus and corking.< / p >
2019-02-13 03:13:35 +00:00
< / div >
< / div >
2019-02-10 22:06:30 +00:00
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2021-08-16 00:34:38 +00:00
< h5 > key: < a href = "../index.html#RecognizedString" class = "tsd-signature-type" data-tsd-kind = "Type alias" > RecognizedString< / a > < / h5 >
2019-02-13 03:13:35 +00:00
< / li >
< li >
2021-08-16 00:34:38 +00:00
< h5 > value: < a href = "../index.html#RecognizedString" class = "tsd-signature-type" data-tsd-kind = "Type alias" > RecognizedString< / a > < / h5 >
2019-02-10 22:06:30 +00:00
< / li >
2019-02-13 03:13:35 +00:00
< / ul >
2021-08-16 00:34:38 +00:00
< h4 class = "tsd-returns-title" > Returns < a href = "HttpResponse.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > HttpResponse< / a > < / h4 >
2019-02-13 03:13:35 +00:00
< / li >
< / ul >
< / section >
2019-12-21 19:46:31 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a name = "writeStatus" class = "tsd-anchor" > < / a >
2019-02-13 03:13:35 +00:00
< h3 > write< wbr > Status< / h3 >
2019-12-21 19:46:31 +00:00
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< li class = "tsd-signature tsd-kind-icon" > write< wbr > Status< span class = "tsd-signature-symbol" > (< / span > status< span class = "tsd-signature-symbol" > : < / span > < a href = "../index.html#RecognizedString" class = "tsd-signature-type" data-tsd-kind = "Type alias" > RecognizedString< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "HttpResponse.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > HttpResponse< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2021-08-16 00:34:38 +00:00
< li > Defined in < a href = "https://github.com/e3dio/uWebSockets.js/blob/master/docs/index.d.ts#L141" > index.d.ts:141< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
2020-06-20 19:55:17 +00:00
< p > Writes the HTTP status message such as " 200 OK" .
This has to be called first in any response, otherwise
it will be called automatically with " 200 OK" .< / p >
2019-02-13 03:13:35 +00:00
< / div >
2020-06-20 19:55:17 +00:00
< p > If you want to send custom headers in a WebSocket
upgrade response, you have to call writeStatus with
" 101 Switching Protocols" before you call writeHeader,
otherwise your first call to writeHeader will call
writeStatus with " 200 OK" and the upgrade will fail.< / p >
< p > As you can imagine, we format outgoing responses in a linear
buffer, not in a hash table. You can read about this in
the user manual under " corking" .< / p >
2019-02-13 03:13:35 +00:00
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
2019-02-10 22:06:30 +00:00
< li >
2021-08-16 00:34:38 +00:00
< h5 > status: < a href = "../index.html#RecognizedString" class = "tsd-signature-type" data-tsd-kind = "Type alias" > RecognizedString< / a > < / h5 >
2019-02-10 22:06:30 +00:00
< / li >
< / ul >
2021-08-16 00:34:38 +00:00
< h4 class = "tsd-returns-title" > Returns < a href = "HttpResponse.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > HttpResponse< / a > < / h4 >
2019-02-10 22:06:30 +00:00
< / li >
< / ul >
< / section >
< / section >
< / div >
< div class = "col-4 col-menu menu-sticky-wrap menu-highlight" >
< nav class = "tsd-navigation primary" >
< ul >
2021-08-16 00:34:38 +00:00
< li class = " " >
< a href = "../index.html" > Exports< / a >
2019-02-10 22:06:30 +00:00
< / li >
< / ul >
< / nav >
< nav class = "tsd-navigation secondary menu-sticky" >
< ul class = "before-current" >
2021-04-10 21:44:05 +00:00
< li class = " tsd-kind-enum" >
2021-08-16 00:34:38 +00:00
< a href = "../enums/ListenOptions.html" class = "tsd-kind-icon" > Listen< wbr > Options< / a >
2021-04-10 21:44:05 +00:00
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-interface" >
2021-08-16 00:34:38 +00:00
< a href = "AppOptions.html" class = "tsd-kind-icon" > App< wbr > Options< / a >
2019-02-10 22:06:30 +00:00
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-interface" >
2021-08-16 00:34:38 +00:00
< a href = "HttpRequest.html" class = "tsd-kind-icon" > Http< wbr > Request< / a >
2019-02-10 22:06:30 +00:00
< / li >
< / ul >
< ul class = "current" >
2019-12-21 19:46:31 +00:00
< li class = "current tsd-kind-interface" >
2021-08-16 00:34:38 +00:00
< a href = "HttpResponse.html" class = "tsd-kind-icon" > Http< wbr > Response< / a >
2019-02-10 22:06:30 +00:00
< ul >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a href = "HttpResponse.html#close" class = "tsd-kind-icon" > close< / a >
2019-02-13 03:13:35 +00:00
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a href = "HttpResponse.html#cork" class = "tsd-kind-icon" > cork< / a >
2019-12-21 19:46:31 +00:00
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a href = "HttpResponse.html#end" class = "tsd-kind-icon" > end< / a >
2019-02-10 22:06:30 +00:00
< / li >
2020-06-08 12:29:54 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a href = "HttpResponse.html#getProxiedRemoteAddress" class = "tsd-kind-icon" > get< wbr > Proxied< wbr > Remote< wbr > Address< / a >
2020-06-08 12:29:54 +00:00
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a href = "HttpResponse.html#getProxiedRemoteAddressAsText" class = "tsd-kind-icon" > get< wbr > Proxied< wbr > Remote< wbr > Address< wbr > AsText< / a >
2020-06-08 12:29:54 +00:00
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a href = "HttpResponse.html#getRemoteAddress" class = "tsd-kind-icon" > get< wbr > Remote< wbr > Address< / a >
2019-03-03 07:15:48 +00:00
< / li >
2020-06-08 12:29:54 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a href = "HttpResponse.html#getRemoteAddressAsText" class = "tsd-kind-icon" > get< wbr > Remote< wbr > Address< wbr > AsText< / a >
2020-06-08 12:29:54 +00:00
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a href = "HttpResponse.html#getWriteOffset" class = "tsd-kind-icon" > get< wbr > Write< wbr > Offset< / a >
2019-02-13 03:13:35 +00:00
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a href = "HttpResponse.html#onAborted" class = "tsd-kind-icon" > on< wbr > Aborted< / a >
2019-02-13 03:13:35 +00:00
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a href = "HttpResponse.html#onData" class = "tsd-kind-icon" > on< wbr > Data< / a >
2019-02-13 03:13:35 +00:00
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a href = "HttpResponse.html#onWritable" class = "tsd-kind-icon" > on< wbr > Writable< / a >
2019-02-13 03:13:35 +00:00
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a href = "HttpResponse.html#tryEnd" class = "tsd-kind-icon" > try< wbr > End< / a >
2019-02-10 22:06:30 +00:00
< / li >
2020-06-08 12:29:54 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter" >
2021-08-16 00:34:38 +00:00
< a href = "HttpResponse.html#upgrade" class = "tsd-kind-icon" > upgrade< / a >
2020-06-08 12:29:54 +00:00
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a href = "HttpResponse.html#write" class = "tsd-kind-icon" > write< / a >
2019-02-13 03:13:35 +00:00
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a href = "HttpResponse.html#writeHeader" class = "tsd-kind-icon" > write< wbr > Header< / a >
2019-02-10 22:06:30 +00:00
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface" >
2021-08-16 00:34:38 +00:00
< a href = "HttpResponse.html#writeStatus" class = "tsd-kind-icon" > write< wbr > Status< / a >
2019-02-13 03:13:35 +00:00
< / li >
2019-02-10 22:06:30 +00:00
< / ul >
< / li >
< / ul >
< ul class = "after-current" >
2021-04-10 21:44:05 +00:00
< li class = " tsd-kind-interface" >
2021-08-16 00:34:38 +00:00
< a href = "MultipartField.html" class = "tsd-kind-icon" > Multipart< wbr > Field< / a >
2021-04-10 21:44:05 +00:00
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-interface" >
2021-08-16 00:34:38 +00:00
< a href = "TemplatedApp.html" class = "tsd-kind-icon" > Templated< wbr > App< / a >
2019-02-10 22:06:30 +00:00
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-interface" >
2021-08-16 00:34:38 +00:00
< a href = "WebSocket.html" class = "tsd-kind-icon" > Web< wbr > Socket< / a >
2019-02-13 03:13:35 +00:00
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-interface" >
2021-08-16 00:34:38 +00:00
< a href = "WebSocketBehavior.html" class = "tsd-kind-icon" > Web< wbr > Socket< wbr > Behavior< / a >
2019-02-13 03:13:35 +00:00
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-interface" >
2019-02-10 22:06:30 +00:00
< a href = "us_listen_socket.html" class = "tsd-kind-icon" > us_< wbr > listen_< wbr > socket< / a >
< / li >
2021-08-16 00:34:38 +00:00
< li class = " tsd-kind-interface" >
< a href = "us_socket.html" class = "tsd-kind-icon" > us_< wbr > socket< / a >
< / li >
2020-06-08 12:29:54 +00:00
< li class = " tsd-kind-interface" >
< a href = "us_socket_context_t.html" class = "tsd-kind-icon" > us_< wbr > socket_< wbr > context_< wbr > t< / a >
< / li >
2019-11-18 18:37:30 +00:00
< li class = " tsd-kind-type-alias" >
2021-08-16 00:34:38 +00:00
< a href = "../index.html#CompressOptions" class = "tsd-kind-icon" > Compress< wbr > Options< / a >
2019-11-18 18:37:30 +00:00
< / li >
2019-12-21 19:46:31 +00:00
< li class = " tsd-kind-type-alias" >
2021-08-16 00:34:38 +00:00
< a href = "../index.html#RecognizedString" class = "tsd-kind-icon" > Recognized< wbr > String< / a >
2019-03-03 07:15:48 +00:00
< / li >
2020-03-01 00:26:30 +00:00
< li class = " tsd-kind-variable" >
2021-08-16 00:34:38 +00:00
< a href = "../index.html#DEDICATED_COMPRESSOR_128KB" class = "tsd-kind-icon" > DEDICATED_< wbr > COMPRESSOR_< wbr > 128KB< / a >
2020-03-01 00:26:30 +00:00
< / li >
< li class = " tsd-kind-variable" >
2021-08-16 00:34:38 +00:00
< a href = "../index.html#DEDICATED_COMPRESSOR_16KB" class = "tsd-kind-icon" > DEDICATED_< wbr > COMPRESSOR_< wbr > 16KB< / a >
2020-03-01 00:26:30 +00:00
< / li >
< li class = " tsd-kind-variable" >
2021-08-16 00:34:38 +00:00
< a href = "../index.html#DEDICATED_COMPRESSOR_256KB" class = "tsd-kind-icon" > DEDICATED_< wbr > COMPRESSOR_< wbr > 256KB< / a >
2020-03-01 00:26:30 +00:00
< / li >
< li class = " tsd-kind-variable" >
2021-08-16 00:34:38 +00:00
< a href = "../index.html#DEDICATED_COMPRESSOR_32KB" class = "tsd-kind-icon" > DEDICATED_< wbr > COMPRESSOR_< wbr > 32KB< / a >
2020-03-01 00:26:30 +00:00
< / li >
< li class = " tsd-kind-variable" >
2021-08-16 00:34:38 +00:00
< a href = "../index.html#DEDICATED_COMPRESSOR_3KB" class = "tsd-kind-icon" > DEDICATED_< wbr > COMPRESSOR_< wbr > 3KB< / a >
2020-03-01 00:26:30 +00:00
< / li >
< li class = " tsd-kind-variable" >
2021-08-16 00:34:38 +00:00
< a href = "../index.html#DEDICATED_COMPRESSOR_4KB" class = "tsd-kind-icon" > DEDICATED_< wbr > COMPRESSOR_< wbr > 4KB< / a >
2020-03-01 00:26:30 +00:00
< / li >
< li class = " tsd-kind-variable" >
2021-08-16 00:34:38 +00:00
< a href = "../index.html#DEDICATED_COMPRESSOR_64KB" class = "tsd-kind-icon" > DEDICATED_< wbr > COMPRESSOR_< wbr > 64KB< / a >
2020-03-01 00:26:30 +00:00
< / li >
< li class = " tsd-kind-variable" >
2021-08-16 00:34:38 +00:00
< a href = "../index.html#DEDICATED_COMPRESSOR_8KB" class = "tsd-kind-icon" > DEDICATED_< wbr > COMPRESSOR_< wbr > 8KB< / a >
2020-03-01 00:26:30 +00:00
< / li >
2019-11-18 18:37:30 +00:00
< li class = " tsd-kind-variable" >
2021-08-16 00:34:38 +00:00
< a href = "../index.html#DISABLED" class = "tsd-kind-icon" > DISABLED< / a >
2019-11-18 18:37:30 +00:00
< / li >
< li class = " tsd-kind-variable" >
2021-08-16 00:34:38 +00:00
< a href = "../index.html#SHARED_COMPRESSOR" class = "tsd-kind-icon" > SHARED_< wbr > COMPRESSOR< / a >
2019-11-18 18:37:30 +00:00
< / li >
2019-02-10 22:06:30 +00:00
< li class = " tsd-kind-function" >
2021-08-16 00:34:38 +00:00
< a href = "../index.html#App" class = "tsd-kind-icon" > App< / a >
2019-02-10 22:06:30 +00:00
< / li >
< li class = " tsd-kind-function" >
2021-08-16 00:34:38 +00:00
< a href = "../index.html#SSLApp" class = "tsd-kind-icon" > SSLApp< / a >
2019-02-10 22:06:30 +00:00
< / li >
2021-04-10 21:44:05 +00:00
< li class = " tsd-kind-function" >
2021-08-16 00:34:38 +00:00
< a href = "../index.html#getParts" class = "tsd-kind-icon" > get< wbr > Parts< / a >
2021-04-10 21:44:05 +00:00
< / li >
2019-02-13 03:13:35 +00:00
< li class = " tsd-kind-function" >
< a href = "../index.html#us_listen_socket_close" class = "tsd-kind-icon" > us_< wbr > listen_< wbr > socket_< wbr > close< / a >
< / li >
2021-08-16 00:34:38 +00:00
< li class = " tsd-kind-function" >
< a href = "../index.html#us_socket_local_port" class = "tsd-kind-icon" > us_< wbr > socket_< wbr > local_< wbr > port< / a >
< / li >
2019-02-10 22:06:30 +00:00
< / ul >
< / nav >
< / div >
< / div >
< / div >
< footer class = "with-border-bottom" >
< div class = "container" >
< h2 > Legend< / h2 >
< div class = "tsd-legend-group" >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< / ul >
< / div >
< / div >
< / footer >
< div class = "container tsd-generator" >
2020-06-20 19:55:17 +00:00
< p > Generated using < a href = "https://typedoc.org/" target = "_blank" > TypeDoc< / a > < / p >
2019-02-10 22:06:30 +00:00
< / div >
< div class = "overlay" > < / div >
< script src = "../assets/js/main.js" > < / script >
< / body >
< / html >
