Search
Preparing search index...
The search index is not available
laf-http
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"http"
IResponse
Interface IResponse
Hierarchy
ServerResponse
IResponse
Implements
WritableStream
Index
Constructors
constructor
Properties
chunked
Encoding
connection
finished
headers
Sent
send
Date
should
Keep
Alive
status
Code
status
Message
upgrading
use
Chunked
Encoding
ByDefault
writable
default
Max
Listeners
Methods
_destroy
_final
_write
_writev
add
Listener
add
Trailers
assign
Socket
cork
destroy
detach
Socket
emit
end
event
Names
flush
Headers
get
Header
get
Header
Names
get
Headers
get
Max
Listeners
has
Header
listener
Count
listeners
on
once
pipe
prepend
Listener
prepend
Once
Listener
remove
All
Listeners
remove
Header
remove
Listener
return
set
Default
Encoding
set
Header
set
Max
Listeners
set
Timeout
uncork
write
write
Continue
write
Head
listener
Count
Constructors
constructor
new IResponse
(
req
:
IncomingMessage
)
:
IResponse
Parameters
req:
IncomingMessage
Returns
IResponse
Properties
chunked
Encoding
chunked
Encoding
:
boolean
connection
connection
:
Socket
finished
finished
:
boolean
headers
Sent
headers
Sent
:
boolean
send
Date
send
Date
:
boolean
should
Keep
Alive
should
Keep
Alive
:
boolean
status
Code
status
Code
:
number
status
Message
status
Message
:
string
upgrading
upgrading
:
boolean
use
Chunked
Encoding
ByDefault
use
Chunked
Encoding
ByDefault
:
boolean
writable
writable
:
boolean
Static
default
Max
Listeners
default
Max
Listeners
:
number
Methods
_destroy
_destroy
(
err
:
Error
, callback
:
Function
)
:
void
Parameters
err:
Error
callback:
Function
Returns
void
_final
_final
(
callback
:
Function
)
:
void
Parameters
callback:
Function
Returns
void
_write
_write
(
chunk
:
any
, encoding
:
string
, callback
:
function
)
:
void
Parameters
chunk:
any
encoding:
string
callback:
function
(
err
?:
Error
)
:
void
Parameters
Optional
err:
Error
Returns
void
Returns
void
Optional
_writev
_writev
(
chunks
:
Array
<
object
>
, callback
:
function
)
:
void
Parameters
chunks:
Array
<
object
>
callback:
function
(
err
?:
Error
)
:
void
Parameters
Optional
err:
Error
Returns
void
Returns
void
add
Listener
add
Listener
(
event
:
string
, listener
:
function
)
:
this
add
Listener
(
event
:
"close"
, listener
:
function
)
:
this
add
Listener
(
event
:
"drain"
, listener
:
function
)
:
this
add
Listener
(
event
:
"error"
, listener
:
function
)
:
this
add
Listener
(
event
:
"finish"
, listener
:
function
)
:
this
add
Listener
(
event
:
"pipe"
, listener
:
function
)
:
this
add
Listener
(
event
:
"unpipe"
, listener
:
function
)
:
this
Event emitter The defined events on documents including:
close
drain
error
finish
pipe
unpipe
Parameters
event:
string
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"drain"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Returns
this
Parameters
event:
"finish"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"pipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
Returns
this
Parameters
event:
"unpipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
Returns
this
add
Trailers
add
Trailers
(
headers
:
OutgoingHttpHeaders
|
Array
<
[
string
,
string
]
>
)
:
void
Parameters
headers:
OutgoingHttpHeaders
|
Array
<
[
string
,
string
]
>
Returns
void
assign
Socket
assign
Socket
(
socket
:
Socket
)
:
void
Parameters
socket:
Socket
Returns
void
cork
cork
(
)
:
void
Returns
void
destroy
destroy
(
error
:
Error
)
:
void
Parameters
error:
Error
Returns
void
detach
Socket
detach
Socket
(
socket
:
Socket
)
:
void
Parameters
socket:
Socket
Returns
void
emit
emit
(
event
:
string
|
symbol
,
...
args
:
any
[]
)
:
boolean
emit
(
event
:
"close"
)
:
boolean
emit
(
event
:
"drain"
, chunk
:
Buffer
|
string
)
:
boolean
emit
(
event
:
"error"
, err
:
Error
)
:
boolean
emit
(
event
:
"finish"
)
:
boolean
emit
(
event
:
"pipe"
, src
:
Readable
)
:
boolean
emit
(
event
:
"unpipe"
, src
:
Readable
)
:
boolean
Parameters
event:
string
|
symbol
Rest
...
args:
any
[]
Returns
boolean
Parameters
event:
"close"
Returns
boolean
Parameters
event:
"drain"
chunk:
Buffer
|
string
Returns
boolean
Parameters
event:
"error"
err:
Error
Returns
boolean
Parameters
event:
"finish"
Returns
boolean
Parameters
event:
"pipe"
src:
Readable
Returns
boolean
Parameters
event:
"unpipe"
src:
Readable
Returns
boolean
end
end
(
cb
?:
Function
)
:
void
end
(
chunk
:
any
, cb
?:
Function
)
:
void
end
(
chunk
:
any
, encoding
?:
string
, cb
?:
Function
)
:
void
Parameters
Optional
cb:
Function
Returns
void
Parameters
chunk:
any
Optional
cb:
Function
Returns
void
Parameters
chunk:
any
Optional
encoding:
string
Optional
cb:
Function
Returns
void
event
Names
event
Names
(
)
:
Array
<
string
|
symbol
>
Returns
Array
<
string
|
symbol
>
flush
Headers
flush
Headers
(
)
:
void
Returns
void
get
Header
get
Header
(
name
:
string
)
:
number
|
string
|
string
[]
|
undefined
Parameters
name:
string
Returns
number
|
string
|
string
[]
|
undefined
get
Header
Names
get
Header
Names
(
)
:
string
[]
Returns
string
[]
get
Headers
get
Headers
(
)
:
OutgoingHttpHeaders
Returns
OutgoingHttpHeaders
get
Max
Listeners
get
Max
Listeners
(
)
:
number
Returns
number
has
Header
has
Header
(
name
:
string
)
:
boolean
Parameters
name:
string
Returns
boolean
listener
Count
listener
Count
(
type
:
string
|
symbol
)
:
number
Parameters
type:
string
|
symbol
Returns
number
listeners
listeners
(
event
:
string
|
symbol
)
:
Function
[]
Parameters
event:
string
|
symbol
Returns
Function
[]
on
on
(
event
:
string
, listener
:
function
)
:
this
on
(
event
:
"close"
, listener
:
function
)
:
this
on
(
event
:
"drain"
, listener
:
function
)
:
this
on
(
event
:
"error"
, listener
:
function
)
:
this
on
(
event
:
"finish"
, listener
:
function
)
:
this
on
(
event
:
"pipe"
, listener
:
function
)
:
this
on
(
event
:
"unpipe"
, listener
:
function
)
:
this
Parameters
event:
string
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"drain"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Returns
this
Parameters
event:
"finish"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"pipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
Returns
this
Parameters
event:
"unpipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
Returns
this
once
once
(
event
:
string
, listener
:
function
)
:
this
once
(
event
:
"close"
, listener
:
function
)
:
this
once
(
event
:
"drain"
, listener
:
function
)
:
this
once
(
event
:
"error"
, listener
:
function
)
:
this
once
(
event
:
"finish"
, listener
:
function
)
:
this
once
(
event
:
"pipe"
, listener
:
function
)
:
this
once
(
event
:
"unpipe"
, listener
:
function
)
:
this
Parameters
event:
string
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"drain"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Returns
this
Parameters
event:
"finish"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"pipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
Returns
this
Parameters
event:
"unpipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
Returns
this
pipe
pipe<T>
(
destination
:
T
, options
?:
object
)
:
T
Type parameters
T
:
WritableStream
Parameters
destination:
T
Optional
options:
object
Optional
end
?:
boolean
Returns
T
prepend
Listener
prepend
Listener
(
event
:
string
, listener
:
function
)
:
this
prepend
Listener
(
event
:
"close"
, listener
:
function
)
:
this
prepend
Listener
(
event
:
"drain"
, listener
:
function
)
:
this
prepend
Listener
(
event
:
"error"
, listener
:
function
)
:
this
prepend
Listener
(
event
:
"finish"
, listener
:
function
)
:
this
prepend
Listener
(
event
:
"pipe"
, listener
:
function
)
:
this
prepend
Listener
(
event
:
"unpipe"
, listener
:
function
)
:
this
Parameters
event:
string
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"drain"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Returns
this
Parameters
event:
"finish"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"pipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
Returns
this
Parameters
event:
"unpipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
Returns
this
prepend
Once
Listener
prepend
Once
Listener
(
event
:
string
, listener
:
function
)
:
this
prepend
Once
Listener
(
event
:
"close"
, listener
:
function
)
:
this
prepend
Once
Listener
(
event
:
"drain"
, listener
:
function
)
:
this
prepend
Once
Listener
(
event
:
"error"
, listener
:
function
)
:
this
prepend
Once
Listener
(
event
:
"finish"
, listener
:
function
)
:
this
prepend
Once
Listener
(
event
:
"pipe"
, listener
:
function
)
:
this
prepend
Once
Listener
(
event
:
"unpipe"
, listener
:
function
)
:
this
Parameters
event:
string
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"drain"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Returns
this
Parameters
event:
"finish"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"pipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
Returns
this
Parameters
event:
"unpipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
Returns
this
remove
All
Listeners
remove
All
Listeners
(
event
?:
string
|
symbol
)
:
this
Parameters
Optional
event:
string
|
symbol
Returns
this
remove
Header
remove
Header
(
name
:
string
)
:
void
Parameters
name:
string
Returns
void
remove
Listener
remove
Listener
(
event
:
string
, listener
:
function
)
:
this
remove
Listener
(
event
:
"close"
, listener
:
function
)
:
this
remove
Listener
(
event
:
"drain"
, listener
:
function
)
:
this
remove
Listener
(
event
:
"error"
, listener
:
function
)
:
this
remove
Listener
(
event
:
"finish"
, listener
:
function
)
:
this
remove
Listener
(
event
:
"pipe"
, listener
:
function
)
:
this
remove
Listener
(
event
:
"unpipe"
, listener
:
function
)
:
this
Parameters
event:
string
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"drain"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Returns
this
Parameters
event:
"finish"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"pipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
Returns
this
Parameters
event:
"unpipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
Returns
this
return
return
(
status
?:
any
, message
?:
any
)
:
void
Parameters
Optional
status:
any
Optional
message:
any
Returns
void
set
Default
Encoding
set
Default
Encoding
(
encoding
:
string
)
:
this
Parameters
encoding:
string
Returns
this
set
Header
set
Header
(
name
:
string
, value
:
number
|
string
|
string
[]
)
:
void
Parameters
name:
string
value:
number
|
string
|
string
[]
Returns
void
set
Max
Listeners
set
Max
Listeners
(
n
:
number
)
:
this
Parameters
n:
number
Returns
this
set
Timeout
set
Timeout
(
msecs
:
number
, callback
?:
function
)
:
this
Parameters
msecs:
number
Optional
callback:
function
(
)
:
void
Returns
void
Returns
this
uncork
uncork
(
)
:
void
Returns
void
write
write
(
chunk
:
any
, cb
?:
Function
)
:
boolean
write
(
chunk
:
any
, encoding
?:
string
, cb
?:
Function
)
:
boolean
Parameters
chunk:
any
Optional
cb:
Function
Returns
boolean
Parameters
chunk:
any
Optional
encoding:
string
Optional
cb:
Function
Returns
boolean
write
Continue
write
Continue
(
callback
?:
function
)
:
void
Parameters
Optional
callback:
function
(
)
:
void
Returns
void
Returns
void
write
Head
write
Head
(
statusCode
:
number
, reasonPhrase
?:
string
, headers
?:
OutgoingHttpHeaders
)
:
void
write
Head
(
statusCode
:
number
, headers
?:
OutgoingHttpHeaders
)
:
void
Parameters
statusCode:
number
Optional
reasonPhrase:
string
Optional
headers:
OutgoingHttpHeaders
Returns
void
Parameters
statusCode:
number
Optional
headers:
OutgoingHttpHeaders
Returns
void
Static
listener
Count
listener
Count
(
emitter
:
EventEmitter
, event
:
string
|
symbol
)
:
number
Parameters
emitter:
EventEmitter
event:
string
|
symbol
Returns
number
Globals
"http"
Constants
Http
Methods
Enum
Http
INext
IRequest
IResponse
constructor
chunked
Encoding
connection
finished
headers
Sent
send
Date
should
Keep
Alive
status
Code
status
Message
upgrading
use
Chunked
Encoding
ByDefault
writable
default
Max
Listeners
_destroy
_final
_write
_writev
add
Listener
add
Trailers
assign
Socket
cork
destroy
detach
Socket
emit
end
event
Names
flush
Headers
get
Header
get
Header
Names
get
Headers
get
Max
Listeners
has
Header
listener
Count
listeners
on
once
pipe
prepend
Listener
prepend
Once
Listener
remove
All
Listeners
remove
Header
remove
Listener
return
set
Default
Encoding
set
Header
set
Max
Listeners
set
Timeout
uncork
write
write
Continue
write
Head
listener
Count
IReturn
IRoute
Autoload
Body
Controller
Delete
Get
Mixed
Param
Params
Patch
Post
Put
Queries
Query
Req
Res
Route
Use
app
Generated using
TypeDoc
Event emitter The defined events on documents including: