Interface ImageOptions

ImageOptions Represents the options for image processing, including format-specific options, resizing, watermark, and more.

interface ImageOptions {
    maxWidth?: number;
    optimize?: boolean;
    resize?: boolean;
    squared?: boolean;
    suffix?: string;
    watermark?: boolean;
    watermarkPosition?: string;
}

Hierarchy

  • JpegOptions
  • PngOptions
  • WebpOptions
  • TiffOptions
  • GifOptions
  • JxlOptions
    • ImageOptions

Properties

maxWidth? optimize? resize? squared? suffix? watermark? watermarkPosition?

Properties

OptionalmaxWidth

maxWidth?: number

The maximum width for the resized image.

Optionaloptimize

optimize?: boolean

Whether to optimize the image (e.g., reduce file size).

Optionalresize

resize?: boolean

Whether to resize the image.

Optionalsquared

squared?: boolean

Whether to square the image (crop to a square aspect ratio).

Optionalsuffix

suffix?: string

A suffix to add to the output filename.

Optionalwatermark

watermark?: boolean

Whether to apply a watermark to the image.

OptionalwatermarkPosition

watermarkPosition?: string

The position of the watermark on the image (e.g., 'center', 'top', 'bottom').

Settings

Member Visibility

On This Page

Properties