Class ControlNetApi

Hierarchy

CachedApi
- ControlNetApi

Index

Constructors

constructor

new ControlNetApi(options): ControlNetApi
Parameters
- options: Pick<CachedApiOptions, "client"> & Partial<Omit<CachedApiOptions, "client">>
Returns ControlNetApi
Inherited from CachedApi.constructor
- Defined in src/api/CachedApi.ts:20

Properties

`Protected` _cache

_cache: Record<string, {
data: any;
expires: number;
}> = ...

Type declaration

data: any
expires: number

`Protected` options

options: CachedApiOptions

Accessors

client

get client(): SDWebUIA1111Client
Returns SDWebUIA1111Client
Overrides CachedApi.client
- Defined in src/api/cnet.ts:71

Methods

`Private` _getControlTypes

_getControlTypes(): Promise<ControlTypes>
Retrieves the control types from the controlnet API.

Returns Promise<ControlTypes>
A promise that resolves to the control types.
- Defined in src/api/cnet.ts:145

`Protected` _getFromCache

_getFromCache<T>(key): Promise<null | T>
Type Parameters
- T
Parameters
- key: string
Returns Promise<null | T>
Inherited from CachedApi._getFromCache
- Defined in src/api/CachedApi.ts:35

`Protected` _getFromCacheOrFetch

_getFromCacheOrFetch<T>(key, fetch): Promise<T>
Type Parameters
- T
Parameters
- key: string
- fetch: (() => Promise<T>)
  - - (): Promise<T>
    - Returns Promise<T>
Returns Promise<T>
Inherited from CachedApi._getFromCacheOrFetch
- Defined in src/api/CachedApi.ts:56

`Private` _getModels

_getModels(): Promise<string[]>
Retrieves a list of models from the controlnet API.

Returns Promise<string[]>
A promise that resolves to an array of model names.
- Defined in src/api/cnet.ts:80

`Private` _getModuleResponse

_getModuleResponse(): Promise<ModuleListResponse>
Retrieves the module list response from the controlnet API.

Returns Promise<ModuleListResponse>
A promise that resolves to the module list response.
- Defined in src/api/cnet.ts:91

`Private` _getVersion

_getVersion(): Promise<number>
Retrieves the version of the controlnet API.

Returns Promise<number>
A promise that resolves to the version number.
- Defined in src/api/cnet.ts:133

`Protected` _setCache

_setCache<T>(key, data): Promise<void>
Type Parameters
- T
Parameters
- key: string
- data: T
Returns Promise<void>
Inherited from CachedApi._setCache
- Defined in src/api/CachedApi.ts:46

clearCache

clearCache(): void
Clears the cache by resetting the _cache object to an empty object.

Returns void
Inherited from CachedApi.clearCache
- Defined in src/api/CachedApi.ts:72

detect

detect(params): Promise<DetectResponse>
Detects objects in an image using the controlnet API.
Parameters
- params: Body_detect_controlnet_detect_post
  The parameters for the detection.
Returns Promise<DetectResponse>
A promise that resolves to the detection response.
- Defined in src/api/cnet.ts:188

getAllModuleDetail

getAllModuleDetail(): Promise<ModuleListResponse>
Retrieves the details of all modules from the cache if caching is enabled, otherwise makes a request to the controlnet API.

Returns Promise<ModuleListResponse>
A promise that resolves to an object containing the details of all modules.
- Defined in src/api/cnet.ts:177

getControlTypes

getControlTypes(): Promise<ControlTypes>
Retrieves the control types from the controlnet API.

Returns Promise<ControlTypes>
A promise that resolves to the control types.
- Defined in src/api/cnet.ts:157

getModels

getModels(): Promise<string[]>
Retrieves a list of models from the controlnet API, caching the result if caching is enabled.

Returns Promise<string[]>
A promise that resolves to an array of model names.
- Defined in src/api/cnet.ts:102

getModuleDetail

getModuleDetail(module): Promise<ModuleListResponse>
Retrieves the detail of a module from the cache if caching is enabled, otherwise makes a request to the controlnet API.
Parameters
- module: string
  The name of the module to retrieve the detail for.
Returns Promise<ModuleListResponse>
A promise that resolves to the module detail.
- Defined in src/api/cnet.ts:123

getModules

getModules(): Promise<ModuleListResponse>
Retrieves a list of modules from the cache if caching is enabled, otherwise makes a request to the controlnet API.

Returns Promise<ModuleListResponse>
A promise that resolves to an array of module names.
- Defined in src/api/cnet.ts:112

getVersion

getVersion(): Promise<number>
Retrieves the version of the controlnet API.

Returns Promise<number>
A promise that resolves to the version number.
- Defined in src/api/cnet.ts:167

img2img

img2img(options): Promise<{
    image: string;
    images: string[];
    info: GenerationResponseInfo;
}>
Asynchronously sends an image to the server for processing and returns the processed image and information.
Parameters
- options: {
  params: Img2imgProcessParams;
  units: ControlNetUnitRequest[];
  }
  The options for the image to image processing.
  - params: Img2imgProcessParams
    The parameters for the image to image processing.
  - units: ControlNetUnitRequest[]
    The control net units for the image to image processing.
