Class ComfyUIApiClient

The ComfyUIApiClient class provides a high-level interface for interacting with the ComfyUI API.

Example

const client = new ComfyUIApiClient({
 api_host: "YOUR_API_HOST",
 clientId: "YOUR_CLIENT_ID",
});

const extensions = await client.getEmbeddings();
console.log(extensions);

Hierarchy (view full)

ComfyUIWsClient
- ComfyUIApiClient

Index

Constructors

constructor

new ComfyUIApiClient(config): ComfyUIApiClient
Parameters
- config: Omit<IComfyApiConfig, "WebSocket" | "fetch"> & {
  WebSocket?: any;
  fetch?: any;
  }
Returns ComfyUIApiClient
Overrides ComfyUIWsClient.constructor
- Defined in src/ComfyUIApiClient.ts:31

Properties

WebSocket

WebSocket: {
    CLOSED: 3;
    CLOSING: 2;
    CONNECTING: 0;
    OPEN: 1;
    prototype: WebSocket;
    new (url, protocols?): WebSocket;
}

Type declaration

- new (url, protocols?): WebSocket
- Parameters
  - url: string | URL
  - Optional protocols: string | string[]
  Returns WebSocket
Readonly CLOSED: 3
Readonly CLOSING: 2
Readonly CONNECTING: 0
Readonly OPEN: 1
prototype: WebSocket

`Private` _cached_fn

_cached_fn: CachedFn

`Private` _plugins

_plugins: ClientPlugin[] = ...

`Protected` _polling_interval

_polling_interval: number = 1000

`Protected` _polling_timer

_polling_timer: any = null

api_base

api_base: string

api_host

api_host: string

`Optional` clientId

clientId?: string

closed

closed: boolean = false

events

events: EventEmitter<ComfyUIClientEvents & Record<string & {}, any>, any> = ...

fetch

fetch: {
(input, init?): Promise<Response>;
(input, init?): Promise<Response>;
}

Type declaration

- (input, init?): Promise<Response>
- MDN Reference
  Parameters
  - input: URL | RequestInfo
  - Optional init: RequestInit
  Returns Promise<Response>
- (input, init?): Promise<Response>
- Parameters
  - input: string | URL | Request
  - Optional init: RequestInit
  Returns Promise<Response>

`Optional` socket

socket?: null | WebSocket

`Protected` socket_callbacks

socket_callbacks: Record<string, any> = {}

ssl

ssl: boolean

user

user: string

`Static` DEFAULT_API_BASE

DEFAULT_API_BASE: string = ""

`Static` DEFAULT_API_HOST

DEFAULT_API_HOST: string = "127.0.0.1:8188"

`Static` DEFAULT_USER

DEFAULT_USER: string = ""

`Static` IS_BROWSER

IS_BROWSER: boolean = ...

Accessors

registered

get registered(): (string & {} | (keyof ComfyUIClientEvents))[]
Returns (string & {} | (keyof ComfyUIClientEvents))[]
Inherited from ComfyUIWsClient.registered
- Defined in src/ComfyUIWsClient.ts:68

Methods

_disconnectPolling

_disconnectPolling(): void
Disconnects the polling timer and sets it to null.

Returns void
Inherited from ComfyUIWsClient._disconnectPolling
- Defined in src/ComfyUIWsClient.ts:519

_disconnectSocket

_disconnectSocket(): void
Disconnects the WebSocket connection and cleans up event listeners.

Returns void
This function does not return anything.
Inherited from ComfyUIWsClient._disconnectSocket
- Defined in src/ComfyUIWsClient.ts:497

_enqueue_prompt

_enqueue_prompt(prompt, options?): Promise<{
    node_errors: any;
    number: number;
    prompt_id: string;
}>
Asynchronously enqueues a prompt with optional workflow and random seed.
Parameters
- prompt: Record<string, unknown>
  The prompt to enqueue.
- Optional options: {
  workflow?: Record<string, unknown>;
  }
  The options for enqueueing the prompt.
  - Optional workflow?: Record<string, unknown>
    The workflow for the prompt.
