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
Class WST
Hierarchy
EventEmitter
WST
Index
Classes
Server
Interfaces
WSSOptions
Constructors
constructor
Properties
UUID
options
responder
socket
Telnet
default
Max
Listeners
Methods
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
Constructors
constructor
new WST
(
socket
:
WS
)
:
WST
Parameters
socket:
WS
Returns
WST
Properties
UUID
UUID
:
string
= v4()
options
options
:
_Telnet.TelnetOptionMatrix
= new _Telnet.TelnetOptionMatrix()
Private
responder
responder
:
Nullable
<
(
data
:
string
)
=>
void
>
= null
Private
socket
socket
:
WS
Static
Telnet
Telnet
:
Telnet
= _Telnet
Static
default
Max
Listeners
default
Max
Listeners
:
number
Methods
Private
Handle
Data
Handle
Data
(
data
:
Buffer
)
:
void
Parameters
data:
Buffer
Returns
void
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
close
close
(
code
?:
undefined
|
number
, reason
?:
undefined
|
string
)
:
void
Parameters
Optional
code:
undefined
|
number
Optional
reason:
undefined
|
string
Returns
void
do
do
(
option
:
_Telnet.TelnetOption
)
:
void
Parameters
option:
_Telnet.TelnetOption
Returns
void
dont
dont
(
option
:
_Telnet.TelnetOption
)
:
void
Parameters
option:
_Telnet.TelnetOption
Returns
void
emit
emit
(
event
:
"error"
, error
:
Error
)
:
boolean
emit
(
event
:
"message"
, data
:
string
)
:
boolean
emit
(
event
:
"close"
, code
?:
undefined
|
number
, reason
?:
undefined
|
string
)
:
boolean
emit
(
event
:
"ping"
|
"pong"
, data
?:
Buffer
)
:
boolean
emit
(
event
:
"will"
|
"wont"
|
"do"
|
"dont"
, option
:
number
)
:
boolean
emit
(
event
:
"subnegotiation"
, option
:
number
, data
:
Buffer
)
:
boolean
emit
(
event
:
"telnet"
, ev
:
_Telnet.TelnetEvent
)
:
boolean
emit
(
event
:
"open"
)
:
boolean
emit
(
event
:
"gmcp"
, namespace
:
string
, data
:
{}
)
:
boolean
Parameters
event:
"error"
error:
Error
Returns
boolean
Parameters
event:
"message"
data:
string
Returns
boolean
Parameters
event:
"close"
Optional
code:
undefined
|
number
Optional
reason:
undefined
|
string
Returns
boolean
Parameters
event:
"ping"
|
"pong"
Optional
data:
Buffer
Returns
boolean
Parameters
event:
"will"
|
"wont"
|
"do"
|
"dont"
option:
number
Returns
boolean
Parameters
event:
"subnegotiation"
option:
number
data:
Buffer
Returns
boolean
Parameters
event:
"telnet"
ev:
_Telnet.TelnetEvent
Returns
boolean
Parameters
event:
"open"
Returns
boolean
Parameters
event:
"gmcp"
namespace:
string
data:
{}
[
key:
string
]:
any
Returns
boolean
event
Names
event
Names
(
)
:
Array
<
string
|
symbol
>
Returns
Array
<
string
|
symbol
>
get
Max
Listeners
get
Max
Listeners
(
)
:
number
Returns
number
go
Ahead
go
Ahead
(
)
:
void
Returns
void
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
:
"error"
, listener
:
(
error
:
Error
)
=>
void
)
:
this
on
(
event
:
"message"
, listener
:
(
data
:
string
)
=>
void
)
:
this
on
(
event
:
"close"
, listener
:
(
code
?:
undefined
|
number
, reason
?:
undefined
|
string
)
=>
void
)
:
this
on
(
event
:
"ping"
|
"pong"
, listener
:
(
data
?:
Buffer
)
=>
void
)
:
this
on
(
event
:
"will"
|
"wont"
|
"do"
|
"dont"
, listener
:
(
option
:
number
)
=>
void
)
:
this
on
(
event
:
"subnegotiation"
, listener
:
(
option
:
number
, data
:
Buffer
)
=>
void
)
:
this
on
(
event
:
"telnet"
, listener
:
(
ev
:
_Telnet.TelnetEvent
)
=>
void
)
:
this
on
(
event
:
"open"
, listener
:
(
)
=>
void
)
:
this
on
(
event
:
"gmcp"
, listener
:
(
namespace
:
string
, data
:
{}
)
=>
void
)
:
this
Parameters
event:
"error"
listener:
(
error
:
Error
)
=>
void
(
error
:
Error
)
:
void
Parameters
error:
Error
Returns
void
Returns
this
Parameters
event:
"message"
listener:
(
data
:
string
)
=>
void
(
data
:
string
)
:
void
Parameters
data:
string
Returns
void
Returns
this
Parameters
event:
"close"
listener:
(
code
?:
undefined
|
number
, reason
?:
undefined
|
string
)
=>
void
(
code
?:
undefined
|
number
, reason
?:
undefined
|
string
)
:
void
Parameters
Optional
code:
undefined
|
number
Optional
reason:
undefined
|
string
Returns
void
Returns
this
Parameters
event:
"ping"
|
"pong"
listener:
(
data
?:
Buffer
)
=>
void
(
data
?:
Buffer
)
:
void
Parameters
Optional
data:
Buffer
Returns
void
Returns
this
Parameters
event:
"will"
|
"wont"
|
"do"
|
"dont"
listener:
(
option
:
number
)
=>
void
(
option
:
number
)
:
void
Parameters
option:
number
Returns
void
Returns
this
Parameters
event:
"subnegotiation"
listener:
(
option
:
number
, data
:
Buffer
)
=>
void
(
option
:
number
, data
:
Buffer
)
:
void
Parameters
option:
number
data:
Buffer
Returns
void
Returns
this
Parameters
event:
"telnet"
listener:
(
ev
:
_Telnet.TelnetEvent
)
=>
void
(
ev
:
_Telnet.TelnetEvent
)
:
void
Parameters
ev:
_Telnet.TelnetEvent
Returns
void
Returns
this
Parameters
event:
"open"
listener:
(
)
=>
void
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"gmcp"
listener:
(
namespace
:
string
, data
:
{}
)
=>
void
(
namespace
:
string
, data
:
{}
)
:
void
Parameters
namespace:
string
data:
{}
[
key:
string
]:
any
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
prompt
prompt
(
message
:
string
, mask
?:
boolean
)
:
Promise
<
string
>
Parameters
message:
string
Default value
mask:
boolean
= false
Returns
Promise
<
string
>
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
send
send
(
data
:
Buffer
)
:
void
send
(
data
:
string
)
:
void
Parameters
data:
Buffer
Returns
void
Parameters
data:
string
Returns
void
sendGMCP
sendGMCP
(
namespace
:
string
, data
:
string
)
:
void
sendGMCP
(
namespace
:
string
, data
:
{}
)
:
void
Parameters
namespace:
string
data:
string
Returns
void
Parameters
namespace:
string
data:
{}
[
key:
string
]:
any
Returns
void
send
Subnegotiation
send
Subnegotiation
(
option
:
_Telnet.TelnetOption
, data
:
Buffer
)
:
void
send
Subnegotiation
(
option
:
_Telnet.TelnetOption
, data
:
string
)
:
void
Parameters
option:
_Telnet.TelnetOption
data:
Buffer
Returns
void
Parameters
option:
_Telnet.TelnetOption
data:
string
Returns
void
Private
send
Telnet
send
Telnet
(
command
:
_Telnet.TelnetNegotiation
, option
:
_Telnet.TelnetOption
, data
?:
Buffer
)
:
void
Parameters
command:
_Telnet.TelnetNegotiation
option:
_Telnet.TelnetOption
Optional
data:
Buffer
Returns
void
set
Max
Listeners
set
Max
Listeners
(
n
:
number
)
:
this
Parameters
n:
number
Returns
this
will
will
(
option
:
_Telnet.TelnetOption
)
:
void
Parameters
option:
_Telnet.TelnetOption
Returns
void
wont
wont
(
option
:
_Telnet.TelnetOption
)
:
void
Parameters
option:
_Telnet.TelnetOption
Returns
void
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
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