Class ServiceApi

Hierarchy

CachedApi
- ServiceApi

Index

Constructors

constructor

new ServiceApi(options): ServiceApi
Parameters
- options: Pick<CachedApiOptions, "client"> & Partial<Omit<CachedApiOptions, "client">>
Returns ServiceApi
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
Inherited from CachedApi.client
- Defined in src/api/CachedApi.ts:31

Methods

`Private` _getEmbeddings

_getEmbeddings(): Promise<EmbeddingsResponse>
Retrieves the embeddings from the API.

Returns Promise<EmbeddingsResponse>
A promise that resolves to the response containing the embeddings.
- Defined in src/api/service.ts:133

`Private` _getExtensionList

_getExtensionList(): Promise<ExtensionItem[]>
Retrieves the extension list from the API.

Returns Promise<ExtensionItem[]>
A promise that resolves to the response containing the extension list.
- Defined in src/api/service.ts:153

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

_getSDModels(): Promise<SDModelItem[]>
Retrieves the SD models from the API.

Returns Promise<SDModelItem[]>
A promise that resolves to the response containing the SD models.
- Defined in src/api/service.ts:93

`Private` _getSamplers

_getSamplers(): Promise<SamplerItem[]>
Retrieves the samplers from the API.

Returns Promise<SamplerItem[]>
A promise that resolves to the response containing the samplers.
- Defined in src/api/service.ts:103

