yolkbot
learn
community
Preparing search index...
WSSocket
Interface WSSocket
The minimal type used to define the crossplatform browser & Node sockets
interface
WSSocket
{
binaryType
:
string
;
readyState
:
number
;
addEventListener
<
K
extends
keyof
WSEventMap
>
(
type
:
K
,
listener
:
(
ev
:
WSEventMap
[
K
]
)
=>
any
,
options
?:
boolean
|
AddEventListenerOptions
,
)
:
void
;
addEventListener
(
type
:
string
,
listener
:
EventListenerOrEventListenerObject
,
options
?:
boolean
|
AddEventListenerOptions
,
)
:
void
;
close
(
code
?:
number
)
:
void
;
removeEventListener
<
K
extends
keyof
WSEventMap
>
(
type
:
K
,
listener
:
(
ev
:
WSEventMap
[
K
]
)
=>
any
,
options
?:
boolean
|
EventListenerOptions
,
)
:
void
;
removeEventListener
(
type
:
string
,
listener
:
EventListenerOrEventListenerObject
,
options
?:
boolean
|
EventListenerOptions
,
)
:
void
;
send
(
data
:
string
|
Uint8Array
<
ArrayBuffer
>
)
:
void
;
terminate
?
()
:
void
;
}
Index
Methods
add
Event
Listener
close
remove
Event
Listener
send
terminate?
Properties
binary
Type
ready
State
Methods
add
Event
Listener
addEventListener
<
K
extends
keyof
WSEventMap
>
(
type
:
K
,
listener
:
(
ev
:
WSEventMap
[
K
]
)
=>
any
,
options
?:
boolean
|
AddEventListenerOptions
,
)
:
void
Type Parameters
K
extends
keyof
WSEventMap
Parameters
type
:
K
listener
:
(
ev
:
WSEventMap
[
K
]
)
=>
any
Optional
options
:
boolean
|
AddEventListenerOptions
Returns
void
addEventListener
(
type
:
string
,
listener
:
EventListenerOrEventListenerObject
,
options
?:
boolean
|
AddEventListenerOptions
,
)
:
void
Parameters
type
:
string
listener
:
EventListenerOrEventListenerObject
Optional
options
:
boolean
|
AddEventListenerOptions
Returns
void
close
close
(
code
?:
number
)
:
void
Parameters
Optional
code
:
number
Returns
void
remove
Event
Listener
removeEventListener
<
K
extends
keyof
WSEventMap
>
(
type
:
K
,
listener
:
(
ev
:
WSEventMap
[
K
]
)
=>
any
,
options
?:
boolean
|
EventListenerOptions
,
)
:
void
Type Parameters
K
extends
keyof
WSEventMap
Parameters
type
:
K
listener
:
(
ev
:
WSEventMap
[
K
]
)
=>
any
Optional
options
:
boolean
|
EventListenerOptions
Returns
void
removeEventListener
(
type
:
string
,
listener
:
EventListenerOrEventListenerObject
,
options
?:
boolean
|
EventListenerOptions
,
)
:
void
Parameters
type
:
string
listener
:
EventListenerOrEventListenerObject
Optional
options
:
boolean
|
EventListenerOptions
Returns
void
send
send
(
data
:
string
|
Uint8Array
<
ArrayBuffer
>
)
:
void
Parameters
data
:
string
|
Uint8Array
<
ArrayBuffer
>
Returns
void
Optional
terminate
terminate
?
()
:
void
Returns
void
Properties
binary
Type
binaryType
:
string
ready
State
readyState
:
number
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
add
Event
Listener
close
remove
Event
Listener
send
terminate
Properties
binary
Type
ready
State
learn
community
yolkbot
Loading...
The minimal type used to define the crossplatform browser & Node sockets