Class EfficientPipe

pipe to create a workflow

required https://github.com/jags111/efficiency-nodes-comfyui

Hierarchy (view full)

BasePipe<EfficientPipeContext>
- EfficientPipe

Index

Constructors

constructor

new EfficientPipe(context?): EfficientPipe
Parameters
- Optional context: Partial<EfficientPipeContext>
Returns EfficientPipe
Overrides BasePipe.constructor
- Defined in packages/client/src/pipeline/efficient.ts:47

Properties

`Protected` _disposed

_disposed: boolean = false

`Protected` _disposed_cbs

_disposed_cbs: any[] = ...

`Protected` `Optional` _invoked

_invoked?: Promise<InvokedWorkflow<unknown>>

`Protected` _workflow

_workflow: Workflow = ...

`Protected` context

context: EfficientPipeContext

`Static` defaultContext

defaultContext: EfficientPipeContext = ...

Methods

_connect

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

`Protected` _save

_save(filename_prefix?): void
Parameters
- Optional filename_prefix: string
Returns void
Inherited from BasePipe._save
- Defined in packages/client/src/pipeline/base.ts:349

batch_size

batch_size(batch_size): EfficientPipe
Updates the context with the provided batch size and returns the current instance of the class for method chaining.
Parameters
- batch_size: number
  The batch size to update the context with.
Returns EfficientPipe
The current instance of the class for method chaining.
Inherited from BasePipe.batch_size
- Defined in packages/client/src/pipeline/base.ts:227

