Class StableHordeGeneration

Api

public

Classdesc

A single image generation returned by Stable Horde.

Hierarchy

StableHordeGeneration

Implements

GenericModel

Index

Constructors

Properties

Methods

base64 buffer image save saveSync stream toJSON fromJSON

Constructors

constructor

new StableHordeGeneration(image: string, workerName: string): StableHordeGeneration
Parameters
- image: string
- workerName: string
Returns StableHordeGeneration
- Defined in models/StableHordeGeneration.ts:17

Properties

workerName

workerName: string

The name of the worker that generated this image.

Methods

base64

base64(): string
Will return the original base64-encoded image from Stable Horde.

Returns
A base64-encoded WEBP image.

Returns string
- Defined in models/StableHordeGeneration.ts:56

buffer

buffer(): Buffer
Will return the image as a buffer.

Returns
A buffer containing the WEBP image data.

Returns Buffer
- Defined in models/StableHordeGeneration.ts:47

image

image(): Buffer
An alias to the StableHordeGeneration#buffer method.

Returns
A buffer containing the WEBP image data.

Returns Buffer
- Defined in models/StableHordeGeneration.ts:38

save

save(path: string): Promise<void>
Saves the image to the specified path asynchronously.
Parameters
- path: string
  
  The path to save the image to.
Returns Promise<void>
- Defined in models/StableHordeGeneration.ts:65

saveSync

saveSync(path: string): void
Saves the image to the specified path synchronously.
Parameters
- path: string
  
  The path to save the image to.
Returns void
- Defined in models/StableHordeGeneration.ts:74

stream

stream(): ReadStream
Creates a read stream from the image's buffer.

Returns
A read stream that you can pipe to a write stream.

Returns ReadStream
- Defined in models/StableHordeGeneration.ts:83

toJSON

toJSON(): object
Returns object
Implementation of GenericModel.toJSON
- Defined in models/StableHordeGeneration.ts:22

`Static` fromJSON

fromJSON(data: any): StableHordeGeneration
Parameters
- data: any
Returns StableHordeGeneration
- Defined in models/StableHordeGeneration.ts:29

Generated using TypeDoc