Returns Promise<{
    node_errors: any;
    number: number;
    prompt_id: string;
}>
A promise that resolves with the enqueued prompt response.

Throws
If there is an error in the response.
- Defined in src/ComfyUIApiClient.ts:620

addEventListener

addEventListener<T>(type, callback, options?): (() => void)
Adds an event listener for the specified event type.
Type Parameters
- T extends keyof ComfyUIClientEvents
Parameters
- type: T
  The type of event to listen for.
- callback: ((...args) => void)
  The callback function to be executed when the event is triggered.
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<ComfyUIClientEvents>[Extract<T, keyof ComfyUIClientEvents>]
      Returns void
- Optional options: any
  (Optional) Additional options for the event listener.
Returns (() => void)
A function that removes the event listener when called.
- - (): void
  - Returns void
Inherited from ComfyUIWsClient.addEventListener
- Defined in src/ComfyUIWsClient.ts:201

`Protected` addSocketCallback

addSocketCallback<K>(socket, type, listener, options?): (() => void)
Type Parameters
- K extends keyof WebSocketEventMap
Parameters
- socket: WebSocket
- type: K
- listener: ((this, ev) => any)
  - - (this, ev): any
    - Parameters
      this: WebSocket
      ev: WebSocketEventMap[K]
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns (() => void)
- - (): void
  - Returns void
Inherited from ComfyUIWsClient.addSocketCallback
- Defined in src/ComfyUIWsClient.ts:269

apiHeaders

apiHeaders(options?): HeadersInit
Returns the headers for the API request.
Parameters
- Optional options: RequestInit
  (Optional) Additional options for the request.
Returns HeadersInit
The headers for the API request.
Inherited from ComfyUIWsClient.apiHeaders
- Defined in src/ComfyUIWsClient.ts:95

apiURL

apiURL(route): string
Generates the URL for the API endpoint based on the provided route.
Parameters
- route: string
  The route for the API endpoint.
Returns string
The generated URL for the API endpoint.
Inherited from ComfyUIWsClient.apiURL
- Defined in src/ComfyUIWsClient.ts:115

clearItems

clearItems(type): Promise<void>
Clears the specified list
Parameters
- type: "history" | "queue"
  The type of list to clear, queue or history
Returns Promise<void>
- Defined in src/ComfyUIApiClient.ts:248

close

close(): void
Closes the WebSocket connection and cleans up event listeners

Returns void
Inherited from ComfyUIWsClient.close
- Defined in src/ComfyUIWsClient.ts:432

connect

connect(options?): ComfyUIApiClient
Connects to the WebSocket server by creating a new socket connection.
Parameters
- options: {
      polling?: {
          enabled: boolean;
          interval?: number;
      };
      websocket?: {
          enabled: boolean;
      };
  } = {}
  The options for connecting to the server.
  - Optional polling?: {
    enabled: boolean;
    interval?: number;
    }
    The options for polling.
    - enabled: boolean
    - Optional interval?: number
  - Optional websocket?: {
    enabled: boolean;
    }
    The options for the WebSocket connection.
    - enabled: boolean
Returns ComfyUIApiClient
- The instance of the class.
Inherited from ComfyUIWsClient.connect
- Defined in src/ComfyUIWsClient.ts:454

createUser

createUser(username): Promise<Response>
Creates a new user
Parameters
- username: string
Returns Promise<Response>
The fetch response
- Defined in src/ComfyUIApiClient.ts:279

deleteItem

deleteItem(type, id): Promise<void>
Deletes an item from the specified list
Parameters
- type: "history" | "queue"
  The type of item to delete, queue or history
- id: any
  The id of the item to delete
Returns Promise<void>
- Defined in src/ComfyUIApiClient.ts:240

disconnect

disconnect(): void
Disconnects the WebSocket connection and cleans up event listeners.

Returns void
Inherited from ComfyUIWsClient.disconnect
- Defined in src/ComfyUIWsClient.ts:483

enqueue

