WebCola
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Read
Stream
Write
Stream
constructor
Socket
buffer
Size
bytes
Read
bytes
Written
columns
destroyed
isTTY
local
Address
local
Port
readable
remote
Address
remote
Family
remote
Port
rows
writable
default
Max
Listeners
_read
_write
add
Listener
address
connect
destroy
emit
end
event
Names
get
Max
Listeners
is
Paused
listener
Count
listeners
on
once
pause
pipe
prepend
Listener
prepend
Once
Listener
push
read
ref
remove
All
Listeners
remove
Listener
resume
set
Encoding
set
Keep
Alive
set
Max
Listeners
set
NoDelay
set
Timeout
unpipe
unref
unshift
wrap
write
listener
Count
isatty
Hierarchy
Socket
WriteStream
Implements
ReadableStream
ReadWriteStream
Index
Constructors
constructor
Properties
Socket
buffer
Size
bytes
Read
bytes
Written
columns
destroyed
isTTY
local
Address
local
Port
readable
remote
Address
remote
Family
remote
Port
rows
writable
default
Max
Listeners
Methods
_read
_write
add
Listener
address
connect
destroy
emit
end
event
Names
get
Max
Listeners
is
Paused
listener
Count
listeners
on
once
pause
pipe
prepend
Listener
prepend
Once
Listener
push
read
ref
remove
All
Listeners
remove
Listener
resume
set
Encoding
set
Keep
Alive
set
Max
Listeners
set
NoDelay
set
Timeout
unpipe
unref
unshift
wrap
write
listener
Count
Constructors
constructor
new
Write
Stream
(
opts
?:
DuplexOptions
)
:
WriteStream
Parameters
Optional
opts:
DuplexOptions
Returns
WriteStream
Properties
Socket
Socket
:
object
Type declaration
constructor
:
function
new __type
(
options
?:
object
)
:
__type
Parameters
Optional
options:
object
Optional
allow
Half
Open
?:
boolean
Optional
fd
?:
string
Optional
type
?:
string
Returns
__type
buffer
Size
buffer
Size
:
number
bytes
Read
bytes
Read
:
number
bytes
Written
bytes
Written
:
number
columns
columns
:
number
destroyed
destroyed
:
boolean
isTTY
isTTY
:
boolean
local
Address
local
Address
:
string
local
Port
local
Port
:
number
readable
readable
:
boolean
remote
Address
remote
Address
:
string
remote
Family
remote
Family
:
string
remote
Port
remote
Port
:
number
rows
rows
:
number
writable
writable
:
boolean
default
Max
Listeners
default
Max
Listeners
:
number
Methods
_read
_read
(
size
:
number
)
:
void
Parameters
size:
number
Returns
void
_write
_write
(
chunk
:
any
, encoding
:
string
, callback
:
Function
)
:
void
Parameters
chunk:
any
encoding:
string
callback:
Function
Returns
void
add
Listener
add
Listener
(
event
:
string
, listener
:
Function
)
add
Listener
(
event
:
"close"
, listener
:
function
)
add
Listener
(
event
:
"connect"
, listener
:
function
)
add
Listener
(
event
:
"data"
, listener
:
function
)
add
Listener
(
event
:
"drain"
, listener
:
function
)
add
Listener
(
event
:
"end"
, listener
:
function
)
add
Listener
(
event
:
"error"
, listener
:
function
)
add
Listener
(
event
:
"lookup"
, listener
:
function
)
add
Listener
(
event
:
"timeout"
, listener
:
function
)
events.EventEmitter
close
connect
data
drain
end
error
lookup
timeout
Parameters
event:
string
listener:
Function
Parameters
event:
"close"
listener:
function
(
had_error
:
boolean
)
:
void
Parameters
had_error:
boolean
Returns
void
Parameters
event:
"connect"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"data"
listener:
function
(
data
:
Buffer
)
:
void
Parameters
data:
Buffer
Returns
void
Parameters
event:
"drain"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"end"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Parameters
event:
"lookup"
listener:
function
(
err
:
Error
, address
:
string
, family
:
string
|
number
, host
:
string
)
:
void
Parameters
err:
Error
address:
string
family:
string
|
number
host:
string
Returns
void
Parameters
event:
"timeout"
listener:
function
(
)
:
void
Returns
void
address
address
(
)
:
object
Returns
object
address
:
string
family
:
string
port
:
number
connect
connect
(
port
:
number
, host
?:
string
, connectionListener
?:
Function
)
:
void
connect
(
path
:
string
, connectionListener
?:
Function
)
:
void
Parameters
port:
number
Optional
host:
string
Optional
connectionListener:
Function
Returns
void
Parameters
path:
string
Optional
connectionListener:
Function
Returns
void
destroy
destroy
(
)
:
void
Returns
void
emit
emit
(
event
:
string
,
...
args
:
any
[]
)
:
boolean
emit
(
event
:
"close"
, had_error
:
boolean
)
:
boolean
emit
(
event
:
"connect"
)
:
boolean
emit
(
event
:
"data"
, data
:
Buffer
)
:
boolean
emit
(
event
:
"drain"
)
:
boolean
emit
(
event
:
"end"
)
:
boolean
emit
(
event
:
"error"
, err
:
Error
)
:
boolean
emit
(
event
:
"lookup"
, err
:
Error
, address
:
string
, family
:
string
|
number
, host
:
string
)
:
boolean
emit
(
event
:
"timeout"
)
:
boolean
Parameters
event:
string
Rest
...
args:
any
[]
Returns
boolean
Parameters
event:
"close"
had_error:
boolean
Returns
boolean
Parameters
event:
"connect"
Returns
boolean
Parameters
event:
"data"
data:
Buffer
Returns
boolean
Parameters
event:
"drain"
Returns
boolean
Parameters
event:
"end"
Returns
boolean
Parameters
event:
"error"
err:
Error
Returns
boolean
Parameters
event:
"lookup"
err:
Error
address:
string
family:
string
|
number
host:
string
Returns
boolean
Parameters
event:
"timeout"
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
Max
Listeners
get
Max
Listeners
(
)
:
number
Returns
number
is
Paused
is
Paused
(
)
:
boolean
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
)
on
(
event
:
"close"
, listener
:
function
)
on
(
event
:
"connect"
, listener
:
function
)
on
(
event
:
"data"
, listener
:
function
)
on
(
event
:
"drain"
, listener
:
function
)
on
(
event
:
"end"
, listener
:
function
)
on
(
event
:
"error"
, listener
:
function
)
on
(
event
:
"lookup"
, listener
:
function
)
on
(
event
:
"timeout"
, listener
:
function
)
Parameters
event:
string
listener:
Function
Parameters
event:
"close"
listener:
function
(
had_error
:
boolean
)
:
void
Parameters
had_error:
boolean
Returns
void
Parameters
event:
"connect"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"data"
listener:
function
(
data
:
Buffer
)
:
void
Parameters
data:
Buffer
Returns
void
Parameters
event:
"drain"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"end"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Parameters
event:
"lookup"
listener:
function
(
err
:
Error
, address
:
string
, family
:
string
|
number
, host
:
string
)
:
void
Parameters
err:
Error
address:
string
family:
string
|
number
host:
string
Returns
void
Parameters
event:
"timeout"
listener:
function
(
)
:
void
Returns
void
once
once
(
event
:
string
, listener
:
Function
)
once
(
event
:
"close"
, listener
:
function
)
once
(
event
:
"connect"
, listener
:
function
)
once
(
event
:
"data"
, listener
:
function
)
once
(
event
:
"drain"
, listener
:
function
)
once
(
event
:
"end"
, listener
:
function
)
once
(
event
:
"error"
, listener
:
function
)
once
(
event
:
"lookup"
, listener
:
function
)
once
(
event
:
"timeout"
, listener
:
function
)
Parameters
event:
string
listener:
Function
Parameters
event:
"close"
listener:
function
(
had_error
:
boolean
)
:
void
Parameters
had_error:
boolean
Returns
void
Parameters
event:
"connect"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"data"
listener:
function
(
data
:
Buffer
)
:
void
Parameters
data:
Buffer
Returns
void
Parameters
event:
"drain"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"end"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Parameters
event:
"lookup"
listener:
function
(
err
:
Error
, address
:
string
, family
:
string
|
number
, host
:
string
)
:
void
Parameters
err:
Error
address:
string
family:
string
|
number
host:
string
Returns
void
Parameters
event:
"timeout"
listener:
function
(
)
:
void
Returns
void
pause
pause
(
)
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
)
prepend
Listener
(
event
:
"close"
, listener
:
function
)
prepend
Listener
(
event
:
"connect"
, listener
:
function
)
prepend
Listener
(
event
:
"data"
, listener
:
function
)
prepend
Listener
(
event
:
"drain"
, listener
:
function
)
prepend
Listener
(
event
:
"end"
, listener
:
function
)
prepend
Listener
(
event
:
"error"
, listener
:
function
)
prepend
Listener
(
event
:
"lookup"
, listener
:
function
)
prepend
Listener
(
event
:
"timeout"
, listener
:
function
)
Parameters
event:
string
listener:
Function
Parameters
event:
"close"
listener:
function
(
had_error
:
boolean
)
:
void
Parameters
had_error:
boolean
Returns
void
Parameters
event:
"connect"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"data"
listener:
function
(
data
:
Buffer
)
:
void
Parameters
data:
Buffer
Returns
void
Parameters
event:
"drain"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"end"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Parameters
event:
"lookup"
listener:
function
(
err
:
Error
, address
:
string
, family
:
string
|
number
, host
:
string
)
:
void
Parameters
err:
Error
address:
string
family:
string
|
number
host:
string
Returns
void
Parameters
event:
"timeout"
listener:
function
(
)
:
void
Returns
void
prepend
Once
Listener
prepend
Once
Listener
(
event
:
string
, listener
:
Function
)
prepend
Once
Listener
(
event
:
"close"
, listener
:
function
)
prepend
Once
Listener
(
event
:
"connect"
, listener
:
function
)
prepend
Once
Listener
(
event
:
"data"
, listener
:
function
)
prepend
Once
Listener
(
event
:
"drain"
, listener
:
function
)
prepend
Once
Listener
(
event
:
"end"
, listener
:
function
)
prepend
Once
Listener
(
event
:
"error"
, listener
:
function
)
prepend
Once
Listener
(
event
:
"lookup"
, listener
:
function
)
prepend
Once
Listener
(
event
:
"timeout"
, listener
:
function
)
Parameters
event:
string
listener:
Function
Parameters
event:
"close"
listener:
function
(
had_error
:
boolean
)
:
void
Parameters
had_error:
boolean
Returns
void
Parameters
event:
"connect"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"data"
listener:
function
(
data
:
Buffer
)
:
void
Parameters
data:
Buffer
Returns
void
Parameters
event:
"drain"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"end"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Parameters
event:
"lookup"
listener:
function
(
err
:
Error
, address
:
string
, family
:
string
|
number
, host
:
string
)
:
void
Parameters
err:
Error
address:
string
family:
string
|
number
host:
string
Returns
void
Parameters
event:
"timeout"
listener:
function
(
)
:
void
Returns
void
push
push
(
chunk
:
any
, encoding
?:
string
)
:
boolean
Parameters
chunk:
any
Optional
encoding:
string
Returns
boolean
read
read
(
size
?:
number
)
:
any
Parameters
Optional
size:
number
Returns
any
ref
ref
(
)
:
void
Returns
void
remove
All
Listeners
remove
All
Listeners
(
event
?:
string
|
symbol
)
Parameters
Optional
event:
string
|
symbol
remove
Listener
remove
Listener
(
event
:
string
, listener
:
Function
)
remove
Listener
(
event
:
"close"
, listener
:
function
)
remove
Listener
(
event
:
"data"
, listener
:
function
)
remove
Listener
(
event
:
"end"
, listener
:
function
)
remove
Listener
(
event
:
"readable"
, listener
:
function
)
remove
Listener
(
event
:
"error"
, listener
:
function
)
Parameters
event:
string
listener:
Function
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"data"
listener:
function
(
chunk
:
Buffer
|
string
)
:
void
Parameters
chunk:
Buffer
|
string
Returns
void
Parameters
event:
"end"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"readable"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
resume
resume
(
)
set
Encoding
set
Encoding
(
encoding
?:
string
)
Parameters
Optional
encoding:
string
set
Keep
Alive
set
Keep
Alive
(
enable
?:
boolean
, initialDelay
?:
number
)
:
void
Parameters
Optional
enable:
boolean
Optional
initialDelay:
number
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
Timeout
set
Timeout
(
timeout
:
number
, callback
?:
Function
)
:
void
Parameters
timeout:
number
Optional
callback:
Function
Returns
void
unpipe
unpipe<T>
(
destination
?:
T
)
Type parameters
T
:
WritableStream
Parameters
Optional
destination:
T
unref
unref
(
)
:
void
Returns
void
unshift
unshift
(
chunk
:
any
)
:
void
Parameters
chunk:
any
Returns
void
wrap
wrap
(
oldStream
:
ReadableStream
)
:
ReadableStream
Parameters
oldStream:
ReadableStream
Returns
ReadableStream
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
(
data
:
any
, encoding
?:
string
, callback
?:
Function
)
:
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
data:
any
Optional
encoding:
string
Optional
callback:
Function
Returns
void
listener
Count
listener
Count
(
emitter
:
EventEmitter
, event
:
string
|
symbol
)
:
number
Parameters
emitter:
EventEmitter
event:
string
|
symbol
Returns
number
Generated using
TypeDoc
events.EventEmitter