Class ApiClient

Hierarchy (View Summary)

TypedEventEmitter<ApiClientEvents>
- ApiClient

Index

Constructors

Properties

appId listeners logger

Accessors

auth isAuthenticated rest socket

Methods

authenticate emit handleSocketConnect handleSocketDisconnect off on once removeAuth

Constructors

constructor

new ApiClient(
    baseUrl: string,
    socketUrl: string,
    appId: string,
    networkType: SupernetType,
    logger: Logger,
): ApiClient
Parameters
- baseUrl: string
- socketUrl: string
- appId: string
- networkType: SupernetType
- logger: Logger
Returns ApiClient
Overrides TypedEventEmitter.constructor
- Defined in ApiClient/index.ts:53

Properties

`Readonly`appId

appId: string

`Protected`listeners

listeners: {
connected?: (data: { network: SupernetType }) => void[];
disconnected?: (data: { code: ErrorCode; reason: string }) => void[];
} = {}

Type declaration

Optionalconnected?: (data: { network: SupernetType }) => void[]
ApiClient#connected - The client has been connected to the server.
Optionaldisconnected?: (data: { code: ErrorCode; reason: string }) => void[]
ApiClient#disconnected - The client has been disconnected by the server, either authentication is lost or the server is unreachable.This event is not triggered when the client manually disconnects.

`Readonly`logger

logger: Logger

Accessors

auth

get auth(): null | { expiresAt: Date; token: string; walletAddress: string }
Returns null | { expiresAt: Date; token: string; walletAddress: string }
- Defined in ApiClient/index.ts:73

isAuthenticated

get isAuthenticated(): boolean
Returns boolean
- Defined in ApiClient/index.ts:69

rest

get rest(): RestClient<never>
Returns RestClient<never>
- Defined in ApiClient/index.ts:81

socket

get socket(): WebSocketClient
Returns WebSocketClient
- Defined in ApiClient/index.ts:77

Methods

authenticate

authenticate(token: string): void
Parameters
- token: string
Returns void
- Defined in ApiClient/index.ts:85

`Protected`emit

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

handleSocketConnect

handleSocketConnect(__namedParameters: ServerConnectData): void
Parameters
- __namedParameters: ServerConnectData
Returns void
- Defined in ApiClient/index.ts:102

handleSocketDisconnect

handleSocketDisconnect(data: ServerDisconnectData): void
Parameters
- data: ServerDisconnectData
Returns void
- Defined in ApiClient/index.ts:107

off

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

on

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

once

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

removeAuth

removeAuth(): void
Returns void
- Defined in ApiClient/index.ts:97