enqueue<T>(prompt, options?): Promise<WorkflowOutput<T>>
Enqueues a prompt and waits for the corresponding prompt websocket.
Type Parameters
- T
Parameters
- prompt: Record<string, unknown>
  The prompt to enqueue.
- Optional options: EnqueueOptions<T>
  The options for enqueueing the prompt.
Returns Promise<WorkflowOutput<T>>
A promise that resolves with the prompt result.
- Defined in src/ComfyUIApiClient.ts:708
enqueue(prompt, options?): Promise<WorkflowOutput>
Parameters
- prompt: Record<string, unknown>
- Optional options: EnqueueOptions
Returns Promise<WorkflowOutput>
- Defined in src/ComfyUIApiClient.ts:712

enqueue_polling

enqueue_polling<T>(prompt, options?): Promise<WorkflowOutput<T>>
Asynchronously enqueues a prompt and waits for the corresponding prompt websocket.

This function does not use WebSocket, but uses polling to get the result So if your workflow contains custom ws events, this function will not be able to get these events
Type Parameters
- T
Parameters
- prompt: Record<string, unknown>
  The prompt to enqueue.
- Optional options: EnqueueOptions<T>
  The options for enqueueing the prompt.
Returns Promise<WorkflowOutput<T>>
A promise that resolves with the prompt result.
- Defined in src/ComfyUIApiClient.ts:674
enqueue_polling(prompt, options?): Promise<WorkflowOutput>
Parameters
- prompt: Record<string, unknown>
- Optional options: EnqueueOptions
Returns Promise<WorkflowOutput>
- Defined in src/ComfyUIApiClient.ts:678

fetchApi

fetchApi(route, options?): Promise<Response>
Fetches API data based on the provided route and options.

NOTE: CORS policy: Request header field comfy-user is not allowed by Access-Control-Allow-Headers in preflight response. Please use empty string in browser.
Parameters
- route: string
  The route for the API request.
- Optional options: RequestInit
  (Optional) Additional options for the request.
Returns Promise<Response>
A promise that resolves to the API response.
Inherited from ComfyUIWsClient.fetchApi
- Defined in src/ComfyUIWsClient.ts:171

free

free(params?): Promise<void>
Free up memory by unloading models and freeing memory
Parameters
- Optional params: {
  free_memory?: boolean;
  unload_models?: boolean;
  }
  - Optional free_memory?: boolean
  - Optional unload_models?: boolean
Returns Promise<void>
- Defined in src/ComfyUIApiClient.ts:262

getCNetModels

getCNetModels(): Promise<string[]>
Retrieves the list of model names from the node definitions.

Returns Promise<string[]>
A promise that resolves to an array of strings representing the model names.
- Defined in src/ComfyUIApiClient.ts:412

getEmbeddings

getEmbeddings(): Promise<string[]>
Gets a list of embedding names

Returns Promise<string[]>
An array of script urls to import
- Defined in src/ComfyUIApiClient.ts:71

getExtensions

getExtensions(): Promise<string[]>
Gets a list of extension urls

Returns Promise<string[]>
An array of script urls to import
- Defined in src/ComfyUIApiClient.ts:58

getHistory

getHistory(max_items?): Promise<{
    History: {
        outputs: Record<string, unknown>;
        prompt: [number, string, any, any, any];
        status: {
            completed: boolean;
            messages: any[];
            status_str: string;
        };
    }[];
}>
Gets the prompt execution history
Parameters
- max_items: number = 200
Returns Promise<{
    History: {
        outputs: Record<string, unknown>;
        prompt: [number, string, any, any, any];
        status: {
            completed: boolean;
            messages: any[];
            status_str: string;
        };
    }[];
}>
Prompt history including node outputs
- Defined in src/ComfyUIApiClient.ts:189

getHyperNetworks

getHyperNetworks(): Promise<string[]>
Retrieves the list of hypernetwork names from the node definitions.

Returns Promise<string[]>
A promise that resolves to an array of strings representing the hypernetwork names.
- Defined in src/ComfyUIApiClient.ts:438

