Class: DarkWs
Defined in: packages/darkws/src/dark-ws.ts:113
Constructors
Constructor
new DarkWs(
options):DarkWs
Defined in: packages/darkws/src/dark-ws.ts:160
Parameters
options
Returns
DarkWs
Properties
LOG_PREFIX
readonlystaticLOG_PREFIX:"[DarkWs]"="[DarkWs]"
Defined in: packages/darkws/src/dark-ws.ts:114
Accessors
closed
Get Signature
get closed():
boolean
Defined in: packages/darkws/src/dark-ws.ts:196
Returns
boolean
closing
Get Signature
get closing():
boolean
Defined in: packages/darkws/src/dark-ws.ts:192
Returns
boolean
connected
Get Signature
get connected():
boolean
Defined in: packages/darkws/src/dark-ws.ts:200
Returns
boolean
pendingRequestCount
Get Signature
get pendingRequestCount():
number
Defined in: packages/darkws/src/dark-ws.ts:204
Returns
number
Methods
authenticate()
authenticate(
token):Promise<void>
Defined in: packages/darkws/src/dark-ws.ts:361
Parameters
token
string
Returns
Promise<void>
close()
close(
code?):void
Defined in: packages/darkws/src/dark-ws.ts:391
Parameters
code?
number = 1000
Returns
void
connect()
connect():
this
Defined in: packages/darkws/src/dark-ws.ts:213
Returns
this
dispose()
dispose():
void
Defined in: packages/darkws/src/dark-ws.ts:409
Returns
void
isCurrentSocket()
isCurrentSocket(
event):boolean
Defined in: packages/darkws/src/dark-ws.ts:209
Whether the native event belongs to the currently assigned socket, regardless of its ready state.
Parameters
event
Event
Returns
boolean
logout()
logout():
Promise<void>
Defined in: packages/darkws/src/dark-ws.ts:367
Returns
Promise<void>
off()
off<
K>(event,callback):void
Defined in: packages/darkws/src/dark-ws.ts:254
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:246
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:265
Subscribes to one exact broadcast action and returns an unsubscribe function. Omitted data is undefined.
Type Parameters
TData
TData = unknown
Parameters
action
string
callback
(data) => void
Returns
() => void
reconnect()
reconnect():
void
Defined in: packages/darkws/src/dark-ws.ts:233
Returns
void
request()
request<
TResult,TPayload>(action,payload?,options?):Promise<TResult>
Defined in: packages/darkws/src/dark-ws.ts:280
Type Parameters
TResult
TResult
TPayload
TPayload = unknown
Parameters
action
string
payload?
TPayload
options?
number | DarkWsRequestOptions
Returns
Promise<TResult>
send()
send<
T>(data,jsonify?):Promise<void>
Defined in: packages/darkws/src/dark-ws.ts:272
Type Parameters
T
T
Parameters
data
T
jsonify?
boolean = true
Returns
Promise<void>
lazy()
staticlazy(options):LazyDarkWs
Defined in: packages/darkws/src/dark-ws.ts:117
Creates a facade that builds its client on first use and connects it on the first request or subscription.
Parameters
options
DarkWsOptions | (() => DarkWsOptions)