DefinitelyTyped/types/imagemin-webp/index.d.ts

// Type definitions for imagemin-webp 5.1
// Project: https://github.com/imagemin/imagemin-webp#readme
// Definitions by: Brett M <https://github.com/brettm12345>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

import { Plugin } from 'imagemin';

declare function imageminWebp(options?: imageminWebp.Options): Plugin;

declare namespace imageminWebp {
    type Preset = 'default' | 'photo' | 'picture' | 'drawing' | 'icon' | 'text';
    interface Resize {
        width: number;
        height: number;
    }

    interface Crop extends Resize {
        x: number;
        y: number;
    }

    type Metadata = 'all' | 'none' | 'exif' | 'icc' | 'xmp';

    interface Options {
        /**
         * Preset setting.
         * @default default
         */
        preset?: Preset;
        /**
         * Set quality factor between 0 and 100.
         * @default 75
         */
        quality?: number;
        /**
         * Set transparency-compression quality between 0 and 100.
         * @default 100
         */
        alphaQuality?: number;
        /**
         * Specify the compression method to use,
         * between 0 (fastest) and 6 (slowest).
         * This parameter controls the trade off between encoding speed
         * and the compressed file size and quality.
         * @default 4
         */
        method?: number;
        /**
         * Set target size in bytes.
         */
        size?: number;
        /**
         * Set the amplitude of spatial noise shaping between 0 and 100.
         * @default 80
         */
        sns?: number;
        /**
         * Set deblocking filter strength between 0 (off) and 100.
         */
        filter?: number;
        /**
         * Adjust filter strength automatically.
         * @default false
         */
        autoFilter?: boolean;
        /**
         * Set filter sharpness between 0 (sharpest) and 7 (least sharp).
         * @default 0
         */
        sharpness?: number;
        /**
         * Encode images losslessly.
         * @default false
         */
        lossless?: boolean;
        /**
         * Encode losslessly with an additional lossy pre-processing step,
         * with a quality factor between
         * 0 (maximum pre-processing) and 100 (same as lossless).
         * @default 100
         */
        nearLossless?: number;
        /**
         * Crop the image.
         */
        crop?: Crop;
        /**
         * Resize the image. Happens after crop.
         */
        resize?: Resize;
        /**
         * A list of metadata to copy from the input to the output if present.
         */
        metadata?: Metadata | Metadata[];
        /**
         * Buffer to optimize.
         */
        buffer?: Buffer;
    }
}

export = imageminWebp;