getItems

getItems(type): Promise<{
    History: {
        outputs: Record<string, unknown>;
        prompt: [number, string, any, any, any];
        status: {
            completed: boolean;
            messages: any[];
            status_str: string;
        };
    }[];
}>
Loads a list of items (queue or history)
Parameters
- type: "history"
  The type of items to load, queue or history
Returns Promise<{
    History: {
        outputs: Record<string, unknown>;
        prompt: [number, string, any, any, any];
        status: {
            completed: boolean;
            messages: any[];
            status_str: string;
        };
    }[];
}>
The items of the specified type grouped by their status
- Defined in src/ComfyUIApiClient.ts:152
getItems(type): Promise<{
Pending: Record<string, unknown>[];
Running: Record<string, unknown>[];
}>
Parameters
- type: "queue"
Returns Promise<{
Pending: Record<string, unknown>[];
Running: Record<string, unknown>[];
}>
- Defined in src/ComfyUIApiClient.ts:153

getLoRAs

getLoRAs(): Promise<string[]>
Retrieves the list of LoRAs from the node definitions.

Returns Promise<string[]>
A promise that resolves to an array of strings representing the LoRAs.
- Defined in src/ComfyUIApiClient.ts:451

getNodeDefs

getNodeDefs(): Promise<ObjectInfo>
Loads node object definitions for the graph

Returns Promise<ObjectInfo>
The object info for the graph
- Defined in src/ComfyUIApiClient.ts:84

getPromptOutputs

getPromptOutputs(prompt_id): Promise<Record<string, unknown>>
Retrieves the outputs of a prompt with the given ID from the history.
Parameters
- prompt_id: string
  The ID of the prompt to retrieve the outputs for.
Returns Promise<Record<string, unknown>>
A promise that resolves to the outputs of the prompt.

Throws
If the prompt with the given ID is not found in the history or if it failed with a non-"success" status.
- Defined in src/ComfyUIApiClient.ts:503

getPromptResult

getPromptResult<T>(prompt_id, resolver): Promise<WorkflowOutput<T>>
Retrieves the result of a prompt with the given ID, resolved using the provided resolver.
Type Parameters
- T
Parameters
- prompt_id: string
  The ID of the prompt to retrieve the result for.
- resolver: WorkflowOutputResolver<T>
  The resolver to use when resolving the prompt result.
Returns Promise<WorkflowOutput<T>>
A promise that resolves to the result of the prompt.
- Defined in src/ComfyUIApiClient.ts:525
getPromptResult(prompt_id): Promise<WorkflowOutput>
Parameters
- prompt_id: string
Returns Promise<WorkflowOutput>
- Defined in src/ComfyUIApiClient.ts:529

getPromptStatus

getPromptStatus(prompt_id): Promise<{
    done: boolean;
    pending: boolean;
    running: boolean;
}>
Retrieves the status of a prompt based on the provided prompt ID.
Parameters
- prompt_id: string
  The ID of the prompt to check status for.
Returns Promise<{
    done: boolean;
    pending: boolean;
    running: boolean;
}>
Object containing the running, pending, and done status of the prompt.
- Defined in src/ComfyUIApiClient.ts:480

getQueue

getQueue(): Promise<{
Pending: Record<string, unknown>[];
Running: Record<string, unknown>[];
}>
Gets the current state of the queue

Returns Promise<{
Pending: Record<string, unknown>[];
Running: Record<string, unknown>[];
}>
The currently running and queued items
- Defined in src/ComfyUIApiClient.ts:165

getSDModels

getSDModels(): Promise<string[]>
Retrieves the list of model names from the node definitions.

Returns Promise<string[]>
A promise that resolves to an array of strings representing the model names.
- Defined in src/ComfyUIApiClient.ts:399

getSamplers

getSamplers(): Promise<string[]>
Retrieves the list of samplers from the node definitions.

Returns Promise<string[]>
A promise that resolves to an array of strings representing the sampler names.
- Defined in src/ComfyUIApiClient.ts:373

