Search
Preparing search index...
The search index is not available
WS-Telnet
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"index"
WST
Server
Class Server
Hierarchy
EventEmitter
Server
Index
Constructors
constructor
Properties
_server
clients
default
Max
Listeners
Methods
add
Listener
emit
event
Names
get
Max
Listeners
listener
Count
listeners
off
on
once
prepend
Listener
prepend
Once
Listener
raw
Listeners
remove
All
Listeners
remove
Listener
set
Max
Listeners
listener
Count
Constructors
constructor
new
Server
(
host
:
string
, port
:
number
, secure
?:
WSSOptions
)
:
Server
Parameters
host:
string
port:
number
Optional
secure:
WSSOptions
Returns
Server
Properties
Private
_server
_server
:
WS.Server
clients
clients
:
Map
<
string
,
WST
>
= new Map()
Static
default
Max
Listeners
default
Max
Listeners
:
number
Methods
add
Listener
add
Listener
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
this
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
emit
emit
(
event
:
"listening"
, host
:
string
, port
:
number
)
:
boolean
emit
(
event
:
"close"
)
:
boolean
emit
(
event
:
"error"
, error
:
Error
)
:
boolean
emit
(
event
:
"connection"
, client
:
WST
)
:
boolean
Parameters
event:
"listening"
host:
string
port:
number
Returns
boolean
Parameters
event:
"close"
Returns
boolean
Parameters
event:
"error"
error:
Error
Returns
boolean
Parameters
event:
"connection"
client:
WST
Returns
boolean
event
Names
event
Names
(
)
:
Array
<
string
|
symbol
>
Returns
Array
<
string
|
symbol
>
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
[]
off
off
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
this
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
on
on
(
event
:
"listening"
, listener
:
(
host
:
string
, port
:
number
)
=>
void
)
:
this
on
(
event
:
"close"
, listener
:
(
)
=>
void
)
:
this
on
(
event
:
"error"
, listener
:
(
error
:
Error
)
=>
void
)
:
this
on
(
event
:
"connection"
, listener
:
(
client
:
WST
)
=>
void
)
:
this
Parameters
event:
"listening"
listener:
(
host
:
string
, port
:
number
)
=>
void
(
host
:
string
, port
:
number
)
:
void
Parameters
host:
string
port:
number
Returns
void
Returns
this
Parameters
event:
"close"
listener:
(
)
=>
void
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"error"
listener:
(
error
:
Error
)
=>
void
(
error
:
Error
)
:
void
Parameters
error:
Error
Returns
void
Returns
this
Parameters
event:
"connection"
listener:
(
client
:
WST
)
=>
void
(
client
:
WST
)
:
void
Parameters
client:
WST
Returns
void
Returns
this
once
once
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
this
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
prepend
Listener
prepend
Listener
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
this
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
prepend
Once
Listener
prepend
Once
Listener
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
this
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
raw
Listeners
raw
Listeners
(
event
:
string
|
symbol
)
:
Function
[]
Parameters
event:
string
|
symbol
Returns
Function
[]
remove
All
Listeners
remove
All
Listeners
(
event
?:
string
|
symbol
)
:
this
Parameters
Optional
event:
string
|
symbol
Returns
this
remove
Listener
remove
Listener
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
this
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
set
Max
Listeners
set
Max
Listeners
(
n
:
number
)
:
this
Parameters
n:
number
Returns
this
Static
listener
Count
listener
Count
(
emitter
:
EventEmitter
, event
:
string
|
symbol
)
:
number
deprecated
since v4.0.0
Parameters
emitter:
EventEmitter
event:
string
|
symbol
Returns
number
Globals
"index"
"telnet"
WST
Server
constructor
_server
clients
default
Max
Listeners
add
Listener
emit
event
Names
get
Max
Listeners
listener
Count
listeners
off
on
once
prepend
Listener
prepend
Once
Listener
raw
Listeners
remove
All
Listeners
remove
Listener
set
Max
Listeners
listener
Count
WSSOptions
constructor
UUID
options
responder
socket
Telnet
default
Max
Listeners
Handle
Data
add
Listener
close
do
dont
emit
event
Names
get
Max
Listeners
go
Ahead
listener
Count
listeners
off
on
once
prepend
Listener
prepend
Once
Listener
prompt
raw
Listeners
remove
All
Listeners
remove
Listener
send
sendGMCP
send
Subnegotiation
send
Telnet
set
Max
Listeners
will
wont
listener
Count
Generated using
TypeDoc
since v4.0.0