`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

getEmbeddings

getEmbeddings(): Promise<EmbeddingsResponse>
Retrieves the embeddings from the API.

Returns Promise<EmbeddingsResponse>
A promise that resolves to the response containing the embeddings.
- Defined in src/api/service.ts:143

getExtensionList

getExtensionList(): Promise<ExtensionItem[]>
Retrieves the extension list from the API.

Returns Promise<ExtensionItem[]>
A promise that resolves to the response containing the extension list.
- Defined in src/api/service.ts:164

getSDModels

getSDModels(): Promise<SDModelItem[]>
Retrieves the SD models from the API.

Returns Promise<SDModelItem[]>
A promise that resolves to the response containing the SD models.
- Defined in src/api/service.ts:113

getSamplers

getSamplers(): Promise<SamplerItem[]>
Retrieves the samplers from the API.

Returns Promise<SamplerItem[]>
A promise that resolves to the response containing the samplers.
- Defined in src/api/service.ts:123

img2img

img2img(requestBody): Promise<{
    image: string;
    images: string[];
    info: GenerationResponseInfo;
}>
Asynchronously sends an image to the server for processing and returns the processed image and information.
Parameters
- requestBody: StableDiffusionProcessingImg2Img
  The image to be processed.
Returns Promise<{
    image: string;
    images: string[];
    info: GenerationResponseInfo;
}>
The processed image and information.
- Defined in src/api/service.ts:198

img2imgBatch

img2imgBatch(body, options): Promise<Img2imgBatchGeneration>
Asynchronously creates a batch of image-to-image generations and returns the batch object.
Parameters
- body: StableDiffusionProcessingImg2Img
  The image to be processed.
- options: {
      batchSize: number;
      manual?: boolean;
      numBatches: number;
  }
  The options for the batch generation.
  - batchSize: number
    The number of images to generate in each batch.
  - Optional manual?: boolean
    Whether to manually run the batch generation.
  - numBatches: number
    The total number of batches to generate.
Returns Promise<Img2imgBatchGeneration>
A promise that resolves to the batch object.
- Defined in src/api/service.ts:244

ping

ping(): Promise<{
    error: undefined;
    success: boolean;
    time: number;
} | {
    error: unknown;
    success: boolean;
    time: number;
}>
Pings the API to check the response time.

Returns Promise<{
    error: undefined;
    success: boolean;
    time: number;
} | {
    error: unknown;
    success: boolean;
    time: number;
}>
An object containing the success status, the response time in milliseconds, and an optional error object if the ping fails.
- Defined in src/api/service.ts:175

progress

progress(params?): Promise<modules__api__models__ProgressResponse>
Asynchronously retrieves the progress of a task.
Parameters
- Optional params: {
  getCurrentImage?: boolean;
  }
  Optional parameters for the progress request.
  - Optional getCurrentImage?: boolean
    Whether to include the current image in the response. Defaults to false.
Returns Promise<modules__api__models__ProgressResponse>
A promise that resolves to the progress response object.
- Defined in src/api/service.ts:283

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(requestBody): Promise<{
    image: string;
    images: string[];
    info: GenerationResponseInfo;
}>
Asynchronously sends a text to the server for processing and returns the processed image and information.
Parameters
- requestBody: StableDiffusionProcessingTxt2Img
  The text to be processed.
Returns Promise<{
    image: string;
    images: string[];
    info: GenerationResponseInfo;
}>
The processed image and information.
- Defined in src/api/service.ts:219

txt2imgBatch

txt2imgBatch(body, options): Promise<Txt2imgBatchGeneration>
Asynchronously creates a batch of text-to-image generations and returns the batch object.
Parameters
- body: StableDiffusionProcessingTxt2Img
  The text to be processed.
- options: {
      batchSize: number;
      manual?: boolean;
      numBatches: number;
  }
  The options for the batch generation.
  - batchSize: number
    The number of images to generate in each batch.
  - Optional manual?: boolean
    Whether to manually run the batch generation.
  - numBatches: number
    The total number of batches to generate.
Returns Promise<Txt2imgBatchGeneration>
A promise that resolves to the batch object.
- Defined in src/api/service.ts:265

watchProgress

watchProgress(options): ProgressWatcher
Asynchronously watches the progress of current task.
Parameters
- options: {
      getCurrentImage?: boolean;
      intervalMs: number;
      manual?: boolean;
  }
  The options for the progress watcher.
  - Optional getCurrentImage?: boolean
    Whether to include the current image in the response. Defaults to false.
  - intervalMs: number
    The interval in milliseconds to check the progress.
  - Optional manual?: boolean
    Whether to manually start the progress watcher.
Returns ProgressWatcher
The progress watcher object.
- Defined in src/api/service.ts:299

Class ServiceApi

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ServiceApi

Properties

Protected _cache

Type declaration

data: any

expires: number

Protected options

Accessors

client

Returns SDWebUIA1111Client

Methods

Private _getEmbeddings

Returns Promise<EmbeddingsResponse>

Private _getExtensionList

Returns Promise<ExtensionItem[]>

Protected _getFromCache

Type Parameters

Parameters

Returns Promise<null | T>

Protected _getFromCacheOrFetch

Type Parameters

Parameters

Returns Promise<T>

Returns Promise<T>

Private _getSDModels

Returns Promise<SDModelItem[]>

Private _getSamplers

Returns Promise<SamplerItem[]>

Protected _setCache

Type Parameters

Parameters

Returns Promise<void>

clearCache

Returns void

getEmbeddings

Returns Promise<EmbeddingsResponse>

getExtensionList

Returns Promise<ExtensionItem[]>

getSDModels

Returns Promise<SDModelItem[]>

getSamplers

Returns Promise<SamplerItem[]>

img2img

Parameters

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

img2imgBatch

Parameters

batchSize: number

Optional manual?: boolean

numBatches: number

Returns Promise<Img2imgBatchGeneration>

ping

Returns Promise<{ error: undefined; success: boolean; time: number; } | { error: unknown; success: boolean; time: number; }>

progress

Parameters

Optional getCurrentImage?: boolean

Returns Promise<modules__api__models__ProgressResponse>

removeCache

Parameters

Returns void

txt2img

Parameters

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

txt2imgBatch

Parameters

batchSize: number

Optional manual?: boolean

numBatches: number

Returns Promise<Txt2imgBatchGeneration>

watchProgress

`Protected` _cache

`Protected` options

`Private` _getEmbeddings

`Private` _getExtensionList

`Protected` _getFromCache

`Protected` _getFromCacheOrFetch

`Private` _getSDModels

`Private` _getSamplers

`Protected` _setCache

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

`Optional` manual?: boolean

Returns Promise<{
error: undefined;
success: boolean;
time: number;
} | {
error: unknown;
success: boolean;
time: number;
}>

`Optional` getCurrentImage?: boolean

Returns Promise<modulesapimodels__ProgressResponse>

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

`Optional` manual?: boolean

`Optional` getCurrentImage?: boolean

`Optional` manual?: boolean