getSchedulers

getSchedulers(): Promise<string[]>
Retrieves the list of schedulers from the node definitions.

Returns Promise<string[]>
A promise that resolves to an array of strings representing the scheduler names.
- Defined in src/ComfyUIApiClient.ts:386

getSetting

getSetting(id): Promise<unknown>
Gets a setting for the current user
Parameters
- id: string
  The id of the setting to fetch
Returns Promise<unknown>
The setting value
- Defined in src/ComfyUIApiClient.ts:302

getSettings

getSettings(): Promise<Record<string, unknown>>
Gets all setting values for the current user

Returns Promise<Record<string, unknown>>
A dictionary of id -> value
- Defined in src/ComfyUIApiClient.ts:293

getSystemStats

getSystemStats(): Promise<SystemStatsRoot>
Gets system & device stats

Returns Promise<SystemStatsRoot>
System stats such as python version, OS, per device info
- Defined in src/ComfyUIApiClient.ts:215

getUpscaleModels

getUpscaleModels(): Promise<string[]>
Retrieves the list of model names from the node definitions for the UpscaleModelLoader node.

Returns Promise<string[]>
A promise that resolves to an array of strings representing the model names.
- Defined in src/ComfyUIApiClient.ts:425

getUserConfig

getUserConfig(): Promise<any>
Gets user configuration data and where data should be stored

Returns Promise<any>
- Defined in src/ComfyUIApiClient.ts:270

getUserData

getUserData(file, options?): Promise<Response>
Gets a user data file for the current user
Parameters
- file: string
  The name of the userdata file to load
- Optional options: RequestInit
Returns Promise<Response>
The fetch response object
- Defined in src/ComfyUIApiClient.ts:337

getVAEs

getVAEs(): Promise<string[]>
Retrieves the list of VAE names from the node definitions.

Returns Promise<string[]>
A promise that resolves to an array of strings representing the VAE names.
- Defined in src/ComfyUIApiClient.ts:464

init

init(): void
Initializes sockets and realtime updates

Returns void
Deprecated
move to client.connect()
Inherited from ComfyUIWsClient.init
- Defined in src/ComfyUIWsClient.ts:424

interrupt

interrupt(): Promise<void>
Interrupts the execution of the running prompt

Returns Promise<void>
- Defined in src/ComfyUIApiClient.ts:255

on

on<T>(type, callback, options?): (() => void)
Adds an event listener for the specified event type.
Type Parameters
- T extends keyof ComfyUIClientEvents
Parameters
- type: T
  The type of event to listen for.
- callback: ((...args) => void)
  The callback function to be executed when the event is triggered.
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<ComfyUIClientEvents>[Extract<T, keyof ComfyUIClientEvents>]
      Returns void
- Optional options: any
  (Optional) Additional options for the event listener.
Returns (() => void)
A function that removes the event listener when called.
- - (): void
  - Returns void
Inherited from ComfyUIWsClient.on
- Defined in src/ComfyUIWsClient.ts:221

on_progress

on_progress(fn, task_id): (() => void)
Listens for progress updates for a specific task.
Parameters
- fn: undefined | ((p) => void)
  The progress callback function.
- task_id: string
  The ID of the task to listen for progress updates.
Returns (() => void)
A function that can be used to remove the progress listener.
- - (): void
  - Returns void
- Defined in src/ComfyUIApiClient.ts:738

once

once<T>(type, callback, options?): (() => void)
Adds an event listener for the specified event type.
Type Parameters
- T extends keyof ComfyUIClientEvents
Parameters
- type: T
  The type of event to listen for.
- callback: ((...args) => void)
  The callback function to be executed when the event is triggered.
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<ComfyUIClientEvents>[Extract<T, keyof ComfyUIClientEvents>]
      Returns void
- Optional options: any
  (Optional) Additional options for the event listener.
Returns (() => void)
A function that removes the event listener when called.
- - (): void
  - Returns void
Inherited from ComfyUIWsClient.once
- Defined in src/ComfyUIWsClient.ts:237

