Preparing search index...
The search index is not available
@deltachat/jsonrpc-client
@deltachat/jsonrpc-client
yerpc
WebsocketTransport
Class WebsocketTransport
Hierarchy
BaseTransport
<
WebsocketEvents
>
WebsocketTransport
Index
Constructors
constructor
Properties
_socket
e
url
Accessors
connected
reconnect
Attempts
Methods
_onmessage
_send
close
emit
notification
off
on
once
request
Constructors
constructor
new
Websocket
Transport
(
url
:
string
, options
?:
WebsocketOptions
)
:
WebsocketTransport
Parameters
url:
string
Optional
options:
WebsocketOptions
Returns
WebsocketTransport
Properties
_socket
_socket
:
ReconnectingWebsocket
e
e
:
Map
<
keyof
WebsocketEvents
,
EventData
[]
>
url
url
:
string
Accessors
connected
get
connected
(
)
:
boolean
Returns
boolean
reconnect
Attempts
get
reconnectAttempts
(
)
:
number
Returns
number
Methods
Protected
_onmessage
_onmessage
(
message
:
yerpc
.
Message
)
:
void
Parameters
message:
yerpc
.
Message
Returns
void
_send
_send
(
message
:
yerpc
.
Message
)
:
void
Parameters
message:
yerpc
.
Message
Returns
void
close
close
(
)
:
void
Returns
void
emit
emit
<
E
>
(
event
:
string
|
E
,
...
args
:
any
[]
|
Arguments
<
ClientEvents
<
WebsocketEvents
>
[
E
]
>
)
:
undefined
|
WebsocketTransport
Type Parameters
E
extends
keyof
WebsocketEvents
Parameters
event:
string
|
E
Rest
...
args:
any
[]
|
Arguments
<
ClientEvents
<
WebsocketEvents
>
[
E
]
>
Returns
undefined
|
WebsocketTransport
notification
notification
(
method
:
string
, params
?:
yerpc
.
Params
)
:
void
Parameters
method:
string
Optional
params:
yerpc
.
Params
Returns
void
off
off
<
E
>
(
event
:
E
, callback
?:
ClientEvents
<
WebsocketEvents
>
[
E
]
)
:
undefined
|
WebsocketTransport
Type Parameters
E
extends
keyof
WebsocketEvents
Parameters
event:
E
Optional
callback:
ClientEvents
<
WebsocketEvents
>
[
E
]
Returns
undefined
|
WebsocketTransport
on
on
<
E
>
(
event
:
E
, callback
:
ClientEvents
<
WebsocketEvents
>
[
E
]
, ctx
?:
any
)
:
WebsocketTransport
Type Parameters
E
extends
keyof
WebsocketEvents
Parameters
event:
E
callback:
ClientEvents
<
WebsocketEvents
>
[
E
]
Optional
ctx:
any
Returns
WebsocketTransport
once
once
<
E
>
(
event
:
E
, callback
:
ClientEvents
<
WebsocketEvents
>
[
E
]
, ctx
?:
any
)
:
void
Type Parameters
E
extends
keyof
WebsocketEvents
Parameters
event:
E
callback:
ClientEvents
<
WebsocketEvents
>
[
E
]
Optional
ctx:
any
Returns
void
request
request
(
method
:
string
, params
?:
yerpc
.
Params
)
:
Promise
<
unknown
>
Parameters
method:
string
Optional
params:
yerpc
.
Params
Returns
Promise
<
unknown
>
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
Modules
@deltachat/jsonrpc-
client
RPC
T
yerpc
Websocket
Transport
constructor
_socket
e
url
connected
reconnect
Attempts
_onmessage
_send
close
emit
notification
off
on
once
request
Generated using
TypeDoc