wasm-vips 0.0.4 → 0.0.5

package/lib/vips.d.ts

@@ -21,6 +21,9 @@ interface EmscriptenModule {
     ): WebAssembly.Exports;
     locateFile(url: string, scriptDirectory: string): string;
     mainScriptUrlOrBlob: Blob | File | string;
+
+    // https://github.com/kleisauke/wasm-vips/issues/12
+    workaroundCors: boolean;
 }
 
 declare module Vips {
@@ -103,9 +106,9 @@ declare module Vips {
     function operationBlock(name: string, state: boolean): void;
 
     /**
-     * Call this to shutdown libvips and the runtime of Emscripten.
-     * This is only needed on Node.js, as the thread pool of
-     * Emscripten prevents the event loop from exiting.
+     * Call this to drop caches, close plugins, terminate background threads, and finalize any internal library testing.
+     * Calling this is optional. If you don't call it, your platform will clean up for you.
+     * The only negative consequences are that the leak checker and the profiler will not work.
      */
     function shutdown(): void;
 
@@ -260,23 +263,6 @@ declare module Vips {
         static files(): number;
     }
 
-    /**
-     * An abstract class for error messages and error handling.
-     */
-    abstract class Error {
-        /**
-         * Get the error buffer as a string.
-         * @return The error buffer as a string.
-         */
-        static buffer(): string;
-
-        /**
-         * Clear and reset the error buffer.
-         * This is typically called after presenting an error to the user.
-         */
-        static clear(): void;
-    }
-
     /**
      * Handy utilities.
      */
@@ -1460,7 +1446,7 @@ declare module Vips {
 
     /**
      * The format used for each band element.
-     * 
+     *
      * Each corresponds to a native C type for the current machine. For example,
      * #VIPS_FORMAT_USHORT is <type>unsigned short</type>.
      */
@@ -1510,11 +1496,11 @@ declare module Vips {
     /**
      * The various Porter-Duff and PDF blend modes. See vips_composite(),
      * for example.
-     * 
+     *
      * The Cairo docs have a nice explanation of all the blend modes:
-     * 
+     *
      * https://www.cairographics.org/operators
-     * 
+     *
      * The non-separable modes are not implemented.
      */
     enum BlendMode {
@@ -1622,11 +1608,11 @@ declare module Vips {
 
     /**
      * How pixels are coded.
-     * 
+     *
      * Normally, pixels are uncoded and can be manipulated as you would expect.
      * However some file formats code pixels for compression, and sometimes it's
      * useful to be able to manipulate images in the coded format.
-     * 
+     *
      * The gaps in the numbering are historical and must be maintained. Allocate
      * new numbers from the end.
      */
@@ -1649,10 +1635,10 @@ declare module Vips {
      * How the values in an image should be interpreted. For example, a
      * three-band float image of type #VIPS_INTERPRETATION_LAB should have its
      * pixels interpreted as coordinates in CIE Lab space.
-     * 
+     *
      * RGB and sRGB are treated in the same way. Use the colourspace functions if
      * you want some other behaviour.
-     * 
+     *
      * The gaps in numbering are historical and must be maintained. Allocate
      * new numbers from the end.
      */
@@ -1738,33 +1724,33 @@ declare module Vips {
     /**
      * See vips_image_pipelinev(). Operations can hint to the VIPS image IO
      * system about the kind of demand geometry they prefer.
-     * 
+     *
      * These demand styles are given below in order of increasing
      * restrictiveness.  When demanding output from a pipeline,
      * vips_image_generate()
      * will use the most restrictive of the styles requested by the operations
      * in the pipeline.
-     * 
+     *
      * #VIPS_DEMAND_STYLE_THINSTRIP --- This operation would like to output strips
      * the width of the image and a few pels high. This is option suitable for
      * point-to-point operations, such as those in the arithmetic package.
-     * 
+     *
      * This option is only efficient for cases where each output pel depends
      * upon the pel in the corresponding position in the input image.
-     * 
+     *
      * #VIPS_DEMAND_STYLE_FATSTRIP --- This operation would like to output strips
      * the width of the image and as high as possible. This option is suitable
      * for area operations which do not violently transform coordinates, such
      * as vips_conv().
-     * 
+     *
      * #VIPS_DEMAND_STYLE_SMALLTILE --- This is the most general demand format.
      * Output is demanded in small (around 100x100 pel) sections. This style works
      * reasonably efficiently, even for bizzare operations like 45 degree rotate.
-     * 
+     *
      * #VIPS_DEMAND_STYLE_ANY --- This image is not being demand-read from a disc
      * file (even indirectly) so any demand style is OK. It's used for things like
      * vips_black() where the pixels are calculated.
-     * 
+     *
      * See also: vips_image_pipelinev().
      */
     enum DemandStyle {
@@ -2007,9 +1993,9 @@ declare module Vips {
     /**
      * The type of access an operation has to supply. See vips_tilecache()
      * and #VipsForeign.
-     * 
+     *
      * @VIPS_ACCESS_RANDOM means requests can come in any order.
-     * 
+     *
      * @VIPS_ACCESS_SEQUENTIAL means requests will be top-to-bottom, but with some
      * amount of buffering behind the read point for small non-local accesses.
      */
@@ -2027,27 +2013,27 @@ declare module Vips {
 
     /**
      * See vips_embed(), vips_conv(), vips_affine() and so on.
-     * 
+     *
      * When the edges of an image are extended, you can specify
      * how you want the extension done.
-     * 
+     *
      * #VIPS_EXTEND_BLACK --- new pixels are black, ie. all bits are zero.
-     * 
+     *
      * #VIPS_EXTEND_COPY --- each new pixel takes the value of the nearest edge
      * pixel
-     * 
+     *
      * #VIPS_EXTEND_REPEAT --- the image is tiled to fill the new area
-     * 
+     *
      * #VIPS_EXTEND_MIRROR --- the image is reflected and tiled to reduce hash
      * edges
-     * 
+     *
      * #VIPS_EXTEND_WHITE --- new pixels are white, ie. all bits are set
-     * 
+     *
      * #VIPS_EXTEND_BACKGROUND --- colour set from the @background property
-     * 
+     *
      * We have to specify the exact value of each enum member since we have to
      * keep these frozen for back compat with vips7.
-     * 
+     *
      * See also: vips_embed().
      */
     enum Extend {
@@ -2121,10 +2107,10 @@ declare module Vips {
 
     /**
      * See vips_flip(), vips_join() and so on.
-     * 
+     *
      * Operations like vips_flip() need to be told whether to flip left-right or
      * top-bottom.
-     * 
+     *
      * See also: vips_flip(), vips_join().
      */
     enum Direction {
@@ -2140,10 +2126,10 @@ declare module Vips {
 
     /**
      * See vips_join() and so on.
-     * 
+     *
      * Operations like vips_join() need to be told whether to align images on the
      * low or high coordinate edge, or centre.
-     * 
+     *
      * See also: vips_join().
      */
     enum Align {
@@ -2165,11 +2151,11 @@ declare module Vips {
      * Pick the algorithm vips uses to decide image "interestingness". This is used
      * by vips_smartcrop(), for example, to decide what parts of the image to
      * keep.
-     * 
+     *
      * #VIPS_INTERESTING_NONE and #VIPS_INTERESTING_LOW mean the same -- the
      * crop is positioned at the top or left. #VIPS_INTERESTING_HIGH positions at
      * the bottom or right.
-     * 
+     *
      * See also: vips_smartcrop().
      */
     enum Interesting {
@@ -2205,9 +2191,9 @@ declare module Vips {
 
     /**
      * See vips_rot() and so on.
-     * 
+     *
      * Fixed rotate angles.
-     * 
+     *
      * See also: vips_rot().
      */
     enum Angle {
@@ -2231,9 +2217,9 @@ declare module Vips {
 
     /**
      * See vips_rot45() and so on.
-     * 
+     *
      * Fixed rotate angles.
-     * 
+     *
      * See also: vips_rot45().
      */
     enum Angle45 {
@@ -2289,10 +2275,35 @@ declare module Vips {
         approximate = 'approximate'
     }
 
+    /**
+     * Sets the word wrapping style for vips_text() when used with a maximum
+     * width.
+     *
+     * See also: vips_text().
+     */
+    enum TextWrap {
+        /**
+         * Wrap at word boundaries
+         */
+        word = 'word',
+        /**
+         * Wrap at character boundaries
+         */
+        char = 'char',
+        /**
+         * Wrap at word boundaries, but fall back to character boundaries if there is not enough space for a full word
+         */
+        word_char = 'word-char',
+        /**
+         * No wrapping
+         */
+        none = 'none'
+    }
+
     /**
      * How sensitive loaders are to errors, from never stop (very insensitive), to
      * stop on the smallest warning (very sensitive).
-     * 
+     *
      * Each one implies the ones before it, so #VIPS_FAIL_ON_ERROR implies
      * #VIPS_FAIL_ON_TRUNCATED.
      */
@@ -2317,14 +2328,17 @@ declare module Vips {
 
     /**
      * The netpbm file format to save as.
-     * 
+     *
      * #VIPS_FOREIGN_PPM_FORMAT_PBM images are single bit.
-     * 
+     *
      * #VIPS_FOREIGN_PPM_FORMAT_PGM images are 8, 16, or 32-bits, one band.
-     * 
+     *
      * #VIPS_FOREIGN_PPM_FORMAT_PPM images are 8, 16, or 32-bits, three bands.
-     * 
+     *
      * #VIPS_FOREIGN_PPM_FORMAT_PFM images are 32-bit float pixels.
+     *
+     * #VIPS_FOREIGN_PPM_FORMAT_PNM images are anymap images -- the image format
+     * is used to pick the saver.
      */
     enum ForeignPpmFormat {
         /**
@@ -2342,7 +2356,11 @@ declare module Vips {
         /**
          * Portable float map
          */
-        pfm = 'pfm'
+        pfm = 'pfm',
+        /**
+         * Portable anymap
+         */
+        pnm = 'pnm'
     }
 
     /**
@@ -2487,13 +2505,13 @@ declare module Vips {
 
     /**
      * The compression types supported by the tiff writer.
-     * 
+     *
      * Use @Q to set the jpeg compression level, default 75.
-     * 
+     *
      * Use @predictor to set the lzw or deflate prediction, default horizontal.
-     * 
+     *
      * Use @lossless to set WEBP lossless compression.
-     * 
+     *
      * Use @level to set webp and zstd compression level.
      */
     enum ForeignTiffCompression {
@@ -2570,7 +2588,7 @@ declare module Vips {
 
     /**
      * The compression format to use inside a HEIF container.
-     * 
+     *
      * This is assumed to use the same numbering as %heif_compression_format.
      */
     enum ForeignHeifCompression {
@@ -2592,10 +2610,38 @@ declare module Vips {
         av1 = 'av1'
     }
 
+    /**
+     * The selected encoder to use.
+     * If libheif hasn't been compiled with the selected encoder,
+     * we will fallback to the default encoder for the compression format.
+     */
+    enum ForeignHeifEncoder {
+        /**
+         * Auto
+         */
+        auto = 'auto',
+        /**
+         * Aom
+         */
+        aom = 'aom',
+        /**
+         * RAV1E
+         */
+        rav1e = 'rav1e',
+        /**
+         * SVT-AV1
+         */
+        svt = 'svt',
+        /**
+         * X265
+         */
+        x265 = 'x265'
+    }
+
     /**
      * Controls whether an operation should upsize, downsize, both up and
      * downsize, or force a size.
-     * 
+     *
      * See also: vips_thumbnail().
      */
     enum Size {
@@ -2689,7 +2735,7 @@ declare module Vips {
 
     /**
      * More like hit-miss, really.
-     * 
+     *
      * See also: vips_morph().
      */
     enum OperationMorphology {
@@ -2705,10 +2751,10 @@ declare module Vips {
 
     /**
      * See vips_draw_image() and so on.
-     * 
+     *
      * Operations like vips_draw_image() need to be told how to combine images
      * from two sources.
-     * 
+     *
      * See also: vips_join().
      */
     enum CombineMode {
@@ -3063,11 +3109,11 @@ declare module Vips {
          */
         static gifload(filename: string, options?: {
             /**
-             * Load this many pages.
+             * Number of pages to load, -1 for all.
              */
             n?: number
             /**
-             * Load this page from the file.
+             * First page to load.
              */
             page?: number
             /**
@@ -3096,11 +3142,11 @@ declare module Vips {
          */
         static gifloadBuffer(buffer: Blob, options?: {
             /**
-             * Load this many pages.
+             * Number of pages to load, -1 for all.
              */
             n?: number
             /**
-             * Load this page from the file.
+             * First page to load.
              */
             page?: number
             /**
@@ -3129,11 +3175,11 @@ declare module Vips {
          */
         static gifloadSource(source: Source, options?: {
             /**
-             * Load this many pages.
+             * Number of pages to load, -1 for all.
              */
             n?: number
             /**
-             * Load this page from the file.
+             * First page to load.
              */
             page?: number
             /**
@@ -3176,11 +3222,11 @@ declare module Vips {
          */
         static heifload(filename: string, options?: {
             /**
-             * Load this page from the file.
+             * First page to load.
              */
             page?: number
             /**
-             * Load this many pages.
+             * Number of pages to load, -1 for all.
              */
             n?: number
             /**
@@ -3217,11 +3263,11 @@ declare module Vips {
          */
         static heifloadBuffer(buffer: Blob, options?: {
             /**
-             * Load this page from the file.
+             * First page to load.
              */
             page?: number
             /**
-             * Load this many pages.
+             * Number of pages to load, -1 for all.
              */
             n?: number
             /**
@@ -3258,11 +3304,11 @@ declare module Vips {
          */
         static heifloadSource(source: Source, options?: {
             /**
-             * Load this page from the file.
+             * First page to load.
              */
             page?: number
             /**
-             * Load this many pages.
+             * Number of pages to load, -1 for all.
              */
             n?: number
             /**
@@ -3614,11 +3660,11 @@ declare module Vips {
              */
             density?: string
             /**
-             * Load this page from the file.
+             * First page to load.
              */
             page?: number
             /**
-             * Load this many pages.
+             * Number of pages to load, -1 for all.
              */
             n?: number
             /**
@@ -3651,11 +3697,11 @@ declare module Vips {
              */
             density?: string
             /**
-             * Load this page from the file.
+             * First page to load.
              */
             page?: number
             /**
-             * Load this many pages.
+             * Number of pages to load, -1 for all.
              */
             n?: number
             /**
@@ -4121,10 +4167,6 @@ declare module Vips {
          * @return Output image.
          */
         static openslideload(filename: string, options?: {
-            /**
-             * Attach all associated images.
-             */
-            attach_associated?: boolean
             /**
              * Load this level from the file.
              */
@@ -4137,6 +4179,14 @@ declare module Vips {
              * Load this associated image.
              */
             associated?: string
+            /**
+             * Attach all associated images.
+             */
+            attach_associated?: boolean
+            /**
+             * Output rgb (not rgba).
+             */
+            rgb?: boolean
             /**
              * Force open via memory.
              */
@@ -4162,10 +4212,6 @@ declare module Vips {
          * @return Output image.
          */
         static openslideloadSource(source: Source, options?: {
-            /**
-             * Attach all associated images.
-             */
-            attach_associated?: boolean
             /**
              * Load this level from the file.
              */
@@ -4178,6 +4224,14 @@ declare module Vips {
              * Load this associated image.
              */
             associated?: string
+            /**
+             * Attach all associated images.
+             */
+            attach_associated?: boolean
+            /**
+             * Output rgb (not rgba).
+             */
+            rgb?: boolean
             /**
              * Force open via memory.
              */
@@ -4204,27 +4258,27 @@ declare module Vips {
          */
         static pdfload(filename: string, options?: {
             /**
-             * Load this page from the file.
+             * First page to load.
              */
             page?: number
             /**
-             * Load this many pages.
+             * Number of pages to load, -1 for all.
              */
             n?: number
             /**
-             * Render at this dpi.
+             * Dpi to render at.
              */
             dpi?: number
             /**
-             * Scale output by this factor.
+             * Factor to scale by.
              */
             scale?: number
             /**
-             * Background value.
+             * Background colour.
              */
             background?: ArrayConstant
             /**
-             * Decrypt with this password.
+             * Password to decrypt with.
              */
             password?: string
             /**
@@ -4253,27 +4307,27 @@ declare module Vips {
          */
         static pdfloadBuffer(buffer: Blob, options?: {
             /**
-             * Load this page from the file.
+             * First page to load.
              */
             page?: number
             /**
-             * Load this many pages.
+             * Number of pages to load, -1 for all.
              */
             n?: number
             /**
-             * Render at this dpi.
+             * Dpi to render at.
              */
             dpi?: number
             /**
-             * Scale output by this factor.
+             * Factor to scale by.
              */
             scale?: number
             /**
-             * Background value.
+             * Background colour.
              */
             background?: ArrayConstant
             /**
-             * Decrypt with this password.
+             * Password to decrypt with.
              */
             password?: string
             /**
@@ -4302,27 +4356,27 @@ declare module Vips {
          */
         static pdfloadSource(source: Source, options?: {
             /**
-             * Load this page from the file.
+             * First page to load.
              */
             page?: number
             /**
-             * Load this many pages.
+             * Number of pages to load, -1 for all.
              */
             n?: number
             /**
-             * Render at this dpi.
+             * Dpi to render at.
              */
             dpi?: number
             /**
-             * Scale output by this factor.
+             * Factor to scale by.
              */
             scale?: number
             /**
-             * Background value.
+             * Background colour.
              */
             background?: ArrayConstant
             /**
-             * Decrypt with this password.
+             * Password to decrypt with.
              */
             password?: string
             /**
@@ -4823,17 +4877,13 @@ declare module Vips {
              */
             align?: Align | Enum
             /**
-             * Enable rgba output.
+             * Justify lines.
              */
-            rgba?: boolean
+            justify?: boolean
             /**
              * Dpi to render at.
              */
             dpi?: number
-            /**
-             * Justify lines.
-             */
-            justify?: boolean
             /**
              * Line spacing.
              */
@@ -4842,6 +4892,14 @@ declare module Vips {
              * Load this font file.
              */
             fontfile?: string
+            /**
+             * Enable rgba output.
+             */
+            rgba?: boolean
+            /**
+             * Wrap lines on word or character boundaries.
+             */
+            wrap?: TextWrap | Enum
             /**
              * Dpi selected by autofit (output).
              */
@@ -5002,15 +5060,15 @@ declare module Vips {
          */
         static tiffload(filename: string, options?: {
             /**
-             * Load this page from the image.
+             * First page to load.
              */
             page?: number
             /**
-             * Select subifd index.
+             * Subifd index.
              */
             subifd?: number
             /**
-             * Load this many pages.
+             * Number of pages to load, -1 for all.
              */
             n?: number
             /**
@@ -5043,15 +5101,15 @@ declare module Vips {
          */
         static tiffloadBuffer(buffer: Blob, options?: {
             /**
-             * Load this page from the image.
+             * First page to load.
              */
             page?: number
             /**
-             * Select subifd index.
+             * Subifd index.
              */
             subifd?: number
             /**
-             * Load this many pages.
+             * Number of pages to load, -1 for all.
              */
             n?: number
             /**
@@ -5084,15 +5142,15 @@ declare module Vips {
          */
         static tiffloadSource(source: Source, options?: {
             /**
-             * Load this page from the image.
+             * First page to load.
              */
             page?: number
             /**
-             * Select subifd index.
+             * Subifd index.
              */
             subifd?: number
             /**
-             * Load this many pages.
+             * Number of pages to load, -1 for all.
              */
             n?: number
             /**
@@ -5223,15 +5281,15 @@ declare module Vips {
          */
         static webpload(filename: string, options?: {
             /**
-             * Load this page from the file.
+             * First page to load.
              */
             page?: number
             /**
-             * Load this many pages.
+             * Number of pages to load, -1 for all.
              */
             n?: number
             /**
-             * Scale factor on load.
+             * Factor to scale by.
              */
             scale?: number
             /**
@@ -5260,15 +5318,15 @@ declare module Vips {
          */
         static webploadBuffer(buffer: Blob, options?: {
             /**
-             * Load this page from the file.
+             * First page to load.
              */
             page?: number
             /**
-             * Load this many pages.
+             * Number of pages to load, -1 for all.
              */
             n?: number
             /**
-             * Scale factor on load.
+             * Factor to scale by.
              */
             scale?: number
             /**
@@ -5297,15 +5355,15 @@ declare module Vips {
          */
         static webploadSource(source: Source, options?: {
             /**
-             * Load this page from the file.
+             * First page to load.
              */
             page?: number
             /**
-             * Load this many pages.
+             * Number of pages to load, -1 for all.
              */
             n?: number
             /**
-             * Scale factor on load.
+             * Factor to scale by.
              */
             scale?: number
             /**
@@ -6558,13 +6616,17 @@ declare module Vips {
              */
             interframe_maxerror?: number
             /**
-             * Reoptimise colour palettes.
+             * Reuse palette from input.
              */
-            reoptimise?: boolean
+            reuse?: boolean
             /**
              * Maximum inter-palette error for palette reusage.
              */
             interpalette_maxerror?: number
+            /**
+             * Generate an interlaced (progressive) gif.
+             */
+            interlace?: boolean
             /**
              * Strip all metadata from image.
              */
@@ -6602,13 +6664,17 @@ declare module Vips {
              */
             interframe_maxerror?: number
             /**
-             * Reoptimise colour palettes.
+             * Reuse palette from input.
              */
-            reoptimise?: boolean
+            reuse?: boolean
             /**
              * Maximum inter-palette error for palette reusage.
              */
             interpalette_maxerror?: number
+            /**
+             * Generate an interlaced (progressive) gif.
+             */
+            interlace?: boolean
             /**
              * Strip all metadata from image.
              */
@@ -6646,13 +6712,17 @@ declare module Vips {
              */
             interframe_maxerror?: number
             /**
-             * Reoptimise colour palettes.
+             * Reuse palette from input.
              */
-            reoptimise?: boolean
+            reuse?: boolean
             /**
              * Maximum inter-palette error for palette reusage.
              */
             interpalette_maxerror?: number
+            /**
+             * Generate an interlaced (progressive) gif.
+             */
+            interlace?: boolean
             /**
              * Strip all metadata from image.
              */
@@ -6741,6 +6811,10 @@ declare module Vips {
              * Select chroma subsample operation mode.
              */
             subsample_mode?: ForeignSubsample | Enum
+            /**
+             * Select encoder to use.
+             */
+            encoder?: ForeignHeifEncoder | Enum
             /**
              * Strip all metadata from image.
              */
@@ -6785,6 +6859,10 @@ declare module Vips {
              * Select chroma subsample operation mode.
              */
             subsample_mode?: ForeignSubsample | Enum
+            /**
+             * Select encoder to use.
+             */
+            encoder?: ForeignHeifEncoder | Enum
             /**
              * Strip all metadata from image.
              */
@@ -6829,6 +6907,10 @@ declare module Vips {
              * Select chroma subsample operation mode.
              */
             subsample_mode?: ForeignSubsample | Enum
+            /**
+             * Select encoder to use.
+             */
+            encoder?: ForeignHeifEncoder | Enum
             /**
              * Strip all metadata from image.
              */
@@ -8910,6 +8992,14 @@ declare module Vips {
              * How to measure interestingness.
              */
             interesting?: Interesting | Enum
+            /**
+             * Horizontal position of attention centre (output).
+             */
+            attention_x?: number | undefined
+            /**
+             * Vertical position of attention centre (output).
+             */
+            attention_y?: number | undefined
         }): Image;
 
         /**
@@ -9442,7 +9532,7 @@ declare module Vips {
         }): void;
 
         /**
-         * Save image to webp file.
+         * Save as webp.
          * @param filename Filename to save to.
          * @param options Optional options.
          */
@@ -9510,7 +9600,7 @@ declare module Vips {
         }): void;
 
         /**
-         * Save image to webp buffer.
+         * Save as webp.
          * @param options Optional options.
          * @return Buffer to save to.
          */
@@ -9578,7 +9668,74 @@ declare module Vips {
         }): Uint8Array;
 
         /**
-         * Save image to webp target.
+         * Save image to webp mime.
+         * @param options Optional options.
+         */
+        webpsaveMime(options?: {
+            /**
+             * Q factor.
+             */
+            Q?: number
+            /**
+             * Enable lossless compression.
+             */
+            lossless?: boolean
+            /**
+             * Preset for lossy compression.
+             */
+            preset?: ForeignWebpPreset | Enum
+            /**
+             * Enable high quality chroma subsampling.
+             */
+            smart_subsample?: boolean
+            /**
+             * Enable preprocessing in lossless mode (uses q).
+             */
+            near_lossless?: boolean
+            /**
+             * Change alpha plane fidelity for lossy compression.
+             */
+            alpha_q?: number
+            /**
+             * Optimise for minimum size.
+             */
+            min_size?: boolean
+            /**
+             * Minimum number of frames between key frames.
+             */
+            kmin?: number
+            /**
+             * Maximum number of frames between key frames.
+             */
+            kmax?: number
+            /**
+             * Level of cpu effort to reduce file size.
+             */
+            effort?: number
+            /**
+             * Icc profile to embed.
+             */
+            profile?: string
+            /**
+             * Allow mixed encoding (might reduce file size).
+             */
+            mixed?: boolean
+            /**
+             * Strip all metadata from image.
+             */
+            strip?: boolean
+            /**
+             * Background value.
+             */
+            background?: ArrayConstant
+            /**
+             * Set page height for multipage save.
+             */
+            page_height?: number
+        }): void;
+
+        /**
+         * Save as webp.
          * @param target Target to save to.
          * @param options Optional options.
          */