`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
Overrides BasePipe.build
- Defined in packages/client/src/pipeline/efficient.ts:191

`Protected` build_cnet_block

build_cnet_block(__namedParameters, stack): NodeOutput
Parameters
- __namedParameters: {
      end: number;
      image: Buffer<ArrayBufferLike>;
      name: string;
      start: number;
      strength: number;
  }
  - end: number
  - image: Buffer<ArrayBufferLike>
  - name: string
  - start: number
  - strength: number
- stack: any
Returns NodeOutput
- Defined in packages/client/src/pipeline/efficient.ts:149

`Protected` build_cnet_stack

build_cnet_stack(): any
Returns any
- Defined in packages/client/src/pipeline/efficient.ts:179

`Protected` build_latent

build_latent(vae): NodeOutput
Parameters
- vae: any
Returns NodeOutput
Inherited from BasePipe.build_latent
- Defined in packages/client/src/pipeline/base.ts:283

`Protected` build_lora_stack

build_lora_stack(): undefined | NodeOutput
Returns undefined | NodeOutput
- Defined in packages/client/src/pipeline/efficient.ts:116

cfg

cfg(cfg): EfficientPipe
Updates the context with the provided cfg value.
Parameters
- cfg: number
  The cfg value to update the context with.
Returns EfficientPipe
The current instance of the class for method chaining.
Inherited from BasePipe.cfg
- Defined in packages/client/src/pipeline/base.ts:162

cnet

cnet(name, image, options?): EfficientPipe
Adds a control net block to the EfficientPipe context.
Parameters
- name: string
  The name of the control net block.
- image: Buffer<ArrayBufferLike>
  The image data of the control net block.
- options: {
      end?: number;
      start?: number;
      strength?: number;
  } = {}
  Optional configuration for the control net block.
  - Optional end?: number
    The end value of the control net block.
  - Optional start?: number
    The start value of the control net block.
  - Optional strength?: number
    The strength of the control net block.
Returns EfficientPipe
The EfficientPipe instance for chaining.
- Defined in packages/client/src/pipeline/efficient.ts:93

denoise

denoise(denoise): EfficientPipe
Updates the context with the provided denoise value and returns the current instance of the class for method chaining.
Parameters
- denoise: number
  The denoise value to update the context with.
Returns EfficientPipe
The current instance of the class for method chaining.
Inherited from BasePipe.denoise
- Defined in packages/client/src/pipeline/base.ts:188

dispose

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

image

image(image): EfficientPipe
Updates the context with the provided image buffer.
Parameters
- image: Buffer<ArrayBufferLike>
  The image buffer to update the context with.
Returns EfficientPipe
The current instance of the class for method chaining.
Inherited from BasePipe.image
- Defined in packages/client/src/pipeline/base.ts:69

lora

lora(name, options?): EfficientPipe
Adds a LoRA (Low-Rank Adaptation) to the EfficientPipe context.
Parameters
- name: string
  The name of the LoRA.
- options: {
      clip_strength?: number;
      strength?: number;
      weight?: number;
  } = {}
  Optional configuration for the LoRA.
  - Optional clip_strength?: number
    The clip strength of the LoRA.
  - Optional strength?: number
    The strength of the LoRA.
  - Optional weight?: number
    The weight of the LoRA.
Returns EfficientPipe
The EfficientPipe instance for chaining.
- Defined in packages/client/src/pipeline/efficient.ts:65

mask

mask(image): EfficientPipe
Updates the context with the provided mask buffer.
Parameters
- image: Buffer<ArrayBufferLike>
  The mask buffer to update the context with.
Returns EfficientPipe
The current instance of the class for method chaining.
Inherited from BasePipe.mask
- Defined in packages/client/src/pipeline/base.ts:82

model

model(ckpt_name): EfficientPipe
Updates the context with the provided model checkpoint name.
Parameters
- ckpt_name: string
  The name of the model checkpoint to update the context with.
Returns EfficientPipe
The current instance of the class for method chaining.
Inherited from BasePipe.model
- Defined in packages/client/src/pipeline/base.ts:95

negative

negative(text): EfficientPipe
Updates the context with the provided text as the negative prompt.
Parameters
- text: string
  The text to update the context with.
Returns EfficientPipe
The current instance of the class for method chaining.
Inherited from BasePipe.negative
- Defined in packages/client/src/pipeline/base.ts:136

on

on<T>(type, callback, options?): EfficientPipe
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 EfficientPipe
Inherited from BasePipe.on
- Defined in packages/client/src/pipeline/base.ts:250

once

once<T>(type, callback, options?): EfficientPipe
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 EfficientPipe
Inherited from BasePipe.once
- Defined in packages/client/src/pipeline/base.ts:268

prompt

prompt(text): EfficientPipe
Updates the context with the provided text as the positive prompt.
Parameters
- text: string
  The text to update the context with.
Returns EfficientPipe
The current instance of the class for method chaining.
Inherited from BasePipe.prompt
- Defined in packages/client/src/pipeline/base.ts:123

`Protected` read_response

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

sampler

sampler(sampler_name): EfficientPipe
Updates the context with the provided sampler name and returns the current instance of the class for method chaining.
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
  The sampler name to update the context with.
Returns EfficientPipe
The current instance of the class for method chaining.
Inherited from BasePipe.sampler
- Defined in packages/client/src/pipeline/base.ts:214

save

save(filename_prefix?): EfficientPipe
Saves the workflow by invoking the workflow instance and enqueuing it.
Parameters
- Optional filename_prefix: string
  The prefix for the saved filename. if not provided, the workflow will be saved as a websocket connection.
Returns EfficientPipe
- Returns the instance of the class for method chaining.
Throws
- Throws an error if the client is not defined.
Inherited from BasePipe.save
- Defined in packages/client/src/pipeline/base.ts:402

scheduler

scheduler(scheduler): EfficientPipe
Updates the context with the provided scheduler value and returns the current instance of the class for method chaining.
Parameters
- scheduler: "normal" | "karras" | "exponential" | "sgm_uniform" | "simple" | "ddim_uniform" | "beta" | {} & string
  The scheduler value to update the context with.
Returns EfficientPipe
The current instance of the class for method chaining.
Inherited from BasePipe.scheduler
- Defined in packages/client/src/pipeline/base.ts:201

seed

seed(seed?): EfficientPipe
Updates the context with the provided seed value or generates a random seed value if none is provided.
Parameters
- Optional seed: number = ...
  The seed value to update the context with. If not provided, a random seed value will be generated.
Returns EfficientPipe
The current instance of the class for method chaining.
Inherited from BasePipe.seed
- Defined in packages/client/src/pipeline/base.ts:175

size

size(w, h): EfficientPipe
Updates the context with the provided width and height, and returns the current instance of the class for method chaining.
Parameters
- w: number
  The width to update the context with.
- h: number
  The height to update the context with.
Returns EfficientPipe
The current instance of the class for method chaining.
Inherited from BasePipe.size
- Defined in packages/client/src/pipeline/base.ts:109

steps

steps(steps): EfficientPipe
Updates the context with the provided steps and returns the current instance of the class for method chaining.
Parameters
- steps: number
  The number of steps to update the context with.
Returns EfficientPipe
The current instance of the class for method chaining.
Inherited from BasePipe.steps
- Defined in packages/client/src/pipeline/base.ts:149

`Protected` update

update(ctx): void
Parameters
- ctx: Record<string, any>
Returns void
Inherited from BasePipe.update
- Defined in packages/client/src/pipeline/base.ts:59

wait

wait(): Promise<{
    images: {
        data: ArrayBuffer;
        mime: string;
    }[];
    result: WorkflowOutput;
}>
Waits for the workflow to complete and returns the result and the images.

Returns Promise<{
    images: {
        data: ArrayBuffer;
        mime: string;
    }[];
    result: WorkflowOutput;
}>
- A promise that resolves to an object containing the result of the workflow and the images.
Throws
- Throws an error if the workflow has not been invoked.
Inherited from BasePipe.wait
- Defined in packages/client/src/pipeline/base.ts:426

wait_polling

wait_polling(): Promise<{
    images: {
        data: ArrayBuffer;
        mime: string;
    }[];
    result: WorkflowOutput;
}>
Waits for the workflow to complete and returns the result and the images.

*This function does not rely on WebSocket Events, so it maybe will lose events output by WebSocket node

Returns Promise<{
    images: {
        data: ArrayBuffer;
        mime: string;
    }[];
    result: WorkflowOutput;
}>
- A promise that resolves to an object containing the result of the workflow and the images.
Throws
- Throws an error if the workflow has not been invoked.
Inherited from BasePipe.wait_polling
- Defined in packages/client/src/pipeline/base.ts:447

with

with(client): EfficientPipe
Updates the context with the provided client and returns the current instance of the class for method chaining.
Parameters
- client: Client
  The client to update the context with.
Returns EfficientPipe
The current instance of the class for method chaining.
Inherited from BasePipe.with
- Defined in packages/client/src/pipeline/base.ts:240

`Static` nextSeed

nextSeed(): number
Generates a random seed value.

Returns number
A random integer seed value between 0 and 2^32 - 1.
Inherited from BasePipe.nextSeed
- Defined in packages/client/src/pipeline/base.ts:23

Class EfficientPipe

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns EfficientPipe

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 EfficientPipe

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_cnet_block

Parameters

end: number

image: Buffer<ArrayBufferLike>

name: string

start: number

strength: number

Returns NodeOutput

Protected build_cnet_stack

Returns any

Protected build_latent

Parameters

Returns NodeOutput

Protected build_lora_stack

Returns undefined | NodeOutput

cfg

Parameters

Returns EfficientPipe

cnet

Parameters

Optional end?: number

Optional start?: number

Optional strength?: number

Returns EfficientPipe

denoise

Parameters

Returns EfficientPipe

dispose

Returns void

image

Parameters

Returns EfficientPipe

lora

Parameters

Optional clip_strength?: number

Optional strength?: number

Optional weight?: number

Returns EfficientPipe

mask

Parameters

Returns EfficientPipe

model

Parameters

Returns EfficientPipe

negative

Parameters

Returns EfficientPipe

`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_cnet_block

`Protected` build_cnet_stack

`Protected` build_latent

`Protected` build_lora_stack

`Optional` end?: number

`Optional` start?: number

`Optional` strength?: number

`Optional` clip_strength?: number

`Optional` strength?: number

`Optional` weight?: number

`Protected` read_response

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