Class: DarkWs
Defined in: packages/darkws/src/dark-ws.ts:77
Constructors
Constructor
new DarkWs(
options):DarkWs
Defined in: packages/darkws/src/dark-ws.ts:105
Parameters
options
Returns
DarkWs
Properties
LOG_PREFIX
readonlystaticLOG_PREFIX:"[DarkWs]"="[DarkWs]"
Defined in: packages/darkws/src/dark-ws.ts:78
Accessors
closed
Get Signature
get closed():
boolean
Defined in: packages/darkws/src/dark-ws.ts:121
Returns
boolean
closing
Get Signature
get closing():
boolean
Defined in: packages/darkws/src/dark-ws.ts:117
Returns
boolean
connected
Get Signature
get connected():
boolean
Defined in: packages/darkws/src/dark-ws.ts:125
Returns
boolean
pendingRequestCount
Get Signature
get pendingRequestCount():
number
Defined in: packages/darkws/src/dark-ws.ts:129
Returns
number
Methods
authenticate()
authenticate(
token):Promise<void>
Defined in: packages/darkws/src/dark-ws.ts:208
Parameters
token
string
Returns
Promise<void>
close()
close(
code?):void
Defined in: packages/darkws/src/dark-ws.ts:233
Parameters
code?
number = 1000
Returns
void
connect()
connect():
this
Defined in: packages/darkws/src/dark-ws.ts:133
Returns
this
dispose()
dispose():
void
Defined in: packages/darkws/src/dark-ws.ts:244
Returns
void
logout()
logout():
Promise<void>
Defined in: packages/darkws/src/dark-ws.ts:212
Returns
Promise<void>
off()
off<
K>(event,callback):void
Defined in: packages/darkws/src/dark-ws.ts:167
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:159
Type Parameters
K
K extends keyof DarkWsEvents
Parameters
event
K
callback
(...args) => void
Returns
() => void
reconnect()
reconnect():
void
Defined in: packages/darkws/src/dark-ws.ts:146
Returns
void
request()
request<
TResult,TPayload>(action,payload?,timeoutMs?):Promise<TResult>
Defined in: packages/darkws/src/dark-ws.ts:185
Type Parameters
TResult
TResult
TPayload
TPayload = unknown
Parameters
action
string
payload?
TPayload
timeoutMs?
number
Returns
Promise<TResult>
send()
send<
T>(data,jsonify?):Promise<void>
Defined in: packages/darkws/src/dark-ws.ts:177
Type Parameters
T
T
Parameters
data
T
jsonify?
boolean = true
Returns
Promise<void>