`Private` postApi

postApi(type, body): Promise<void>
Sends a POST request to the API
Parameters
- type: string
  The endpoint to post to
- body: any
  Optional POST data
Returns Promise<void>
- Defined in src/ComfyUIApiClient.ts:225

queuePrompt

queuePrompt(queue_index, options): Promise<QueuePrompt>
Parameters
- queue_index: number
  The index at which to queue the prompt, passing -1 will insert the prompt at the front of the queue
- options: {
  prompt: any;
  workflow: any;
  }
  - prompt: any
    The prompt to queue
  - workflow: any
    This png info to be added to resulting image
Returns Promise<QueuePrompt>
The response from the server
- Defined in src/ComfyUIApiClient.ts:109

`Protected` removeSocketCallbacks

removeSocketCallbacks(): void
Removes all event listeners from the given WebSocket and clears the socket_callbacks object.

Returns void
Inherited from ComfyUIWsClient.removeSocketCallbacks
- Defined in src/ComfyUIWsClient.ts:286

resetCache

resetCache(): void
Clears the node object definitions cache

Returns void
- Defined in src/ComfyUIApiClient.ts:97

runPrompt

runPrompt(prompt, options?): Promise<WorkflowOutput<WorkflowOutput>>
Asynchronously runs a prompt with the provided options.

This function does not use WebSocket, but uses polling to get the result So if your workflow contains custom ws events, this function will not be able to get these events
Parameters
- prompt: Record<string, unknown>
  The prompt to run.
- Optional options: {
  polling_ms?: number;
  workflow?: Record<string, unknown>;
  }
  The options for running the prompt.
  - Optional polling_ms?: number
    The number of milliseconds to polling query prompt result.
  - Optional workflow?: Record<string, unknown>
    The workflow for the prompt, It will be added to the png info of the generated image.
Returns Promise<WorkflowOutput<WorkflowOutput>>
A promise that resolves with the prompt result.

Deprecated
Use enqueue_polling instead
- Defined in src/ComfyUIApiClient.ts:651

storeSetting

storeSetting(id, value): Promise<Response>
Stores a setting for the current user
Parameters
- id: string
  The id of the setting to update
- value: unknown
  The value of the setting
Returns Promise<Response>
- Defined in src/ComfyUIApiClient.ts:324

storeSettings

storeSettings(settings): Promise<Response>
Stores a dictionary of settings for the current user
Parameters
- settings: Record<string, unknown>
  Dictionary of setting id -> value to save
Returns Promise<Response>
- Defined in src/ComfyUIApiClient.ts:311

storeUserData

storeUserData(file, data, options?): Promise<void>
Stores a user data file for the current user
Parameters
- file: string
  The name of the userdata file to save
- data: any
  The data to save to the file
- Optional options: RequestInit & {
  stringify?: boolean;
  throwOnError?: boolean;
  }
Returns Promise<void>
- Defined in src/ComfyUIApiClient.ts:348

use

use(plugin): void
Use a plugin by calling its install method on this instance.
Parameters
- plugin: ClientPlugin
  The plugin to install.
Returns void
- Defined in src/ComfyUIApiClient.ts:49

viewURL

viewURL(filename, subfolder, type): string
Generates a URL for viewing a specific file with the given filename, subfolder, and type.
Parameters
- filename: string
  The name of the file to view.
- subfolder: string
  The subfolder where the file is located.
- type: string
  The type of the file.
Returns string
The URL for viewing the file.
Inherited from ComfyUIWsClient.viewURL
- Defined in src/ComfyUIWsClient.ts:137

waitForPrompt

waitForPrompt(prompt_id, polling_ms?): Promise<void>
Asynchronously waits for the prompt with the provided ID to be done.
Parameters
- prompt_id: string
  The ID of the prompt to wait for.
- Optional polling_ms: number = 1000
  The number of milliseconds to wait between checks.
Returns Promise<void>
- Defined in src/ComfyUIApiClient.ts:560

