Class BasePipe<CTX>

pipe to create a workflow

Type Parameters

CTX extends PipeContext = PipeContext

Hierarchy (view full)

Disposable
- BasePipe
  - EfficientPipe

Index

Constructors

constructor

Properties

_disposed _disposed_cbs _invoked? _workflow context defaultContext

Constructors

constructor

new BasePipe<CTX>(context?): BasePipe<CTX>
Type Parameters
- CTX extends PipeContext = PipeContext
Parameters
- Optional context: Partial<CTX>
Returns BasePipe<CTX>
Overrides Disposable.constructor
- Defined in src/pipeline/base.ts:46

Properties

`Protected` _disposed

_disposed: boolean = false

`Protected` _disposed_cbs

_disposed_cbs: any[] = ...

`Protected` `Optional` _invoked

_invoked?: Promise<InvokedWorkflow<unknown>>

`Protected` _workflow

_workflow: ComfyUIWorkflow = ...

`Protected` context

context: CTX

`Static` defaultContext

defaultContext: PipeContext = ...

Methods

_connect

_connect(cb): void
Parameters
- cb: (() => void)
  - - (): void
    - Returns void
Returns void
Inherited from Disposable._connect
- Defined in src/Disposable.ts:16

`Protected` _save

_save(filename_prefix?): void
Parameters
- Optional filename_prefix: string
Returns void
- Defined in src/pipeline/base.ts:259

batch_size

batch_size(batch_size): BasePipe<CTX>
Parameters
- batch_size: number
Returns BasePipe<CTX>
- Defined in src/pipeline/base.ts:143

`Protected` build

build(): {
    cls: BuiltinNodeClasses & Record<string, ComfyUINodeClass<NodeClassInputs>>;
    samples: NodeOutput;
    vae: NodeOutput;
}
Returns {
    cls: BuiltinNodeClasses & Record<string, ComfyUINodeClass<NodeClassInputs>>;
    samples: NodeOutput;
    vae: NodeOutput;
}
- cls: BuiltinNodeClasses & Record<string, ComfyUINodeClass<NodeClassInputs>>
- samples: NodeOutput
- vae: NodeOutput
- Defined in src/pipeline/base.ts:225

`Protected` build_latent

build_latent(vae): NodeOutput
Parameters
- vae: any
Returns NodeOutput
- Defined in src/pipeline/base.ts:193

cfg

cfg(cfg): BasePipe<CTX>
Parameters
- cfg: number
Returns BasePipe<CTX>
- Defined in src/pipeline/base.ts:108

denoise

denoise(denoise): BasePipe<CTX>
Parameters
- denoise: number
Returns BasePipe<CTX>
- Defined in src/pipeline/base.ts:122

dispose

dispose(): void
Returns void
Inherited from Disposable.dispose
- Defined in src/Disposable.ts:4

image

image(image): BasePipe<CTX>
Parameters
- image: Buffer
Returns BasePipe<CTX>
- Defined in src/pipeline/base.ts:58

mask

mask(image): BasePipe<CTX>
Parameters
- image: Buffer
Returns BasePipe<CTX>
- Defined in src/pipeline/base.ts:65

model

model(ckpt_name): BasePipe<CTX>
Parameters
- ckpt_name: string
Returns BasePipe<CTX>
- Defined in src/pipeline/base.ts:72

negative

negative(text): BasePipe<CTX>
Parameters
- text: string
Returns BasePipe<CTX>
- Defined in src/pipeline/base.ts:94

on

on<T>(type, callback, options?): BasePipe<CTX>
Adds an event listener for the specified event type.
Type Parameters
- T extends keyof ComfyUIClientEvents
Parameters
- type: T
- callback: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<ComfyUIClientEvents>[Extract<T, keyof ComfyUIClientEvents>]
      Returns void
- Optional options: any
Returns BasePipe<CTX>
- Defined in src/pipeline/base.ts:160

once

once<T>(type, callback, options?): BasePipe<CTX>
Adds an once event listener for the specified event type.
Type Parameters
- T extends keyof ComfyUIClientEvents
Parameters
- type: T
- callback: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<ComfyUIClientEvents>[Extract<T, keyof ComfyUIClientEvents>]
      Returns void
- Optional options: any
Returns BasePipe<CTX>
- Defined in src/pipeline/base.ts:178

prompt

prompt(text): BasePipe<CTX>
Parameters
- text: string
Returns BasePipe<CTX>
- Defined in src/pipeline/base.ts:87

read_response

read_response(res): Promise<{
data: ArrayBuffer;
mime: string;
}[]>
Parameters
- res: WorkflowOutput<unknown>
Returns Promise<{
data: ArrayBuffer;
mime: string;
}[]>
- Defined in src/pipeline/base.ts:275

sampler

