WebCola
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Agent
Agent
Options
Client
Request
constructor
writable
default
Max
Listeners
_write
abort
add
Listener
add
Trailers
emit
end
event
Names
get
Header
get
Max
Listeners
listener
Count
listeners
on
once
prepend
Listener
prepend
Once
Listener
remove
All
Listeners
remove
Header
remove
Listener
set
Header
set
Max
Listeners
set
NoDelay
set
Socket
Keep
Alive
set
Timeout
write
listener
Count
Client
Response
Incoming
Message
Request
Options
Server
Server
Request
Server
Response
METHODS
STATUS_
CODES
global
Agent
create
Client
create
Server
get
request
Hierarchy
Writable
ClientRequest
Implements
WritableStream
Index
Constructors
constructor
Properties
writable
default
Max
Listeners
Methods
_write
abort
add
Listener
add
Trailers
emit
end
event
Names
get
Header
get
Max
Listeners
listener
Count
listeners
on
once
prepend
Listener
prepend
Once
Listener
remove
All
Listeners
remove
Header
remove
Listener
set
Header
set
Max
Listeners
set
NoDelay
set
Socket
Keep
Alive
set
Timeout
write
listener
Count
Constructors
constructor
new
Client
Request
(
opts
?:
WritableOptions
)
:
ClientRequest
Parameters
Optional
opts:
WritableOptions
Returns
ClientRequest
Properties
writable
writable
:
boolean
default
Max
Listeners
default
Max
Listeners
:
number
Methods
_write
_write
(
chunk
:
any
, encoding
:
string
, callback
:
Function
)
:
void
Parameters
chunk:
any
encoding:
string
callback:
Function
Returns
void
abort
abort
(
)
:
void
Returns
void
add
Listener
add
Listener
(
event
:
string
, listener
:
Function
)
add
Listener
(
event
:
"close"
, listener
:
function
)
add
Listener
(
event
:
"drain"
, listener
:
function
)
add
Listener
(
event
:
"error"
, listener
:
function
)
add
Listener
(
event
:
"finish"
, listener
:
function
)
add
Listener
(
event
:
"pipe"
, listener
:
function
)
add
Listener
(
event
:
"unpipe"
, listener
:
function
)
Event emitter The defined events on documents including:
close
drain
error
finish
pipe
unpipe
Parameters
event:
string
listener:
Function
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"drain"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Parameters
event:
"finish"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"pipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
Parameters
event:
"unpipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
add
Trailers
add
Trailers
(
headers
:
any
)
:
void
Parameters
headers:
any
Returns
void
emit
emit
(
event
:
string
,
...
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
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
(
)
:
void
end
(
buffer
:
Buffer
, cb
?:
Function
)
:
void
end
(
str
:
string
, cb
?:
Function
)
:
void
end
(
str
:
string
, encoding
?:
string
, cb
?:
Function
)
:
void
end
(
data
?:
any
, encoding
?:
string
)
:
void
Returns
void
Parameters
buffer:
Buffer
Optional
cb:
Function
Returns
void
Parameters
str:
string
Optional
cb:
Function
Returns
void
Parameters
str:
string
Optional
encoding:
string
Optional
cb:
Function
Returns
void
Parameters
Optional
data:
any
Optional
encoding:
string
Returns
void
event
Names
event
Names
(
)
:
string
|
symbol
Returns
string
|
symbol
get
Header
get
Header
(
name
:
string
)
:
string
Parameters
name:
string
Returns
string
get
Max
Listeners
get
Max
Listeners
(
)
:
number
Returns
number
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
)
on
(
event
:
"close"
, listener
:
function
)
on
(
event
:
"drain"
, listener
:
function
)
on
(
event
:
"error"
, listener
:
function
)
on
(
event
:
"finish"
, listener
:
function
)
on
(
event
:
"pipe"
, listener
:
function
)
on
(
event
:
"unpipe"
, listener
:
function
)
Parameters
event:
string
listener:
Function
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"drain"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Parameters
event:
"finish"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"pipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
Parameters
event:
"unpipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
once
once
(
event
:
string
, listener
:
Function
)
once
(
event
:
"close"
, listener
:
function
)
once
(
event
:
"drain"
, listener
:
function
)
once
(
event
:
"error"
, listener
:
function
)
once
(
event
:
"finish"
, listener
:
function
)
once
(
event
:
"pipe"
, listener
:
function
)
once
(
event
:
"unpipe"
, listener
:
function
)
Parameters
event:
string
listener:
Function
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"drain"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Parameters
event:
"finish"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"pipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
Parameters
event:
"unpipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
prepend
Listener
prepend
Listener
(
event
:
string
, listener
:
Function
)
prepend
Listener
(
event
:
"close"
, listener
:
function
)
prepend
Listener
(
event
:
"drain"
, listener
:
function
)
prepend
Listener
(
event
:
"error"
, listener
:
function
)
prepend
Listener
(
event
:
"finish"
, listener
:
function
)
prepend
Listener
(
event
:
"pipe"
, listener
:
function
)
prepend
Listener
(
event
:
"unpipe"
, listener
:
function
)
Parameters
event:
string
listener:
Function
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"drain"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Parameters
event:
"finish"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"pipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
Parameters
event:
"unpipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
prepend
Once
Listener
prepend
Once
Listener
(
event
:
string
, listener
:
Function
)
prepend
Once
Listener
(
event
:
"close"
, listener
:
function
)
prepend
Once
Listener
(
event
:
"drain"
, listener
:
function
)
prepend
Once
Listener
(
event
:
"error"
, listener
:
function
)
prepend
Once
Listener
(
event
:
"finish"
, listener
:
function
)
prepend
Once
Listener
(
event
:
"pipe"
, listener
:
function
)
prepend
Once
Listener
(
event
:
"unpipe"
, listener
:
function
)
Parameters
event:
string
listener:
Function
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"drain"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Parameters
event:
"finish"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"pipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
Parameters
event:
"unpipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
remove
All
Listeners
remove
All
Listeners
(
event
?:
string
|
symbol
)
Parameters
Optional
event:
string
|
symbol
remove
Header
remove
Header
(
name
:
string
)
:
void
Parameters
name:
string
Returns
void
remove
Listener
remove
Listener
(
event
:
string
, listener
:
Function
)
remove
Listener
(
event
:
"close"
, listener
:
function
)
remove
Listener
(
event
:
"drain"
, listener
:
function
)
remove
Listener
(
event
:
"error"
, listener
:
function
)
remove
Listener
(
event
:
"finish"
, listener
:
function
)
remove
Listener
(
event
:
"pipe"
, listener
:
function
)
remove
Listener
(
event
:
"unpipe"
, listener
:
function
)
Parameters
event:
string
listener:
Function
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"drain"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Parameters
event:
"finish"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"pipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
Parameters
event:
"unpipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
set
Header
set
Header
(
name
:
string
, value
:
string
|
string
[]
)
:
void
Parameters
name:
string
value:
string
|
string
[]
Returns
void
set
Max
Listeners
set
Max
Listeners
(
n
:
number
)
Parameters
n:
number
set
NoDelay
set
NoDelay
(
noDelay
?:
boolean
)
:
void
Parameters
Optional
noDelay:
boolean
Returns
void
set
Socket
Keep
Alive
set
Socket
Keep
Alive
(
enable
?:
boolean
, initialDelay
?:
number
)
:
void
Parameters
Optional
enable:
boolean
Optional
initialDelay:
number
Returns
void
set
Timeout
set
Timeout
(
timeout
:
number
, callback
?:
Function
)
:
void
Parameters
timeout:
number
Optional
callback:
Function
Returns
void
write
write
(
buffer
:
Buffer
)
:
boolean
write
(
buffer
:
Buffer
, cb
?:
Function
)
:
boolean
write
(
str
:
string
, cb
?:
Function
)
:
boolean
write
(
str
:
string
, encoding
?:
string
, cb
?:
Function
)
:
boolean
write
(
str
:
string
, encoding
?:
string
, fd
?:
string
)
:
boolean
write
(
chunk
:
any
, encoding
?:
string
)
:
void
Parameters
buffer:
Buffer
Returns
boolean
Parameters
buffer:
Buffer
Optional
cb:
Function
Returns
boolean
Parameters
str:
string
Optional
cb:
Function
Returns
boolean
Parameters
str:
string
Optional
encoding:
string
Optional
cb:
Function
Returns
boolean
Parameters
str:
string
Optional
encoding:
string
Optional
fd:
string
Returns
boolean
Parameters
chunk:
any
Optional
encoding:
string
Returns
void
listener
Count
listener
Count
(
emitter
:
EventEmitter
, event
:
string
|
symbol
)
:
number
Parameters
emitter:
EventEmitter
event:
string
|
symbol
Returns
number
Generated using
TypeDoc
Event emitter The defined events on documents including: