Class: LazyDarkWs
Defined in: packages/darkws/src/dark-ws.ts:786
A client created on first use; subscriptions are kept by the facade and survive reset().
Constructors
Constructor
new LazyDarkWs(
options):LazyDarkWs
Defined in: packages/darkws/src/dark-ws.ts:791
Parameters
options
DarkWsOptions | (() => DarkWsOptions)
Returns
LazyDarkWs
Accessors
instance
Get Signature
get instance():
DarkWs
Defined in: packages/darkws/src/dark-ws.ts:794
The current client, created (without connecting) if needed. Close it through the facade.
Returns
Methods
authenticate()
authenticate(
token):Promise<void>
Defined in: packages/darkws/src/dark-ws.ts:815
Parameters
token
string
Returns
Promise<void>
close()
close(
code?):void
Defined in: packages/darkws/src/dark-ws.ts:848
Closes the client if it exists; the next request or subscription connects again.
Parameters
code?
number = 1000
Returns
void
logout()
logout():
Promise<void>
Defined in: packages/darkws/src/dark-ws.ts:819
Returns
Promise<void>
off()
off<
K>(event,callback):void
Defined in: packages/darkws/src/dark-ws.ts:830
Type Parameters
K
K extends keyof DarkWsEvents
Parameters
event
K
callback
(...args) => void
Returns
void
on()
on<
K>(event,callback): () =>void
Defined in: packages/darkws/src/dark-ws.ts:823
Type Parameters
K
K extends keyof DarkWsEvents
Parameters
event
K
callback
(...args) => void
Returns
() => void
onAction()
onAction<
TData>(action,callback): () =>void
Defined in: packages/darkws/src/dark-ws.ts:838
Type Parameters
TData
TData = unknown
Parameters
action
string
callback
(data) => void
Returns
() => void
reconnect()
reconnect():
void
Defined in: packages/darkws/src/dark-ws.ts:842
Returns
void
request()
request<
TResult,TPayload>(action,payload?,options?):Promise<TResult>
Defined in: packages/darkws/src/dark-ws.ts:803
Type Parameters
TResult
TResult
TPayload
TPayload = unknown
Parameters
action
string
payload?
TPayload
options?
number | DarkWsRequestOptions
Returns
Promise<TResult>
reset()
reset(
full?):void
Defined in: packages/darkws/src/dark-ws.ts:858
Disposes the client, rejecting its pending requests, and re-reads the options on next use.
Subscriptions move to the new client, which connects at once if the old one was started;
full also drops them and leaves the facade idle.
Parameters
full?
boolean = false
Returns
void
send()
send<
T>(data,jsonify?):Promise<void>
Defined in: packages/darkws/src/dark-ws.ts:811
Type Parameters
T
T
Parameters
data
T
jsonify?
boolean = true
Returns
Promise<void>