Class Client

Api

public

Classdesc

An API client for Stable Horde.

Hierarchy

Client

Index

Constructors

Methods

check generateAsync generations newRequestHandler

Constructors

constructor

new Client(options?: StableHordeClientOptions): Client
Parameters
- Optional options: StableHordeClientOptions
  
  The options for the client.
Returns Client
- Defined in api/client.ts:67

Methods

check

check(request?: StableHordeQueuedRequest): Promise<StableHordeRequestStatus>
Checks the status of a given request.

Returns
Request status object.
Parameters
- Optional request: StableHordeQueuedRequest
  
  The request to check.
Returns Promise<StableHordeRequestStatus>
- Defined in api/client.ts:126

generateAsync

generateAsync(prompt?: string, params??: StableHordeRequestParameters): Promise<StableHordeQueuedRequest>
Enqueues an image generation request.

Returns
The queued request.
Parameters
- Optional prompt: string
  
  The prompt to use for the generation.
- Optional params: StableHordeRequestParameters = DEFAULT_PARAMS
  
  The parameters for the generation.
Returns Promise<StableHordeQueuedRequest>
- Defined in api/client.ts:95

generations

generations(request: StableHordeQueuedRequest): Promise<StableHordeGenerations>
Returns the generations of a given request. You may only send this request twice every minute.

Returns
Parameters
- request: StableHordeQueuedRequest
Returns Promise<StableHordeGenerations>
- Defined in api/client.ts:141

newRequestHandler

newRequestHandler(pollingInterval??: number): StableHordeAsyncRequestHandler
Creates an asynchronous request handler for a single request. This request handler will emit events as the request progresses, given a specific polling interval.

Returns
The request handler.
Parameters
- Optional pollingInterval: number = 5000
  
  The polling interval in milliseconds. Defaults to 5000.
Returns StableHordeAsyncRequestHandler
- Defined in api/client.ts:81

Generated using TypeDoc