Interface Image

Hierarchy

Image

Index

Properties

width height format?

Methods

toBuffer toImage close

Properties

width

width: number

height

height: number

`Optional` format

format?: ImageFormat

The in raw memory format of this image. Operations of this image may only safely request this format, or a compressed format such as jpg.

Methods

toBuffer

toBuffer(options?: ImageOptions): Promise<Buffer>
Parameters
- Optional options: ImageOptions
Returns Promise<Buffer>

toImage

toImage(options?: ImageOptions): Promise<Image & MediaObject>
Parameters
- Optional options: ImageOptions
Returns Promise<Image & MediaObject>

close

close(): Promise<void>
Returns Promise<void>

Generated using TypeDoc