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" >
2019-03-03 07:15:48 +00:00
< title > HttpResponse | uWebSockets.js v15.6.0 documentation< / title >
2019-02-10 22:06:30 +00:00
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< link rel = "stylesheet" href = "../assets/css/main.css" >
< / head >
< body >
< header >
< div class = "tsd-page-toolbar" >
< div class = "container" >
< div class = "table-wrap" >
< div class = "table-cell" id = "tsd-search" data-index = "../assets/js/search.js" data-base = ".." >
< 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 >
2019-03-03 07:15:48 +00:00
< a href = "../index.html" class = "title" > uWebSockets.js v15.6.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 >
< input type = "checkbox" id = "tsd-filter-only-exported" / >
< label class = "tsd-widget" for = "tsd-filter-only-exported" > Only exported< / 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 >
< a href = "../index.html" > Globals< / a >
< / li >
< li >
< a href = "httpresponse.html" > HttpResponse< / a >
< / 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 >
< section class = "tsd-panel-group tsd-index-group" >
< h2 > Index< / h2 >
< section class = "tsd-panel tsd-index-panel" >
< div class = "tsd-index-content" >
< section class = "tsd-index-section tsd-is-not-exported" >
< h3 > Methods< / h3 >
< ul class = "tsd-index-list" >
2019-02-13 03:13:35 +00:00
< li class = "tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" > < a href = "httpresponse.html#close" class = "tsd-kind-icon" > close< / a > < / li >
2019-02-10 22:06:30 +00:00
< li class = "tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" > < a href = "httpresponse.html#end" class = "tsd-kind-icon" > end< / a > < / li >
2019-03-03 07:15:48 +00:00
< li class = "tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" > < a href = "httpresponse.html#getremoteaddress" class = "tsd-kind-icon" > get< wbr > Remote< wbr > Address< / a > < / li >
2019-02-13 03:13:35 +00:00
< li class = "tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" > < 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 tsd-is-not-exported" > < a href = "httpresponse.html#onaborted" class = "tsd-kind-icon" > on< wbr > Aborted< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" > < a href = "httpresponse.html#ondata" class = "tsd-kind-icon" > on< wbr > Data< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" > < a href = "httpresponse.html#onwritable" class = "tsd-kind-icon" > on< wbr > Writable< / a > < / li >
2019-02-10 22:06:30 +00:00
< li class = "tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" > < a href = "httpresponse.html#tryend" class = "tsd-kind-icon" > try< wbr > End< / a > < / li >
2019-02-13 03:13:35 +00:00
< li class = "tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" > < a href = "httpresponse.html#write" class = "tsd-kind-icon" > write< / a > < / li >
2019-02-10 22:06:30 +00:00
< li class = "tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" > < a href = "httpresponse.html#writeheader" class = "tsd-kind-icon" > write< wbr > Header< / a > < / li >
2019-02-13 03:13:35 +00:00
< li class = "tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" > < 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 >
< section class = "tsd-panel-group tsd-member-group tsd-is-not-exported" >
< h2 > Methods< / h2 >
2019-02-13 03:13:35 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< a name = "close" class = "tsd-anchor" > < / a >
< h3 > close< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< 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" > HttpResponse< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2019-03-03 07:15:48 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L52" > index.d.ts:52< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Immediately force closes the connection.< / p >
< / div >
< / div >
< h4 class = "tsd-returns-title" > Returns < a href = "httpresponse.html" class = "tsd-signature-type" > HttpResponse< / a > < / h4 >
< / li >
< / ul >
< / section >
2019-02-10 22:06:30 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< a name = "end" class = "tsd-anchor" > < / a >
< h3 > end< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
2019-03-03 07:15:48 +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" > RecognizedString< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "httpresponse.html" class = "tsd-signature-type" > 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 >
2019-03-03 07:15:48 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L47" > index.d.ts:47< / 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 >
2019-03-03 07:15:48 +00:00
< h5 > body: < a href = "../index.html#recognizedstring" class = "tsd-signature-type" > RecognizedString< / a > < / h5 >
2019-02-10 22:06:30 +00:00
< / li >
< / ul >
2019-02-13 03:13:35 +00:00
< h4 class = "tsd-returns-title" > Returns < a href = "httpresponse.html" class = "tsd-signature-type" > HttpResponse< / a > < / h4 >
< / li >
< / ul >
< / section >
2019-03-03 07:15:48 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< a name = "getremoteaddress" class = "tsd-anchor" > < / a >
< h3 > get< wbr > Remote< wbr > Address< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< 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 >
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L73" > index.d.ts:73< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Returns the remote IP address< / p >
< / div >
< / div >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > ArrayBuffer< / span > < / h4 >
< / li >
< / ul >
< / section >
2019-02-13 03:13:35 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< a name = "getwriteoffset" class = "tsd-anchor" > < / a >
< h3 > get< wbr > Write< wbr > Offset< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< 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 >
2019-03-03 07:15:48 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L55" > index.d.ts:55< / 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 >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< a name = "onaborted" class = "tsd-anchor" > < / a >
< h3 > on< wbr > Aborted< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< 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-type" > function< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "httpresponse.html" class = "tsd-signature-type" > HttpResponse< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2019-03-03 07:15:48 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L67" > index.d.ts:67< / 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 >
< h5 > handler: < span class = "tsd-signature-type" > function< / span > < / h5 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter-siganture" >
< ul class = "tsd-signatures tsd-kind-type-literal tsd-is-not-exported" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > res< span class = "tsd-signature-symbol" > : < / span > < a href = "httpresponse.html" class = "tsd-signature-type" > HttpResponse< / a > < 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-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > res: < a href = "httpresponse.html" class = "tsd-signature-type" > HttpResponse< / a > < / h5 >
< / li >
< / ul >
< 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 < a href = "httpresponse.html" class = "tsd-signature-type" > HttpResponse< / a > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< a name = "ondata" class = "tsd-anchor" > < / a >
< h3 > on< wbr > Data< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< 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-type" > function< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "httpresponse.html" class = "tsd-signature-type" > HttpResponse< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2019-03-03 07:15:48 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L70" > index.d.ts:70< / 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 >
< h5 > handler: < span class = "tsd-signature-type" > function< / span > < / h5 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter-siganture" >
< ul class = "tsd-signatures tsd-kind-type-literal tsd-is-not-exported" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > res< span class = "tsd-signature-symbol" > : < / span > < a href = "httpresponse.html" class = "tsd-signature-type" > HttpResponse< / a > , 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 >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > res: < a href = "httpresponse.html" class = "tsd-signature-type" > HttpResponse< / a > < / h5 >
< / li >
< 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 >
< h4 class = "tsd-returns-title" > Returns < a href = "httpresponse.html" class = "tsd-signature-type" > HttpResponse< / a > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< a name = "onwritable" class = "tsd-anchor" > < / a >
< h3 > on< wbr > Writable< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< 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-type" > function< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "httpresponse.html" class = "tsd-signature-type" > HttpResponse< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
2019-03-03 07:15:48 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L61" > index.d.ts:61< / 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 >
< h5 > handler: < span class = "tsd-signature-type" > function< / span > < / h5 >
< ul class = "tsd-parameters" >
< li class = "tsd-parameter-siganture" >
< ul class = "tsd-signatures tsd-kind-type-literal tsd-is-not-exported" >
< li class = "tsd-signature tsd-kind-icon" > < span class = "tsd-signature-symbol" > (< / span > res< span class = "tsd-signature-symbol" > : < / span > < a href = "httpresponse.html" class = "tsd-signature-type" > HttpResponse< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > boolean< / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > res: < a href = "httpresponse.html" class = "tsd-signature-type" > HttpResponse< / a > < / h5 >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > boolean< / span > < / h4 >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "httpresponse.html" class = "tsd-signature-type" > HttpResponse< / a > < / h4 >
2019-02-10 22:06:30 +00:00
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< a name = "tryend" class = "tsd-anchor" > < / a >
< h3 > try< wbr > End< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
2019-03-03 07:15:48 +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" > 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 >
2019-03-03 07:15:48 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L49" > index.d.ts:49< / 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 >
2019-03-03 07:15:48 +00:00
< h5 > fullBodyOrChunk: < a href = "../index.html#recognizedstring" class = "tsd-signature-type" > 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 >
2019-02-13 03:13:35 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< a name = "write" class = "tsd-anchor" > < / a >
< h3 > write< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
2019-03-03 07:15:48 +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" > RecognizedString< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "httpresponse.html" class = "tsd-signature-type" > 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 >
2019-03-03 07:15:48 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L45" > index.d.ts:45< / 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 >
2019-03-03 07:15:48 +00:00
< h5 > chunk: < a href = "../index.html#recognizedstring" class = "tsd-signature-type" > RecognizedString< / a > < / h5 >
2019-02-13 03:13:35 +00:00
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "httpresponse.html" class = "tsd-signature-type" > HttpResponse< / a > < / h4 >
< / li >
< / ul >
< / section >
2019-02-10 22:06:30 +00:00
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< a name = "writeheader" class = "tsd-anchor" > < / a >
< h3 > write< wbr > Header< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
2019-03-03 07:15:48 +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" > RecognizedString< / a > , value< span class = "tsd-signature-symbol" > : < / span > < a href = "../index.html#recognizedstring" class = "tsd-signature-type" > RecognizedString< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "httpresponse.html" class = "tsd-signature-type" > 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 >
2019-03-03 07:15:48 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L43" > index.d.ts:43< / 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" >
< p > Writes key and value to HTTP response.< / p >
< / div >
< / div >
2019-02-10 22:06:30 +00:00
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
2019-03-03 07:15:48 +00:00
< h5 > key: < a href = "../index.html#recognizedstring" class = "tsd-signature-type" > RecognizedString< / a > < / h5 >
2019-02-13 03:13:35 +00:00
< / li >
< li >
2019-03-03 07:15:48 +00:00
< h5 > value: < a href = "../index.html#recognizedstring" class = "tsd-signature-type" > RecognizedString< / a > < / h5 >
2019-02-10 22:06:30 +00:00
< / li >
2019-02-13 03:13:35 +00:00
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "httpresponse.html" class = "tsd-signature-type" > HttpResponse< / a > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< a name = "writestatus" class = "tsd-anchor" > < / a >
< h3 > write< wbr > Status< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
2019-03-03 07:15:48 +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" > RecognizedString< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "httpresponse.html" class = "tsd-signature-type" > 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 >
2019-03-03 07:15:48 +00:00
< li > Defined in < a href = "https://github.com/uNetworking/uWebSockets.js/blob/3ce5d37/docs/index.d.ts#L41" > index.d.ts:41< / a > < / li >
2019-02-13 03:13:35 +00:00
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Writes the HTTP status message such as " 200 OK" .< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
2019-02-10 22:06:30 +00:00
< li >
2019-03-03 07:15:48 +00:00
< h5 > status: < a href = "../index.html#recognizedstring" class = "tsd-signature-type" > RecognizedString< / a > < / h5 >
2019-02-10 22:06:30 +00:00
< / li >
< / ul >
2019-02-13 03:13:35 +00:00
< h4 class = "tsd-returns-title" > Returns < a href = "httpresponse.html" class = "tsd-signature-type" > 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 >
< li class = "globals " >
< a href = "../index.html" > < em > Globals< / em > < / a >
< / li >
< / ul >
< / nav >
< nav class = "tsd-navigation secondary menu-sticky" >
< ul class = "before-current" >
2019-02-21 19:03:43 +00:00
< li class = " tsd-kind-enum" >
< a href = "../enums/compressoptions.html" class = "tsd-kind-icon" > Compress< wbr > Options< / a >
< / li >
2019-02-10 22:06:30 +00:00
< li class = " tsd-kind-interface tsd-is-not-exported" >
< a href = "appoptions.html" class = "tsd-kind-icon" > App< wbr > Options< / a >
< / li >
< li class = " tsd-kind-interface tsd-is-not-exported" >
< a href = "httprequest.html" class = "tsd-kind-icon" > Http< wbr > Request< / a >
< / li >
< / ul >
< ul class = "current" >
< li class = "current tsd-kind-interface tsd-is-not-exported" >
< a href = "httpresponse.html" class = "tsd-kind-icon" > Http< wbr > Response< / a >
< ul >
2019-02-13 03:13:35 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< a href = "httpresponse.html#close" class = "tsd-kind-icon" > close< / a >
< / li >
2019-02-10 22:06:30 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< a href = "httpresponse.html#end" class = "tsd-kind-icon" > end< / a >
< / li >
2019-03-03 07:15:48 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< a href = "httpresponse.html#getremoteaddress" class = "tsd-kind-icon" > get< wbr > Remote< wbr > Address< / a >
< / li >
2019-02-13 03:13:35 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< 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 tsd-is-not-exported" >
< a href = "httpresponse.html#onaborted" class = "tsd-kind-icon" > on< wbr > Aborted< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< a href = "httpresponse.html#ondata" class = "tsd-kind-icon" > on< wbr > Data< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< a href = "httpresponse.html#onwritable" class = "tsd-kind-icon" > on< wbr > Writable< / a >
< / li >
2019-02-10 22:06:30 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< a href = "httpresponse.html#tryend" class = "tsd-kind-icon" > try< wbr > End< / a >
< / li >
2019-02-13 03:13:35 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< a href = "httpresponse.html#write" class = "tsd-kind-icon" > write< / a >
< / li >
2019-02-10 22:06:30 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< a href = "httpresponse.html#writeheader" class = "tsd-kind-icon" > write< wbr > Header< / a >
< / li >
2019-02-13 03:13:35 +00:00
< li class = " tsd-kind-method tsd-parent-kind-interface tsd-is-not-exported" >
< a href = "httpresponse.html#writestatus" class = "tsd-kind-icon" > write< wbr > Status< / a >
< / li >
2019-02-10 22:06:30 +00:00
< / ul >
< / li >
< / ul >
< ul class = "after-current" >
< li class = " tsd-kind-interface tsd-is-not-exported" >
< a href = "templatedapp.html" class = "tsd-kind-icon" > Templated< wbr > App< / a >
< / li >
2019-02-13 03:13:35 +00:00
< li class = " tsd-kind-interface tsd-is-not-exported" >
< a href = "websocket.html" class = "tsd-kind-icon" > Web< wbr > Socket< / a >
< / li >
< li class = " tsd-kind-interface tsd-is-not-exported" >
< a href = "websocketbehavior.html" class = "tsd-kind-icon" > Web< wbr > Socket< wbr > Behavior< / a >
< / li >
2019-02-10 22:06:30 +00:00
< li class = " tsd-kind-interface tsd-is-not-exported" >
< a href = "us_listen_socket.html" class = "tsd-kind-icon" > us_< wbr > listen_< wbr > socket< / a >
< / li >
2019-03-03 07:15:48 +00:00
< li class = " tsd-kind-type-alias tsd-is-not-exported" >
< a href = "../index.html#recognizedstring" class = "tsd-kind-icon" > Recognized< wbr > String< / a >
< / li >
2019-02-10 22:06:30 +00:00
< li class = " tsd-kind-function" >
< a href = "../index.html#app" class = "tsd-kind-icon" > App< / a >
< / li >
< li class = " tsd-kind-function" >
< a href = "../index.html#sslapp" class = "tsd-kind-icon" > SSLApp< / a >
< / 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 >
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-module" > < span class = "tsd-kind-icon" > Module< / span > < / li >
< li class = "tsd-kind-object-literal" > < span class = "tsd-kind-icon" > Object literal< / span > < / li >
< li class = "tsd-kind-variable" > < span class = "tsd-kind-icon" > Variable< / span > < / li >
< li class = "tsd-kind-function" > < span class = "tsd-kind-icon" > Function< / span > < / li >
< li class = "tsd-kind-function tsd-has-type-parameter" > < span class = "tsd-kind-icon" > Function with type parameter< / span > < / li >
< li class = "tsd-kind-index-signature" > < span class = "tsd-kind-icon" > Index signature< / span > < / li >
< li class = "tsd-kind-type-alias" > < span class = "tsd-kind-icon" > Type alias< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-enum" > < span class = "tsd-kind-icon" > Enumeration< / span > < / li >
< li class = "tsd-kind-enum-member" > < span class = "tsd-kind-icon" > Enumeration member< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-enum" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-enum" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-interface" > < span class = "tsd-kind-icon" > Interface< / span > < / li >
< li class = "tsd-kind-interface tsd-has-type-parameter" > < span class = "tsd-kind-icon" > Interface with type parameter< / span > < / li >
< li class = "tsd-kind-constructor tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Constructor< / span > < / li >
< 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 >
< li class = "tsd-kind-index-signature tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Index signature< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-class" > < span class = "tsd-kind-icon" > Class< / span > < / li >
< li class = "tsd-kind-class tsd-has-type-parameter" > < span class = "tsd-kind-icon" > Class with type parameter< / span > < / li >
< li class = "tsd-kind-constructor tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Constructor< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< li class = "tsd-kind-accessor tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Accessor< / span > < / li >
< li class = "tsd-kind-index-signature tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Index signature< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited constructor< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited method< / span > < / li >
< li class = "tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited accessor< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-protected" > < span class = "tsd-kind-icon" > Protected property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-protected" > < span class = "tsd-kind-icon" > Protected method< / span > < / li >
< li class = "tsd-kind-accessor tsd-parent-kind-class tsd-is-protected" > < span class = "tsd-kind-icon" > Protected accessor< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-private" > < span class = "tsd-kind-icon" > Private property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-private" > < span class = "tsd-kind-icon" > Private method< / span > < / li >
< li class = "tsd-kind-accessor tsd-parent-kind-class tsd-is-private" > < span class = "tsd-kind-icon" > Private accessor< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-static" > < span class = "tsd-kind-icon" > Static property< / span > < / li >
< li class = "tsd-kind-call-signature tsd-parent-kind-class tsd-is-static" > < span class = "tsd-kind-icon" > Static method< / span > < / li >
< / ul >
< / div >
< / div >
< / footer >
< div class = "container tsd-generator" >
< p > Generated using < a href = "http://typedoc.org/" target = "_blank" > TypeDoc< / a > < / p >
< / div >
< div class = "overlay" > < / div >
< script src = "../assets/js/main.js" > < / script >
< script > if ( location . protocol == 'file:' ) document . write ( '<script src="../assets/js/search.js"><' + '/script>' ) ; < / script >
< / body >
< / html >
