Class WebSocketClient

Hierarchy (View Summary)

RestClient<SocketEventMap>
- WebSocketClient

Index

Constructors

constructor

new WebSocketClient(
    baseUrl: string,
    auth: AuthManager,
    appId: string,
    supernetType: SupernetType,
    logger: Logger,
): WebSocketClient
Parameters
- baseUrl: string
- auth: AuthManager
- appId: string
- supernetType: SupernetType
- logger: Logger
Returns WebSocketClient
Overrides RestClient.constructor
- Defined in ApiClient/WebSocketClient/index.ts:23

Properties

`Protected`_auth

_auth: AuthManager

`Protected`_logger

_logger: Logger

appId

appId: string

baseUrl

baseUrl: string

`Protected`listeners

listeners: {
    balanceUpdate?: (data: BalanceData) => void[];
    changeNetwork?: (data: { network: SupernetType }) => void[];
    connected?: (data: ServerConnectData) => void[];
    disconnected?: (data: ServerDisconnectData) => void[];
    jobError?: (data: JobErrorData) => void[];
    jobProgress?: (data: JobProgressData) => void[];
    jobResult?: (data: JobResultData) => void[];
    jobState?: (data: JobStateData) => void[];
    swarmModels?: (data: Record<string, number>) => void[];
} = {}

Type declaration

OptionalbalanceUpdate?: (data: BalanceData) => void[]
WebSocketClient#balanceUpdate - Received balance update
OptionalchangeNetwork?: (data: { network: SupernetType }) => void[]
WebSocketClient#changeNetwork - Default network changed
Optionalconnected?: (data: ServerConnectData) => void[]
WebSocketClient#connected - WebSocket connection opened
Optionaldisconnected?: (data: ServerDisconnectData) => void[]
WebSocketClient#disconnected - WebSocket connection was closed
OptionaljobError?: (data: JobErrorData) => void[]
WebSocketClient#jobError - Job error occurred
OptionaljobProgress?: (data: JobProgressData) => void[]
WebSocketClient#jobProgress - Job progress update
OptionaljobResult?: (data: JobResultData) => void[]
WebSocketClient#jobResult - Job result received
OptionaljobState?: (data: JobStateData) => void[]
WebSocketClient#jobState - Job state changed
OptionalswarmModels?: (data: Record<string, number>) => void[]
WebSocketClient#swarmModels - Received swarm model count

Accessors

auth

get auth(): AuthManager
Returns AuthManager
Inherited from RestClient.auth
- Defined in lib/RestClient.ts:19

isConnected

get isConnected(): boolean
Returns boolean
- Defined in ApiClient/WebSocketClient/index.ts:44

supernetType

get supernetType(): SupernetType
Returns SupernetType
- Defined in ApiClient/WebSocketClient/index.ts:40

Methods

connect

connect(): Promise<void>
Returns Promise<void>
- Defined in ApiClient/WebSocketClient/index.ts:48

disconnect

disconnect(): void
Returns void
- Defined in ApiClient/WebSocketClient/index.ts:78

`Protected`emit

emit<T extends keyof SocketEventMap>(event: T, data: SocketEventMap[T]): void
Dispatch an event to all listeners
Type Parameters
- T extends keyof SocketEventMap
Parameters
- event: T
- data: SocketEventMap[T]
Returns void
Inherited from RestClient.emit
- Defined in lib/TypedEventEmitter.ts:57

get

get<T = JSONValue>(path: string, query?: Record<string, any>): Promise<T>
Type Parameters
- T = JSONValue
Parameters
- path: string
- query: Record<string, any> = {}
Returns Promise<T>
Inherited from RestClient.get
- Defined in lib/RestClient.ts:56

off

off<T extends keyof SocketEventMap>(
event: T,
listener: (data: SocketEventMap[T]) => void,
): void
Remove an event listener
Type Parameters
- T extends keyof SocketEventMap
Parameters
- event: T
- listener: (data: SocketEventMap[T]) => void
Returns void
Inherited from RestClient.off
- Defined in lib/TypedEventEmitter.ts:45

