Class CraiyonOutput

Api

public

Classdesc

Represents a Craiyon response.

Hierarchy

CraiyonOutput

Index

Constructors

Accessors

Methods

asBase64 asBuffers fromJSON

Constructors

constructor

new CraiyonOutput(images: CraiyonImage[], version: string): CraiyonOutput
Parameters
- images: CraiyonImage[]
  
  An array of image objects.
- version: string
  
  The version of the Craiyon model used to generate the images.
Returns CraiyonOutput
- Defined in models/CraiyonOutput.ts:18

Accessors

images

get images(): CraiyonImage[]
Getter for the array of Craiyon image objects.

Returns
The array of Craiyon image objects.

Returns CraiyonImage[]
- Defined in models/CraiyonOutput.ts:58

version

get version(): string
Getter for the version of the Craiyon model used to generate the images.

Returns
The version of the Craiyon model.

Returns string
- Defined in models/CraiyonOutput.ts:67

Methods

asBase64

asBase64(): string[]
Will return the base64 representation of the images in the output.

Returns
An array of base64-encoded images.

Returns string[]
- Defined in models/CraiyonOutput.ts:40

asBuffers

asBuffers(): Buffer[]
Will return an array of buffers containing the images in the output.

Returns
An array of buffers containing the image data.

Returns Buffer[]
- Defined in models/CraiyonOutput.ts:49

`Static` fromJSON

fromJSON(json: any): CraiyonOutput
A factory function that will create a CraiyonOutput instance from the given JSON response.

Returns
The parsed CraiyonOutput instance.
Parameters
- json: any
  
  The JSON response to parse.
Returns CraiyonOutput
- Defined in models/CraiyonOutput.ts:30

Generated using TypeDoc