Documenting methods

web/scripts/api.js

@@ -3,6 +3,9 @@ class ComfyApi extends EventTarget {
 		super();
 	}
 
+	/**
+	 * Poll status  for colab and other things that don't support websockets.
+	 */
 	#pollQueue() {
 		setInterval(async () => {
 			try {
@@ -15,6 +18,10 @@ class ComfyApi extends EventTarget {
 		}, 1000);
 	}
 
+	/**
+	 * Creates and connects a WebSocket for realtime updates
+	 * @param {boolean} isReconnect If the socket is connection is a reconnect attempt
+	 */
 	#createSocket(isReconnect) {
 		if (this.socket) {
 			return;
@@ -74,15 +81,27 @@ class ComfyApi extends EventTarget {
 		});
 	}
 
+	/**
+	 * Initialises sockets and realtime updates
+	 */
 	init() {
 		this.#createSocket();
 	}
 
+	/**
+	 * Loads node object definitions for the graph
+	 * @returns The node definitions
+	 */
 	async getNodeDefs() {
 		const resp = await fetch("object_info", { cache: "no-store" });
 		return await resp.json();
 	}
 
+	/**
+	 *
+	 * @param {number} number The index at which to queue the prompt, passing -1 will insert the prompt at the front of the queue
+	 * @param {object} prompt The prompt data to queue
+	 */
 	async queuePrompt(number, { output, workflow }) {
 		const body = {
 			client_id: this.clientId,
@@ -111,6 +130,11 @@ class ComfyApi extends EventTarget {
 		}
 	}
 
+	/**
+	 * Loads a list of items (queue or history)
+	 * @param {string} type The type of items to load, queue or history
+	 * @returns The items of the specified type grouped by their status
+	 */
 	async getItems(type) {
 		if (type === "queue") {
 			return this.getQueue();
@@ -118,13 +142,20 @@ class ComfyApi extends EventTarget {
 		return this.getHistory();
 	}
 
+	/**
+	 * Gets the current state of the queue
+	 * @returns The currently running and queued items
+	 */
 	async getQueue() {
 		try {
 			const res = await fetch("/queue");
 			const data = await res.json();
 			return {
 				// Running action uses a different endpoint for cancelling
-				Running: data.queue_running.map((prompt) => ({ prompt, remove: { name: "Cancel", cb: () => api.interrupt() } })),
+				Running: data.queue_running.map((prompt) => ({
+					prompt,
+					remove: { name: "Cancel", cb: () => api.interrupt() },
+				})),
 				Pending: data.queue_pending.map((prompt) => ({ prompt })),
 			};
 		} catch (error) {
@@ -133,6 +164,10 @@ class ComfyApi extends EventTarget {
 		}
 	}
 
+	/**
+	 * Gets the prompt execution history
+	 * @returns Prompt history including node outputs
+	 */
 	async getHistory() {
 		try {
 			const res = await fetch("/history");
@@ -143,6 +178,11 @@ class ComfyApi extends EventTarget {
 		}
 	}
 
+	/**
+	 * Sends a POST request to the API
+	 * @param {*} type The endpoint to post to
+	 * @param {*} body Optional POST data
+	 */
 	async #postItem(type, body) {
 		try {
 			await fetch("/" + type, {
@@ -157,14 +197,26 @@ class ComfyApi extends EventTarget {
 		}
 	}
 
+	/**
+	 * Deletes an item from the specified list
+	 * @param {string} type The type of item to delete, queue or history
+	 * @param {number} id The id of the item to delete
+	 */
 	async deleteItem(type, id) {
 		await this.#postItem(type, { delete: [id] });
 	}
 
+	/**
+	 * Clears the specified list
+	 * @param {string} type The type of list to clear, queue or history
+	 */
 	async clearItems(type) {
 		await this.#postItem(type, { clear: true });
 	}
 
+	/**
+	 * Interrupts the execution of the running prompt
+	 */
 	async interrupt() {
 		await this.#postItem("interrupt", null);
 	}