Class Plugin

Protected addHook

• addHook<N, Fn>(hook): void

• Type Parameters

  • N extends keyof Client = keyof Client
  • Fn extends undefined | null | string | boolean | ((plugin) => void) | (() => Promise<string[]>) | (() => Promise<string[]>) | (() => Promise<ObjectInfo>) | (() => void) | ((queue_index, options) => Promise<QueuePrompt>) | {
        (type): Promise<{
            History: {
                outputs: Record<string, unknown>;
                prompt: [number, string, any, any, any];
                status: {
                    completed: boolean;
                    messages: any[];
                    status_str: string;
                };
            }[];
        }>;
        (type): Promise<{
            Pending: Record<string, unknown>[];
            Running: Record<string, unknown>[];
        }>;
    } | (() => Promise<{
        Pending: Record<string, unknown>[];
        Running: Record<string, unknown>[];
    }>) | ((max_items?) => Promise<{
        History: {
            outputs: Record<string, unknown>;
            prompt: [number, string, any, any, any];
            status: {
                completed: boolean;
                messages: any[];
                status_str: string;
            };
        }[];
    }>) | (() => Promise<SystemStatsRoot>) | ((type, id) => Promise<void>) | ((type) => Promise<void>) | (() => Promise<void>) | ((params?) => Promise<void>) | (() => Promise<any>) | ((username) => Promise<Response>) | (() => Promise<Record<string, unknown>>) | ((id) => Promise<unknown>) | ((settings) => Promise<Response>) | ((id, value) => Promise<Response>) | ((file, options?) => Promise<Response>) | ((file, data, options?) => Promise<void>) | (() => Promise<string[]>) | (() => Promise<string[]>) | (() => Promise<string[]>) | (() => Promise<string[]>) | (() => Promise<string[]>) | (() => Promise<string[]>) | (() => Promise<string[]>) | (() => Promise<string[]>) | ((prompt_id) => Promise<{
        done: boolean;
        pending: boolean;
        running: boolean;
    }>) | ((prompt_id) => Promise<Record<string, unknown>>) | {
        <T>(prompt_id, resolver): Promise<WorkflowOutput<T>>;
        (prompt_id): Promise<WorkflowOutput>;
    } | ((prompt_id, polling_ms?) => Promise<void>) | (<T>(prompt_id, resolver) => Promise<WorkflowOutput<T>>) | ((prompt, options?) => Promise<{
        node_errors: any;
        number: number;
        prompt_id: string;
    }>) | ((prompt, options?) => Promise<WorkflowOutput<WorkflowOutput>>) | {
        <T>(prompt, options?): Promise<WorkflowOutput<T>>;
        (prompt, options?): Promise<WorkflowOutput>;
    } | {
        <T>(prompt, options?): Promise<WorkflowOutput<T>>;
        (prompt, options?): Promise<WorkflowOutput>;
    } | ((fn, task_id) => (() => void)) | WebSocket | {
        CLOSED: 3;
        CLOSING: 2;
        CONNECTING: 0;
        OPEN: 1;
        prototype: WebSocket;
        new (url, protocols?): WebSocket;
    } | {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    } | EventEmitter<ComfyUIClientEvents & Record<string & {}, any>, any> | (string & {} | (keyof ComfyUIClientEvents))[] | ((options?) => HeadersInit) | ((route) => string) | ((filename, subfolder, type) => string) | (() => string) | ((route, options?) => Promise<Response>) | (<T>(type, callback, options?) => (() => void)) | (<T>(type, callback, options?) => (() => void)) | (<T>(type, callback, options?) => (() => void)) | (() => void) | (() => void) | ((options?) => Promise<unknown>) | (() => void) | (() => void) | (() => void) = Client[N]

  Parameters

  • hook: FnHook<N, Fn>

  Returns void