Class CraiyonImage

Api

public

Classdesc

Represents a single image from a Craiyon image generation output.

Hierarchy

CraiyonImage

Index

Constructors

Methods

asBase64 asBuffer saveToFile saveToFileSync stream

Constructors

constructor

new CraiyonImage(base64: string): CraiyonImage
Parameters
- base64: string
  
  The base64-encoded image data.
Returns CraiyonImage
- Defined in models/CraiyonImage.ts:15

Methods

asBase64

asBase64(): string
Will return the base64 representation of the image.

Returns
The base64-encoded string.

Returns string
- Defined in models/CraiyonImage.ts:24

asBuffer

asBuffer(): Buffer
Will create a buffer from the base64 representation of the image.

Returns
The buffer containing the image data.

Returns Buffer
- Defined in models/CraiyonImage.ts:33

saveToFile

saveToFile(path: string): Promise<void>
Will write the image to the given path asynchronously.
Parameters
- path: string
  
  The path to write the image to.
Returns Promise<void>
- Defined in models/CraiyonImage.ts:42

saveToFileSync

saveToFileSync(path: string): void
Will write the image to the given path synchronously.
Parameters
- path: string
  
  The path to write the image to.
Returns void
- Defined in models/CraiyonImage.ts:51

stream

stream(): ReadStream
Will create a read stream from the image.

Returns
The readable stream.

Returns ReadStream
- Defined in models/CraiyonImage.ts:60

Generated using TypeDoc