sampler(sampler_name): BasePipe<CTX>
Parameters
- sampler_name: "euler" | "euler_cfg_pp" | "euler_ancestral" | "euler_ancestral_cfg_pp" | "heun" | "heunpp2" | "dpm_2" | "dpm_2_ancestral" | "lms" | "dpm_fast" | "dpm_adaptive" | "dpmpp_2s_ancestral" | "dpmpp_sde" | "dpmpp_sde_gpu" | "dpmpp_2m" | "dpmpp_2m_sde" | "dpmpp_2m_sde_gpu" | "dpmpp_3m_sde" | "dpmpp_3m_sde_gpu" | "ddpm" | "lcm" | "ipndm" | "ipndm_v" | "deis" | "ddim" | "uni_pc" | "uni_pc_bh2" | {} & string
Returns BasePipe<CTX>
- Defined in src/pipeline/base.ts:136

save

save(filename_prefix?): BasePipe<CTX>
Parameters
- Optional filename_prefix: string
Returns BasePipe<CTX>
- Defined in src/pipeline/base.ts:305

scheduler

scheduler(scheduler): BasePipe<CTX>
Parameters
- scheduler: "normal" | "karras" | "exponential" | "sgm_uniform" | "simple" | "ddim_uniform" | "beta" | {} & string
Returns BasePipe<CTX>
- Defined in src/pipeline/base.ts:129

seed

seed(seed?): BasePipe<CTX>
Parameters
- seed: number = ...
Returns BasePipe<CTX>
- Defined in src/pipeline/base.ts:115

size

size(w, h): BasePipe<CTX>
Parameters
- w: number
- h: number
Returns BasePipe<CTX>
- Defined in src/pipeline/base.ts:79

steps

steps(steps): BasePipe<CTX>
Parameters
- steps: number
Returns BasePipe<CTX>
- Defined in src/pipeline/base.ts:101

`Protected` update

update(ctx): void
Parameters
- ctx: Record<string, any>
Returns void
- Defined in src/pipeline/base.ts:54

wait

wait(): Promise<{
    images: {
        data: ArrayBuffer;
        mime: string;
    }[];
    result: WorkflowOutput;
}>
Returns Promise<{
    images: {
        data: ArrayBuffer;
        mime: string;
    }[];
    result: WorkflowOutput;
}>
- Defined in src/pipeline/base.ts:323

wait_polling

wait_polling(): Promise<{
    images: {
        data: ArrayBuffer;
        mime: string;
    }[];
    result: WorkflowOutput;
}>
Returns Promise<{
    images: {
        data: ArrayBuffer;
        mime: string;
    }[];
    result: WorkflowOutput;
}>
- Defined in src/pipeline/base.ts:336

with

with(client): BasePipe<CTX>
Parameters
- client: ComfyUIApiClient
Returns BasePipe<CTX>
- Defined in src/pipeline/base.ts:150

`Static` nextSeed

nextSeed(): number
Returns number
- Defined in src/pipeline/base.ts:18

Class BasePipe<CTX>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BasePipe<CTX>

Properties

Protected _disposed

Protected _disposed_cbs

Protected Optional _invoked

Protected _workflow

Protected context

Static defaultContext

Methods

_connect

Parameters

Returns void

Returns void

Protected _save

Parameters

Returns void

batch_size

Parameters

Returns BasePipe<CTX>

Protected build

Returns { cls: BuiltinNodeClasses & Record<string, ComfyUINodeClass<NodeClassInputs>>; samples: NodeOutput; vae: NodeOutput; }

cls: BuiltinNodeClasses & Record<string, ComfyUINodeClass<NodeClassInputs>>

samples: NodeOutput

vae: NodeOutput

Protected build_latent

Parameters

Returns NodeOutput

cfg

Parameters

Returns BasePipe<CTX>

denoise

Parameters

Returns BasePipe<CTX>

dispose

Returns void

image

Parameters

Returns BasePipe<CTX>

mask

Parameters

Returns BasePipe<CTX>

model

Parameters

Returns BasePipe<CTX>

negative

Parameters

Returns BasePipe<CTX>

on

Type Parameters

Parameters

Parameters

Returns void

Returns BasePipe<CTX>

once

Type Parameters

Parameters

Parameters

Returns void

Returns BasePipe<CTX>

prompt

Parameters

Returns BasePipe<CTX>

read_response

Parameters

Returns Promise<{ data: ArrayBuffer; mime: string; }[]>

sampler

Parameters

Returns BasePipe<CTX>

save

`Protected` _disposed

`Protected` _disposed_cbs

`Protected` `Optional` _invoked

`Protected` _workflow

`Protected` context

`Static` defaultContext

`Protected` _save

`Protected` build

Returns {
cls: BuiltinNodeClasses & Record<string, ComfyUINodeClass<NodeClassInputs>>;
samples: NodeOutput;
vae: NodeOutput;
}

`Protected` build_latent

Returns Promise<{
data: ArrayBuffer;
mime: string;
}[]>

`Protected` update

Returns Promise<{
images: {
data: ArrayBuffer;
mime: string;
}[];
result: WorkflowOutput;
}>

Returns Promise<{
images: {
data: ArrayBuffer;
mime: string;
}[];
result: WorkflowOutput;
}>

`Static` nextSeed