Returns Promise<{
    image: string;
    images: string[];
    info: GenerationResponseInfo;
}>
The processed image and information.

Throws
If no image is returned from the server.
- Defined in src/api/cnet.ts:245

img2imgBatch

img2imgBatch(param): Promise<Img2imgBatchGeneration>
Asynchronously creates a batch of image-to-image generations and returns the batch object.
Parameters
- param: {
      options: {
          batchSize: number;
          manual?: boolean;
          numBatches: number;
      };
      params: Img2imgProcessParams;
      units: ControlNetUnitRequest[];
  }
  The parameters for the batch generation.
  - options: {
        batchSize: number;
        manual?: boolean;
        numBatches: number;
    }
    The options for the batch generation.
    - batchSize: number
    - Optional manual?: boolean
    - numBatches: number
  - params: Img2imgProcessParams
    The image processing parameters.
  - units: ControlNetUnitRequest[]
    The control network units for the batch generation.
Returns Promise<Img2imgBatchGeneration>
A promise that resolves to the batch object.
- Defined in src/api/cnet.ts:288

removeCache

removeCache(key): void
Removes a cache entry with the specified key.
Parameters
- key: string
  The key of the cache entry to remove.
Returns void
Inherited from CachedApi.removeCache
- Defined in src/api/CachedApi.ts:81

txt2img

txt2img(options): Promise<{
    image: string;
    images: string[];
    info: GenerationResponseInfo;
}>
Asynchronously sends a text to the server for processing and returns the processed image and information.
Parameters
- options: {
  params: Txt2imgProcessParams;
  units: ControlNetUnitRequest[];
  }
  The options for the text to image processing.
  - params: Txt2imgProcessParams
    The parameters for the text to image processing.
  - units: ControlNetUnitRequest[]
    The control net units for the text to image processing.
Returns Promise<{
    image: string;
    images: string[];
    info: GenerationResponseInfo;
}>
The processed image and information.

Throws
If no image is returned from the server.
- Defined in src/api/cnet.ts:205

txt2imgBatch

txt2imgBatch(options): Promise<Txt2imgBatchGeneration>
Asynchronously sends a text to the server for processing and returns the processed image and information.
Parameters
- options: {
      options: {
          batchSize: number;
          manual?: boolean;
          numBatches: number;
      };
      params: Txt2imgProcessParams;
      units: ControlNetUnitRequest[];
  }
  The options for the text to image processing.
  - options: {
        batchSize: number;
        manual?: boolean;
        numBatches: number;
    }
    The options for the text to image processing.
    - batchSize: number
    - Optional manual?: boolean
    - numBatches: number
  - params: Txt2imgProcessParams
    The parameters for the text to image processing.
  - units: ControlNetUnitRequest[]
    The control net units for the batch generation.
Returns Promise<Txt2imgBatchGeneration>
A promise that resolves to the batch object.
- Defined in src/api/cnet.ts:316

Class ControlNetApi

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ControlNetApi

Properties

Protected _cache

Type declaration

data: any

expires: number

Protected options

Accessors

client

Returns SDWebUIA1111Client

Methods

Private _getControlTypes

Returns Promise<ControlTypes>

Protected _getFromCache

Type Parameters

Parameters

Returns Promise<null | T>

Protected _getFromCacheOrFetch

Type Parameters

Parameters

Returns Promise<T>

Returns Promise<T>

Private _getModels

Returns Promise<string[]>

Private _getModuleResponse

Returns Promise<ModuleListResponse>

Private _getVersion

Returns Promise<number>

Protected _setCache

Type Parameters

Parameters

Returns Promise<void>

clearCache

Returns void

detect

Parameters

Returns Promise<DetectResponse>

getAllModuleDetail

Returns Promise<ModuleListResponse>

getControlTypes

Returns Promise<ControlTypes>

getModels

Returns Promise<string[]>

getModuleDetail

Parameters

Returns Promise<ModuleListResponse>

getModules

Returns Promise<ModuleListResponse>

getVersion

Returns Promise<number>

img2img

Parameters

params: Img2imgProcessParams

units: ControlNetUnitRequest[]

Returns Promise<{ image: string; images: string[]; info: GenerationResponseInfo; }>

Throws

img2imgBatch

Parameters

options: { batchSize: number; manual?: boolean; numBatches: number; }

batchSize: number

Optional manual?: boolean

numBatches: number

params: Img2imgProcessParams

units: ControlNetUnitRequest[]

Returns Promise<Img2imgBatchGeneration>

removeCache

Parameters

Returns void

txt2img

Parameters

`Protected` _cache

`Protected` options

`Private` _getControlTypes

`Protected` _getFromCache

`Protected` _getFromCacheOrFetch

`Private` _getModels

`Private` _getModuleResponse

`Private` _getVersion

`Protected` _setCache

Returns Promise<{
image: string;
images: string[];
info: GenerationResponseInfo;
}>

options: {
batchSize: number;
manual?: boolean;
numBatches: number;
}

`Optional` manual?: boolean

Returns Promise<{
image: string;
images: string[];
info: GenerationResponseInfo;
}>

options: {
batchSize: number;
manual?: boolean;
numBatches: number;
}

`Optional` manual?: boolean