waitForPromptWebSocket

waitForPromptWebSocket<T>(prompt_id, resolver): Promise<WorkflowOutput<T>>
Asynchronously waits for the prompt with the provided ID to be done, using a WebSocket connection to receive updates.
Type Parameters
- T
Parameters
- prompt_id: string
  The ID of the prompt to wait for.
- resolver: WorkflowOutputResolver<T>
  A function to resolve the output of the prompt.
Returns Promise<WorkflowOutput<T>>
A promise that resolves with the output of the prompt.
- Defined in src/ComfyUIApiClient.ts:576

wsURL

wsURL(): string
Generates the WebSocket URL based on the current API host and SSL configuration.

Returns string
The generated WebSocket URL.
Inherited from ComfyUIWsClient.wsURL
- Defined in src/ComfyUIWsClient.ts:153

`Static` loadImageData

loadImageData(buf): {
image: ArrayBuffer;
mime: any;
}
Parameters
- buf: ArrayBuffer
Returns {
image: ArrayBuffer;
mime: any;
}
- image: ArrayBuffer
- mime: any
Inherited from ComfyUIWsClient.loadImageData
- Defined in src/ComfyUIWsClient.ts:34

Class ComfyUIApiClient

Example

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ComfyUIApiClient

Properties

WebSocket

Type declaration

Parameters

Returns WebSocket

Readonly CLOSED: 3

Readonly CLOSING: 2

Readonly CONNECTING: 0

Readonly OPEN: 1

prototype: WebSocket

Private _cached_fn

Private _plugins

Protected _polling_interval

Protected _polling_timer

api_base

api_host

Optional clientId

closed

events

fetch

Type declaration

Parameters

Returns Promise<Response>

Parameters

Returns Promise<Response>

Optional socket

Protected socket_callbacks

ssl

user

Static DEFAULT_API_BASE

Static DEFAULT_API_HOST

Static DEFAULT_USER

Static IS_BROWSER

Accessors

registered

Returns (string & {} | (keyof ComfyUIClientEvents))[]

Methods

_disconnectPolling

Returns void

_disconnectSocket

Returns void

_enqueue_prompt

Parameters

Optional workflow?: Record<string, unknown>

Returns Promise<{ node_errors: any; number: number; prompt_id: string; }>

Throws

addEventListener

Type Parameters

Parameters

Parameters

Returns void

Returns (() => void)

Returns void

Protected addSocketCallback

Type Parameters

Parameters

Parameters

Returns any

Returns (() => void)

Returns void

apiHeaders

Parameters

Returns HeadersInit

apiURL

Parameters

Returns string

clearItems

Parameters

`Readonly` CLOSED: 3

`Readonly` CLOSING: 2

`Readonly` CONNECTING: 0

`Readonly` OPEN: 1

`Private` _cached_fn

`Private` _plugins

`Protected` _polling_interval

`Protected` _polling_timer

`Optional` clientId

`Optional` socket

`Protected` socket_callbacks

`Static` DEFAULT_API_BASE

`Static` DEFAULT_API_HOST

`Static` DEFAULT_USER

`Static` IS_BROWSER

`Optional` workflow?: Record<string, unknown>

Returns Promise<{
node_errors: any;
number: number;
prompt_id: string;
}>

`Protected` addSocketCallback

`Optional` polling?: {
enabled: boolean;
interval?: number;
}

`Optional` interval?: number

`Optional` websocket?: {
enabled: boolean;
}

`Optional` free_memory?: boolean

`Optional` unload_models?: boolean

Returns Promise<{
History: {
outputs: Record<string, unknown>;
prompt: [number, string, any, any, any];
status: {
completed: boolean;
messages: any[];
status_str: string;
};
}[];
}>

Returns Promise<{
History: {
outputs: Record<string, unknown>;
prompt: [number, string, any, any, any];
status: {
completed: boolean;
messages: any[];
status_str: string;
};
}[];
}>

Returns Promise<{
Pending: Record<string, unknown>[];
Running: Record<string, unknown>[];
}>