on

on<T extends keyof SocketEventMap>(
event: T,
listener: (data: SocketEventMap[T]) => void,
): () => void
Add an event listener, returns a function that can be called to remove the listener
Type Parameters
- T extends keyof SocketEventMap
Parameters
- event: T
- listener: (data: SocketEventMap[T]) => void
Returns () => void
Inherited from RestClient.on
- Defined in lib/TypedEventEmitter.ts:17

once

once<T extends keyof SocketEventMap>(
event: T,
listener: (data: SocketEventMap[T]) => void,
): () => void
Add an event listener that will be called only once
Type Parameters
- T extends keyof SocketEventMap
Parameters
- event: T
- listener: (data: SocketEventMap[T]) => void
Returns () => void
Inherited from RestClient.once
- Defined in lib/TypedEventEmitter.ts:32

post

post<T = JSONValue>(path: string, body?: Record<string, unknown>): Promise<T>
Type Parameters
- T = JSONValue
Parameters
- path: string
- body: Record<string, unknown> = {}
Returns Promise<T>
Inherited from RestClient.post
- Defined in lib/RestClient.ts:60

send

send<T extends keyof SocketMessageMap>(
messageType: T,
data: SocketMessageMap[T],
): Promise<void>
Type Parameters
- T extends keyof SocketMessageMap
Parameters
- messageType: T
- data: SocketMessageMap[T]
Returns Promise<void>
- Defined in ApiClient/WebSocketClient/index.ts:194

switchNetwork

switchNetwork(supernetType: SupernetType): Promise<SupernetType>
Parameters
- supernetType: SupernetType
Returns Promise<SupernetType>
- Defined in ApiClient/WebSocketClient/index.ts:107

Class WebSocketClient

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WebSocketClient

Properties

Protected_auth

Protected_logger

appId

baseUrl

Protectedlisteners

Type declaration

OptionalbalanceUpdate?: (data: BalanceData) => void[]

OptionalchangeNetwork?: (data: { network: SupernetType }) => void[]

Optionalconnected?: (data: ServerConnectData) => void[]

Optionaldisconnected?: (data: ServerDisconnectData) => void[]

OptionaljobError?: (data: JobErrorData) => void[]

OptionaljobProgress?: (data: JobProgressData) => void[]

OptionaljobResult?: (data: JobResultData) => void[]

OptionaljobState?: (data: JobStateData) => void[]

OptionalswarmModels?: (data: Record<string, number>) => void[]

Accessors

auth

Returns AuthManager

isConnected

Returns boolean

supernetType

Returns SupernetType

Methods

connect

Returns Promise<void>

disconnect

Returns void

Protectedemit

Type Parameters

Parameters

Returns void

get

Type Parameters

Parameters

Returns Promise<T>

off

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

Returns () => void

once

Type Parameters

Parameters

Returns () => void

post

Type Parameters

Parameters

Returns Promise<T>

send

Type Parameters

Parameters

Returns Promise<void>

switchNetwork

Parameters

Returns Promise<SupernetType>

Settings

On This Page

`Protected`_auth

`Protected`_logger

`Protected`listeners

`Optional`balanceUpdate?: (data: BalanceData) => void[]

`Optional`changeNetwork?: (data: { network: SupernetType }) => void[]

`Optional`connected?: (data: ServerConnectData) => void[]

`Optional`disconnected?: (data: ServerDisconnectData) => void[]

`Optional`jobError?: (data: JobErrorData) => void[]

`Optional`jobProgress?: (data: JobProgressData) => void[]

`Optional`jobResult?: (data: JobResultData) => void[]

`Optional`jobState?: (data: JobStateData) => void[]

`Optional`swarmModels?: (data: Record<string, number>) => void[]

`Protected`emit