Interface IWebSocketClient

interface IWebSocketClient {
    _auth: AuthManager;
    _logger: Logger;
    appId: string;
    baseUrl: string;
    isConnected: boolean;
    listeners: {
        artistCancelConfirmation?: (data: ArtistCancelConfirmation) => void[];
        authenticated?: (data: AuthenticatedData) => void[];
        balanceUpdate?: (data: Balances) => void[];
        changeNetwork?: (data: { network: SupernetType }) => void[];
        connected?: (data: ServerConnectData) => void[];
        disconnected?: (data: ServerDisconnectData) => void[];
        jobError?: (data: JobErrorData) => void[];
        jobETA?: (data: JobETAData) => void[];
        jobProgress?: (data: JobProgressData) => void[];
        jobResult?: (data: JobResultData) => void[];
        jobState?: (data: JobStateData) => void[];
        jobTokens?: (data: JobTokensData) => void[];
        llmJobError?: (data: LLMJobErrorData) => void[];
        llmJobResult?: (data: LLMJobResultData) => void[];
        swarmLLMModels?: (data: Record<string, number | LLMModelInfo>) => void[];
        swarmModels?: (data: Record<string, number>) => void[];
        toastMessage?: (data: ToastMessage) => void[];
    };
    supernetType: SupernetType;
    get auth(): AuthManager;
    connect(): Promise<void>;
    disconnect(): void;
    emit<T extends keyof SocketEventMap>(
        event: T,
        data: SocketEventMap[T],
    ): void;
    get<T = JSONValue>(path: string, query?: Record<string, any>): Promise<T>;
    off<T extends keyof SocketEventMap>(
        event: T,
        listener: (data: SocketEventMap[T]) => void,
    ): void;
    on<T extends keyof SocketEventMap>(
        event: T,
        listener: (data: SocketEventMap[T]) => void,
    ): () => void;
    once<T extends keyof SocketEventMap>(
        event: T,
        listener: (data: SocketEventMap[T]) => void,
    ): () => void;
    post<T = JSONValue>(
        path: string,
        body?: Record<string, unknown>,
    ): Promise<T>;
    send<T extends keyof SocketMessageMap>(
        messageType: T,
        data: SocketMessageMap[T],
    ): Promise<void>;
    switchNetwork(supernetType: SupernetType): Promise<SupernetType>;
}

Hierarchy (View Summary)

Properties

_auth _logger appId baseUrl isConnected listeners supernetType

Accessors

auth

Methods

connect disconnect emit get off on once post send switchNetwork

Properties

Protected_auth

_auth: AuthManager

Protected_logger

_logger: Logger

appId

appId: string

baseUrl

baseUrl: string

isConnected

isConnected: boolean

Protectedlisteners

listeners: {
    artistCancelConfirmation?: (data: ArtistCancelConfirmation) => void[];
    authenticated?: (data: AuthenticatedData) => void[];
    balanceUpdate?: (data: Balances) => void[];
    changeNetwork?: (data: { network: SupernetType }) => void[];
    connected?: (data: ServerConnectData) => void[];
    disconnected?: (data: ServerDisconnectData) => void[];
    jobError?: (data: JobErrorData) => void[];
    jobETA?: (data: JobETAData) => void[];
    jobProgress?: (data: JobProgressData) => void[];
    jobResult?: (data: JobResultData) => void[];
    jobState?: (data: JobStateData) => void[];
    jobTokens?: (data: JobTokensData) => void[];
    llmJobError?: (data: LLMJobErrorData) => void[];
    llmJobResult?: (data: LLMJobResultData) => void[];
    swarmLLMModels?: (data: Record<string, number | LLMModelInfo>) => void[];
    swarmModels?: (data: Record<string, number>) => void[];
    toastMessage?: (data: ToastMessage) => void[];
} = {}

Type declaration

  • OptionalartistCancelConfirmation?: (data: ArtistCancelConfirmation) => void[]
  • Optionalauthenticated?: (data: AuthenticatedData) => void[]

    WebSocketClient#authenticated - Received after successful connection to the WebSocket server

  • OptionalbalanceUpdate?: (data: Balances) => 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

  • OptionaljobETA?: (data: JobETAData) => void[]

    WebSocketClient#jobETA - Job ETA update (sent every second during inference by ComfyUI workers) Note: Only available for ComfyUI-based workers during video generation

  • 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

  • OptionaljobTokens?: (data: JobTokensData) => void[]

    WebSocketClient#jobTokens - LLM token stream chunk received Sent by LLM workers during chat completion streaming

  • OptionalllmJobError?: (data: LLMJobErrorData) => void[]

    WebSocketClient#llmJobError - LLM job error

  • OptionalllmJobResult?: (data: LLMJobResultData) => void[]

    WebSocketClient#llmJobResult - LLM job completed with usage data Sent by LLM workers when a chat completion finishes

  • OptionalswarmLLMModels?: (data: Record<string, number | LLMModelInfo>) => void[]

    WebSocketClient#swarmLLMModels - Available LLM models with worker counts

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

    WebSocketClient#swarmModels - Received swarm model count

  • OptionaltoastMessage?: (data: ToastMessage) => void[]

    WebSocketClient#toastMessage - Toast message received

supernetType

supernetType: SupernetType

Accessors

auth

Methods

connect

disconnect

Protectedemit

get

off

on

once

post

send

switchNetwork

Settings

Member Visibility

On This Page

Properties
Accessors
Methods