wasm-vips 0.0.2 → 0.0.3

package/lib/vips.d.ts

@@ -1,16 +1,45 @@
-declare namespace vips {
+declare function Vips(config?: Partial<EmscriptenModule>): Promise<NonNullable<typeof Vips>>;
 
+type ModuleCallback = { (module?: any): void };
+
+interface EmscriptenModule {
+    print(str: string): void;
+    printErr(str: string): void;
+
+    preInit: ModuleCallback | ModuleCallback[];
+    preRun: ModuleCallback | ModuleCallback[];
+    postRun: ModuleCallback | ModuleCallback[];
+
+    onAbort: { (what: any): void };
+    onRuntimeInitialized: { (): void };
+
+    instantiateWasm(
+        imports: WebAssembly.Imports,
+        successCallback: (instance: WebAssembly.Instance, module: WebAssembly.Module) => void
+    ): WebAssembly.Exports;
+    locateFile(url: string, scriptDirectory: string): string;
+    mainScriptUrlOrBlob: Blob | File | string;
+}
+
+declare module Vips {
     // Allow single pixels/images as input.
-    type Array<T> = T | T[];
+    type SingleOrArray<T> = T | T[];
 
     type Enum = string | number;
     type Flag = string | number;
     type Blob = string | ArrayBuffer | Uint8Array | Uint8ClampedArray | Int8Array;
-    type ArrayConstant = Array<number>;
-    type ArrayImage = Array<Image> | Vector<Image>;
+    type ArrayConstant = SingleOrArray<number>;
+    type ArrayImage = SingleOrArray<Image> | Vector<Image>;
+    type DeletionFuncs<T extends EmbindClassHandle<T>> = EmbindClassHandle<T>[];
 
     //#region Utility functions
 
+    /**
+     * Queue of handles to be deleted.
+     * This is filled when [[deleteLater]] is called on the handle.
+     */
+    const deletionQueue: DeletionFuncs<Image | Connection | Interpolate>;
+
     /**
      * Get the major, minor or patch version number of the libvips library.
      * When the flag is omitted, the entire version number is returned as a string.
@@ -46,14 +75,57 @@ declare namespace vips {
      */
     function shutdown(): void;
 
+    /**
+     * Convert a bigint value (usually coming from Wasm->JS call) into an int53 JS Number.
+     * This is used when we have an incoming i64 that we know is a pointer or size_t and
+     * is expected to be withing the int53 range.
+     * @return The converted bigint value or NaN if the incoming bigint is outside the range.
+     */
+    function bigintToI53Checked(num: bigint): number;
+
     //#endregion
 
     //#region APIs
 
+    /**
+     * Embind adds the following methods to all its exposed classes.
+     */
+    abstract class EmbindClassHandle<T extends EmbindClassHandle<T>> {
+        /**
+         * Returns a new handle. It must eventually also be disposed with [[delete]] or
+         * [[deleteLater]].
+         * @return A new handle.
+         */
+        clone(): T;
+
+        /**
+         * Signal that a C++ object is no longer needed and can be deleted.
+         */
+        delete(): void;
+
+        /**
+         * Signal that a C++ object is no longer needed and can be deleted later.
+         */
+        deleteLater(): void;
+
+        /**
+         * Check whether two Embind handles point to the same underlying object.
+         * @param other Embind handle for comparison.
+         * @return `true` if the handles point to the same underlying object.
+         */
+        isAliasOf(other: any): boolean;
+
+        /**
+         * Check whether this handle is deleted.
+         * @return `true` if this handle is deleted.
+         */
+        isDeleted(): boolean;
+    }
+
     /**
      * A sequence container representing an array that can change in size.
      */
-    export interface Vector<T> {
+    interface Vector<T> extends EmbindClassHandle<Vector<T>> {
         /**
          * Adds a new element at the end of the vector, after its current last element.
          * @param val The value to be appended at the end of the container.
@@ -90,9 +162,9 @@ declare namespace vips {
     }
 
     /**
-     * A class around libvips' operation cache.
+     * An abstract class around libvips' operation cache.
      */
-    export class Cache {
+    abstract class Cache {
         /**
          * Gets or, when a parameter is provided, sets the maximum number of operations libvips keeps in cache.
          * @param max Maximum number of operations.
@@ -122,11 +194,11 @@ declare namespace vips {
     }
 
     /**
-     * A class that provides the statistics of memory usage and opened files.
+     * An abstract class that provides the statistics of memory usage and opened files.
      * libvips watches the total amount of live tracked memory and
      * uses this information to decide when to trim caches.
      */
-    export class Stats {
+    abstract class Stats {
         /**
          * Get the number of active allocations.
          * @return The number of active allocations.
@@ -155,9 +227,9 @@ declare namespace vips {
     }
 
     /**
-     * A class for error messages and error handling.
+     * An abstract class for error messages and error handling.
      */
-    export class Error {
+    abstract class Error {
         /**
          * Get the error buffer as a string.
          * @return The error buffer as a string.
@@ -174,7 +246,7 @@ declare namespace vips {
     /**
      * Handy utilities.
      */
-    export class Utils {
+    abstract class Utils {
         /**
          * Get the GType for a name.
          * Looks up the GType for a nickname. Types below basename in the type hierarchy are searched.
@@ -195,7 +267,7 @@ declare namespace vips {
     /**
      * The abstract base Connection class.
      */
-    export class Connection {
+    abstract class Connection extends EmbindClassHandle<Connection> {
         /**
          * Get the filename associated with a connection.
          */
@@ -210,7 +282,7 @@ declare namespace vips {
     /**
      * An input connection.
      */
-    export class Source extends Connection {
+    class Source extends Connection {
         /**
          * Make a new source from a file.
          *
@@ -242,14 +314,14 @@ declare namespace vips {
     /**
      * A source that can be attached to callbacks to implement behavior.
      */
-    export class SourceCustom extends Source {
+    class SourceCustom extends Source {
         /**
          * Attach a read handler.
          * @param ptr A pointer to an array of bytes where the read content is stored.
          * @param size The maximum number of bytes to be read.
          * @return The total number of bytes read into the buffer.
          */
-        onRead: (ptr: number, size: number) => number;
+        onRead: (ptr: number, size: bigint) => bigint;
 
         /**
          * Attach a seek handler.
@@ -259,13 +331,13 @@ declare namespace vips {
          * @param size A value indicating the reference point used to obtain the new position.
          * @return The new position within the current source.
          */
-        onSeek: (offset: number, whence: number) => number;
+        onSeek: (offset: bigint, whence: number) => bigint;
     }
 
     /**
      * An output connection.
      */
-    export class Target extends Connection {
+    class Target extends Connection {
         /**
          * Make a new target to write to a file.
          *
@@ -305,28 +377,48 @@ declare namespace vips {
     /**
      * A target that can be attached to callbacks to implement behavior.
      */
-    export class TargetCustom extends Target {
+    class TargetCustom extends Target {
         /**
          * Attach a write handler.
          * @param ptr A pointer to an array of bytes which will be written to.
          * @param length The number of bytes to write.
          * @return The number of bytes that were written.
          */
-        onWrite: (ptr: number, size: number) => number;
+        onWrite: (ptr: number, size: bigint) => bigint;
+
+        /* libtiff needs to be able to seek and read on targets, unfortunately.
+         */
+
+        /**
+         * Attach a read handler.
+         * @param ptr A pointer to an array of bytes where the read content is stored.
+         * @param size The maximum number of bytes to be read.
+         * @return The total number of bytes read from the target.
+         */
+        onRead: (ptr: number, size: bigint) => bigint;
 
         /**
-         * Attach a finish handler.
+         * Attach a seek handler.
+         * @param offset A byte offset relative to the whence parameter.
+         * @param size A value indicating the reference point used to obtain the new position.
+         * @return The new position within the current target.
+         */
+        onSeek: (offset: bigint, whence: number) => bigint;
+
+        /**
+         * Attach an end handler.
          * This optional handler is called at the end of write. It should do any
          * cleaning up, if necessary.
+         * @return 0 on success, -1 on error.
          */
-        onFinish: () => void;
+        onEnd: () => number;
     }
 
     /**
      * A class to build various interpolators.
      * For e.g. nearest, bilinear, and some non-linear.
      */
-    export class Interpolate {
+    class Interpolate extends EmbindClassHandle<Interpolate> {
         /**
          * Look up an interpolator from a nickname and make one.
          * @param nickname Nickname for interpolator.
@@ -338,7 +430,7 @@ declare namespace vips {
     /**
      * An image class.
      */
-    export class Image extends ImageAutoGen {
+    class Image extends ImageAutoGen {
         /**
          * Image width in pixels.
          */
@@ -456,13 +548,14 @@ declare namespace vips {
              */
             memory?: boolean
             /**
-             * Hint the expected access pattern for the image
+             * Hint the expected access pattern for the image.
              */
             access?: Access | Enum
             /**
-             * Fail on first error.
+             * The type of error that will cause load to fail. By default,
+             * loaders are permissive, that is, [[FailOn.none]].
              */
-            fail?: boolean
+            fail_on?: FailOn | Enum
         }): Image;
 
         /**
@@ -520,13 +613,14 @@ declare namespace vips {
          */
         static newFromBuffer(data: Blob, strOptions?: string, options?: {
             /**
-             * Hint the expected access pattern for the image
+             * Hint the expected access pattern for the image.
              */
             access?: Access | Enum
             /**
-             * Fail on first error.
+             * The type of error that will cause load to fail. By default,
+             * loaders are permissive, that is, [[FailOn.none]].
              */
-            fail?: boolean
+            fail_on?: FailOn | Enum
         }): Image;
 
         /**
@@ -541,20 +635,21 @@ declare namespace vips {
          */
         static newFromSource(source: Source, strOptions?: string, options?: {
             /**
-             * Hint the expected access pattern for the image
+             * Hint the expected access pattern for the image.
              */
             access?: Access | Enum
             /**
-             * Fail on first error.
+             * The type of error that will cause load to fail. By default,
+             * loaders are permissive, that is, [[FailOn.none]].
              */
-            fail?: boolean
+            fail_on?: FailOn | Enum
         }): Image;
 
         /**
          * Create an image from a 1D array.
          *
          * A new one-band image with [[BandFormat.double]] pixels is
-         * created from the array. These image are useful with the libvips
+         * created from the array. These images are useful with the libvips
          * convolution operator [[conv]].
          * @param width Image width.
          * @param height Image height.
@@ -567,7 +662,7 @@ declare namespace vips {
          * Create an image from a 2D array.
          *
          * A new one-band image with [[BandFormat.double]] pixels is
-         * created from the array. These image are useful with the libvips
+         * created from the array. These images are useful with the libvips
          * convolution operator [[conv]].
          * @param array Create the image from these values.
          * @param scale Default to 1.0. What to divide each pixel by after
@@ -942,7 +1037,7 @@ declare namespace vips {
          * @param options Optional options.
          * @return Blended image.
          */
-        static composite(_in: ArrayImage, mode: Array<Enum>, options?: {
+        static composite(_in: ArrayImage, mode: SingleOrArray<BlendMode>, options?: {
             /**
              * Array of x coordinates to join at.
              */
@@ -968,7 +1063,7 @@ declare namespace vips {
          * @param options Optional options.
          * @return Blended image.
          */
-        composite(overlay: ArrayImage, mode: Array<Enum>, options?: {
+        composite(overlay: ArrayImage, mode: SingleOrArray<BlendMode>, options?: {
             /**
              * Array of x coordinates to join at.
              */
@@ -1327,13 +1422,15 @@ declare namespace vips {
 
     //#endregion
 
+    //#region Auto-generated enumerations
+
     /**
      * 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>.
      */
-    export enum BandFormat {
+    enum BandFormat {
         /**
          * Unsigned char format
          */
@@ -1386,7 +1483,7 @@ declare namespace vips {
      * 
      * The non-separable modes are not implemented.
      */
-    export enum BlendMode {
+    enum BlendMode {
         /**
          * Where the second object is drawn, the first is removed
          */
@@ -1499,7 +1596,7 @@ declare namespace vips {
      * The gaps in the numbering are historical and must be maintained. Allocate
      * new numbers from the end.
      */
-    export enum Coding {
+    enum Coding {
         /**
          * Pixels are not coded
          */
@@ -1525,7 +1622,7 @@ declare namespace vips {
      * The gaps in numbering are historical and must be maintained. Allocate
      * new numbers from the end.
      */
-    export enum Interpretation {
+    enum Interpretation {
         /**
          * Generic many-band image
          */
@@ -1636,7 +1733,7 @@ declare namespace vips {
      * 
      * See also: vips_image_pipelinev().
      */
-    export enum DemandStyle {
+    enum DemandStyle {
         /**
          * Demand in small (typically 64x64 pixel) tiles
          */
@@ -1654,7 +1751,7 @@ declare namespace vips {
     /**
      * See also: vips_relational().
      */
-    export enum OperationRelational {
+    enum OperationRelational {
         /**
          * ==
          */
@@ -1684,7 +1781,7 @@ declare namespace vips {
     /**
      * See also: vips_boolean().
      */
-    export enum OperationBoolean {
+    enum OperationBoolean {
         /**
          * &
          */
@@ -1710,7 +1807,7 @@ declare namespace vips {
     /**
      * See also: vips_math().
      */
-    export enum OperationMath2 {
+    enum OperationMath2 {
         /**
          * Pow( left, right )
          */
@@ -1728,7 +1825,7 @@ declare namespace vips {
     /**
      * See also: vips_complex2().
      */
-    export enum OperationComplex2 {
+    enum OperationComplex2 {
         /**
          * Convert to polar coordinates
          */
@@ -1738,7 +1835,7 @@ declare namespace vips {
     /**
      * See also: vips_math().
      */
-    export enum OperationMath {
+    enum OperationMath {
         /**
          * Sin(), angles in degrees
          */
@@ -1808,7 +1905,7 @@ declare namespace vips {
     /**
      * See also: vips_round().
      */
-    export enum OperationRound {
+    enum OperationRound {
         /**
          * Round to nearest
          */
@@ -1826,7 +1923,7 @@ declare namespace vips {
     /**
      * See also: vips_complex().
      */
-    export enum OperationComplex {
+    enum OperationComplex {
         /**
          * Convert to polar coordinates
          */
@@ -1844,7 +1941,7 @@ declare namespace vips {
     /**
      * See also: vips_complexget().
      */
-    export enum OperationComplexget {
+    enum OperationComplexget {
         /**
          * Get real component
          */
@@ -1858,7 +1955,7 @@ declare namespace vips {
     /**
      * How to combine values. See vips_compass(), for example.
      */
-    export enum Combine {
+    enum Combine {
         /**
          * Take the maximum of the possible values
          */
@@ -1882,7 +1979,7 @@ declare namespace vips {
      * @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.
      */
-    export enum Access {
+    enum Access {
         /**
          * Can read anywhere
          */
@@ -1919,7 +2016,7 @@ declare namespace vips {
      * 
      * See also: vips_embed().
      */
-    export enum Extend {
+    enum Extend {
         /**
          * Extend with black (all 0) pixels
          */
@@ -1949,7 +2046,7 @@ declare namespace vips {
     /**
      * A direction on a compass. Used for vips_gravity(), for example.
      */
-    export enum CompassDirection {
+    enum CompassDirection {
         /**
          * Centre
          */
@@ -1996,7 +2093,7 @@ declare namespace vips {
      * 
      * See also: vips_flip(), vips_join().
      */
-    export enum Direction {
+    enum Direction {
         /**
          * Left-right
          */
@@ -2015,7 +2112,7 @@ declare namespace vips {
      * 
      * See also: vips_join().
      */
-    export enum Align {
+    enum Align {
         /**
          * Align low coordinate edge
          */
@@ -2041,7 +2138,7 @@ declare namespace vips {
      * 
      * See also: vips_smartcrop().
      */
-    export enum Interesting {
+    enum Interesting {
         /**
          * Do nothing
          */
@@ -2079,7 +2176,7 @@ declare namespace vips {
      * 
      * See also: vips_rot().
      */
-    export enum Angle {
+    enum Angle {
         /**
          * No rotate
          */
@@ -2105,7 +2202,7 @@ declare namespace vips {
      * 
      * See also: vips_rot45().
      */
-    export enum Angle45 {
+    enum Angle45 {
         /**
          * No rotate
          */
@@ -2143,7 +2240,7 @@ declare namespace vips {
     /**
      * How accurate an operation should be.
      */
-    export enum Precision {
+    enum Precision {
         /**
          * Int everywhere
          */
@@ -2165,7 +2262,7 @@ declare namespace vips {
      * Each one implies the ones before it, so #VIPS_FAIL_ON_ERROR implies
      * #VIPS_FAIL_ON_TRUNCATED.
      */
-    export enum FailOn {
+    enum FailOn {
         /**
          * Never stop
          */
@@ -2195,7 +2292,7 @@ declare namespace vips {
      * 
      * #VIPS_FOREIGN_PPM_FORMAT_PFM images are 32-bit float pixels.
      */
-    export enum ForeignPpmFormat {
+    enum ForeignPpmFormat {
         /**
          * Portable bitmap
          */
@@ -2217,7 +2314,7 @@ declare namespace vips {
     /**
      * Set subsampling mode.
      */
-    export enum ForeignSubsample {
+    enum ForeignSubsample {
         /**
          * Prevent subsampling when quality >= 90
          */
@@ -2235,7 +2332,7 @@ declare namespace vips {
     /**
      * What directory layout and metadata standard to use.
      */
-    export enum ForeignDzLayout {
+    enum ForeignDzLayout {
         /**
          * Use DeepZoom directory layout
          */
@@ -2261,7 +2358,7 @@ declare namespace vips {
     /**
      * How many pyramid layers to create.
      */
-    export enum ForeignDzDepth {
+    enum ForeignDzDepth {
         /**
          * Create layers down to 1x1 pixel
          */
@@ -2279,7 +2376,7 @@ declare namespace vips {
     /**
      * How many pyramid layers to create.
      */
-    export enum ForeignDzContainer {
+    enum ForeignDzContainer {
         /**
          * Write tiles to the filesystem
          */
@@ -2297,7 +2394,7 @@ declare namespace vips {
     /**
      * How to calculate the output pixels when shrinking a 2x2 region.
      */
-    export enum RegionShrink {
+    enum RegionShrink {
         /**
          * Use the average
          */
@@ -2327,7 +2424,7 @@ declare namespace vips {
     /**
      * Tune lossy encoder settings for different image types.
      */
-    export enum ForeignWebpPreset {
+    enum ForeignWebpPreset {
         /**
          * Default preset
          */
@@ -2365,7 +2462,7 @@ declare namespace vips {
      * 
      * Use @level to set webp and zstd compression level.
      */
-    export enum ForeignTiffCompression {
+    enum ForeignTiffCompression {
         /**
          * No compression
          */
@@ -2408,7 +2505,7 @@ declare namespace vips {
      * The predictor can help deflate and lzw compression. The values are fixed by
      * the tiff library.
      */
-    export enum ForeignTiffPredictor {
+    enum ForeignTiffPredictor {
         /**
          * No prediction
          */
@@ -2426,7 +2523,7 @@ declare namespace vips {
     /**
      * Use inches or centimeters as the resolution unit for a tiff file.
      */
-    export enum ForeignTiffResunit {
+    enum ForeignTiffResunit {
         /**
          * Use centimeters
          */
@@ -2442,7 +2539,7 @@ declare namespace vips {
      * 
      * This is assumed to use the same numbering as %heif_compression_format.
      */
-    export enum ForeignHeifCompression {
+    enum ForeignHeifCompression {
         /**
          * X265
          */
@@ -2467,7 +2564,7 @@ declare namespace vips {
      * 
      * See also: vips_thumbnail().
      */
-    export enum Size {
+    enum Size {
         /**
          * Size both up and down
          */
@@ -2491,7 +2588,7 @@ declare namespace vips {
      * scientific work, #VIPS_INTENT_RELATIVE is usually best for
      * accurate communication with other imaging libraries.
      */
-    export enum Intent {
+    enum Intent {
         /**
          * Perceptual rendering intent
          */
@@ -2513,7 +2610,7 @@ declare namespace vips {
     /**
      * The resampling kernels vips supports. See vips_reduce(), for example.
      */
-    export enum Kernel {
+    enum Kernel {
         /**
          * The nearest pixel to the point.
          */
@@ -2545,7 +2642,7 @@ declare namespace vips {
      * vips_icc_export(). LAB is usually best, XYZ can be more convenient in some
      * cases.
      */
-    export enum PCS {
+    enum PCS {
         /**
          * Use CIELAB D65 as the Profile Connection Space
          */
@@ -2561,7 +2658,7 @@ declare namespace vips {
      * 
      * See also: vips_morph().
      */
-    export enum OperationMorphology {
+    enum OperationMorphology {
         /**
          * True if all set
          */
@@ -2580,7 +2677,7 @@ declare namespace vips {
      * 
      * See also: vips_join().
      */
-    export enum CombineMode {
+    enum CombineMode {
         /**
          * Set pixels to the new value
          */
@@ -2595,7 +2692,7 @@ declare namespace vips {
      * http://www.w3.org/TR/PNG-Filters.html
      * The values mirror those of png.h in libpng.
      */
-    export enum ForeignPngFilter {
+    enum ForeignPngFilter {
         /**
          * No filtering
          */
@@ -2622,7 +2719,11 @@ declare namespace vips {
         all = 'all'
     }
 
-    class ImageAutoGen {
+    //#endregion
+
+    //#region Auto-generated classes
+
+    abstract class ImageAutoGen extends EmbindClassHandle<ImageAutoGen> {
         // THIS IS A GENERATED CLASS. DO NOT EDIT DIRECTLY.
 
         /**
@@ -3052,6 +3153,10 @@ declare namespace vips {
              * Fetch thumbnail image.
              */
             thumbnail?: boolean
+            /**
+             * Remove all denial of service limits.
+             */
+            unlimited?: boolean
             /**
              * Force open via memory.
              */
@@ -3089,6 +3194,10 @@ declare namespace vips {
              * Fetch thumbnail image.
              */
             thumbnail?: boolean
+            /**
+             * Remove all denial of service limits.
+             */
+            unlimited?: boolean
             /**
              * Force open via memory.
              */
@@ -3126,6 +3235,10 @@ declare namespace vips {
              * Fetch thumbnail image.
              */
             thumbnail?: boolean
+            /**
+             * Remove all denial of service limits.
+             */
+            unlimited?: boolean
             /**
              * Force open via memory.
              */
@@ -3553,7 +3666,7 @@ declare namespace vips {
          * @param order Filter order.
          * @param frequency_cutoff_x Frequency cutoff x.
          * @param frequency_cutoff_y Frequency cutoff y.
-         * @param radius radius of circle.
+         * @param radius Radius of circle.
          * @param amplitude_cutoff Amplitude cutoff.
          * @param options Optional options.
          * @return Output image.
@@ -3668,7 +3781,7 @@ declare namespace vips {
          * @param height Image height in pixels.
          * @param frequency_cutoff_x Frequency cutoff x.
          * @param frequency_cutoff_y Frequency cutoff y.
-         * @param radius radius of circle.
+         * @param radius Radius of circle.
          * @param amplitude_cutoff Amplitude cutoff.
          * @param options Optional options.
          * @return Output image.
@@ -3754,7 +3867,7 @@ declare namespace vips {
          * @param height Image height in pixels.
          * @param frequency_cutoff_x Frequency cutoff x.
          * @param frequency_cutoff_y Frequency cutoff y.
-         * @param radius radius of circle.
+         * @param radius Radius of circle.
          * @param options Optional options.
          * @return Output image.
          */
@@ -4064,6 +4177,10 @@ declare namespace vips {
              * Background value.
              */
             background?: ArrayConstant
+            /**
+             * Decrypt with this password.
+             */
+            password?: string
             /**
              * Force open via memory.
              */
@@ -4109,6 +4226,10 @@ declare namespace vips {
              * Background value.
              */
             background?: ArrayConstant
+            /**
+             * Decrypt with this password.
+             */
+            password?: string
             /**
              * Force open via memory.
              */
@@ -4154,6 +4275,10 @@ declare namespace vips {
              * Background value.
              */
             background?: ArrayConstant
+            /**
+             * Decrypt with this password.
+             */
+            password?: string
             /**
              * Force open via memory.
              */
@@ -4717,6 +4842,10 @@ declare namespace vips {
              * Rendering intent.
              */
             intent?: Intent | Enum
+            /**
+             * Error level to fail on.
+             */
+            fail_on?: FailOn | Enum
         }): Image;
 
         /**
@@ -4763,6 +4892,10 @@ declare namespace vips {
              * Rendering intent.
              */
             intent?: Intent | Enum
+            /**
+             * Error level to fail on.
+             */
+            fail_on?: FailOn | Enum
         }): Image;
 
         /**
@@ -4809,6 +4942,10 @@ declare namespace vips {
              * Rendering intent.
              */
             intent?: Intent | Enum
+            /**
+             * Error level to fail on.
+             */
+            fail_on?: FailOn | Enum
         }): Image;
 
         /**
@@ -5405,7 +5542,7 @@ declare namespace vips {
 
         /**
          * Boolean operation across image bands.
-         * @param boolean boolean to perform.
+         * @param boolean Boolean to perform.
          * @return Output image.
          */
         bandbool(boolean: OperationBoolean | Enum): Image;
@@ -5443,7 +5580,7 @@ declare namespace vips {
         /**
          * Boolean operation on two images.
          * @param right Right-hand image argument.
-         * @param boolean boolean to perform.
+         * @param boolean Boolean to perform.
          * @return Output image.
          */
         boolean(right: Image | ArrayConstant, boolean: OperationBoolean | Enum): Image;
@@ -5564,7 +5701,7 @@ declare namespace vips {
 
         /**
          * Perform a complex operation on an image.
-         * @param cmplx complex to perform.
+         * @param cmplx Complex to perform.
          * @return Output image.
          */
         complex(cmplx: OperationComplex | Enum): Image;
@@ -5572,7 +5709,7 @@ declare namespace vips {
         /**
          * Complex binary operations on two images.
          * @param right Right-hand image argument.
-         * @param cmplx binary complex operation to perform.
+         * @param cmplx Binary complex operation to perform.
          * @return Output image.
          */
         complex2(right: Image | ArrayConstant, cmplx: OperationComplex2 | Enum): Image;
@@ -5586,7 +5723,7 @@ declare namespace vips {
 
         /**
          * Get a component from a complex image.
-         * @param get complex to perform.
+         * @param get Complex to perform.
          * @return Output image.
          */
         complexget(get: OperationComplexget | Enum): Image;
@@ -5999,10 +6136,6 @@ declare namespace vips {
              * Pyramid container type.
              */
             container?: ForeignDzContainer | Enum
-            /**
-             * Write a properties file to the output directory.
-             */
-            properties?: boolean
             /**
              * Zip deflate compression level.
              */
@@ -6080,9 +6213,81 @@ declare namespace vips {
              */
             container?: ForeignDzContainer | Enum
             /**
-             * Write a properties file to the output directory.
+             * Zip deflate compression level.
              */
-            properties?: boolean
+            compression?: number
+            /**
+             * Method to shrink regions.
+             */
+            region_shrink?: RegionShrink | Enum
+            /**
+             * Skip tiles which are nearly equal to the background.
+             */
+            skip_blanks?: number
+            /**
+             * Don't strip tile metadata.
+             */
+            no_strip?: boolean
+            /**
+             * Resource id.
+             */
+            id?: string
+            /**
+             * Strip all metadata from image.
+             */
+            strip?: boolean
+            /**
+             * Background value.
+             */
+            background?: ArrayConstant
+            /**
+             * Set page height for multipage save.
+             */
+            page_height?: number
+        }): Uint8Array;
+
+        /**
+         * Save image to deepzoom target.
+         * @param target Target to save to.
+         * @param options Optional options.
+         */
+        dzsaveTarget(target: Target, options?: {
+            /**
+             * Base name to save to.
+             */
+            basename?: string
+            /**
+             * Directory layout.
+             */
+            layout?: ForeignDzLayout | Enum
+            /**
+             * Filename suffix for tiles.
+             */
+            suffix?: string
+            /**
+             * Tile overlap in pixels.
+             */
+            overlap?: number
+            /**
+             * Tile size in pixels.
+             */
+            tile_size?: number
+            /**
+             * Center image in tile.
+             */
+            centre?: boolean
+            /**
+             * Pyramid depth.
+             */
+            depth?: ForeignDzDepth | Enum
+            /**
+             * Rotate image during save.
+             */
+            angle?: Angle | Enum
+            /**
+             * Pyramid container type.
+             */
+            container?: ForeignDzContainer | Enum
             /**
              * Zip deflate compression level.
              */
@@ -6115,7 +6320,7 @@ declare namespace vips {
              * Set page height for multipage save.
              */
             page_height?: number
-        }): Uint8Array;
+        }): void;
 
         /**
          * Embed an image in a larger image.
@@ -6302,6 +6507,18 @@ declare namespace vips {
              * Number of bits per pixel.
              */
             bitdepth?: number
+            /**
+             * Maximum inter-frame error for transparency.
+             */
+            interframe_maxerror?: number
+            /**
+             * Reoptimise colour palettes.
+             */
+            reoptimise?: boolean
+            /**
+             * Maximum inter-palette error for palette reusage.
+             */
+            interpalette_maxerror?: number
             /**
              * Strip all metadata from image.
              */
@@ -6334,6 +6551,18 @@ declare namespace vips {
              * Number of bits per pixel.
              */
             bitdepth?: number
+            /**
+             * Maximum inter-frame error for transparency.
+             */
+            interframe_maxerror?: number
+            /**
+             * Reoptimise colour palettes.
+             */
+            reoptimise?: boolean
+            /**
+             * Maximum inter-palette error for palette reusage.
+             */
+            interpalette_maxerror?: number
             /**
              * Strip all metadata from image.
              */
@@ -6366,6 +6595,18 @@ declare namespace vips {
              * Number of bits per pixel.
              */
             bitdepth?: number
+            /**
+             * Maximum inter-frame error for transparency.
+             */
+            interframe_maxerror?: number
+            /**
+             * Reoptimise colour palettes.
+             */
+            reoptimise?: boolean
+            /**
+             * Maximum inter-palette error for palette reusage.
+             */
+            interpalette_maxerror?: number
             /**
              * Strip all metadata from image.
              */
@@ -6398,7 +6639,7 @@ declare namespace vips {
 
         /**
          * Place an image within a larger image with a certain gravity.
-         * @param direction direction to place image within width/height.
+         * @param direction Direction to place image within width/height.
          * @param width Image width in pixels.
          * @param height Image height in pixels.
          * @param options Optional options.
@@ -6417,9 +6658,9 @@ declare namespace vips {
 
         /**
          * Grid an image.
-         * @param tile_height chop into tiles this high.
-         * @param across number of tiles across.
-         * @param down number of tiles down.
+         * @param tile_height Chop into tiles this high.
+         * @param across Number of tiles across.
+         * @param down Number of tiles down.
          * @return Output image.
          */
         grid(tile_height: number, across: number, down: number): Image;
@@ -6434,6 +6675,10 @@ declare namespace vips {
              * Q factor.
              */
             Q?: number
+            /**
+             * Number of bits per pixel.
+             */
+            bitdepth?: number
             /**
              * Enable lossless compression.
              */
@@ -6474,6 +6719,10 @@ declare namespace vips {
              * Q factor.
              */
             Q?: number
+            /**
+             * Number of bits per pixel.
+             */
+            bitdepth?: number
             /**
              * Enable lossless compression.
              */
@@ -6514,6 +6763,10 @@ declare namespace vips {
              * Q factor.
              */
             Q?: number
+            /**
+             * Number of bits per pixel.
+             */
+            bitdepth?: number
             /**
              * Enable lossless compression.
              */
@@ -7344,7 +7597,7 @@ declare namespace vips {
          */
         labelregions(options?: {
             /**
-             * Number of discrete contigious regions (output).
+             * Number of discrete contiguous regions (output).
              */
             segments?: number | undefined
         }): Image;
@@ -7409,6 +7662,10 @@ declare namespace vips {
              * Apply gif transparency optimization.
              */
             optimize_gif_transparency?: boolean
+            /**
+             * Number of bits per pixel.
+             */
+            bitdepth?: number
             /**
              * Strip all metadata from image.
              */
@@ -7445,6 +7702,10 @@ declare namespace vips {
              * Apply gif transparency optimization.
              */
             optimize_gif_transparency?: boolean
+            /**
+             * Number of bits per pixel.
+             */
+            bitdepth?: number
             /**
              * Strip all metadata from image.
              */
@@ -7470,6 +7731,18 @@ declare namespace vips {
              * Interpolate pixels with this.
              */
             interpolate?: Interpolate
+            /**
+             * Background value.
+             */
+            background?: ArrayConstant
+            /**
+             * Images have premultiplied alpha.
+             */
+            premultiplied?: boolean
+            /**
+             * How to generate the extra pixels.
+             */
+            extend?: Extend | Enum
         }): Image;
 
         /**
@@ -7520,7 +7793,7 @@ declare namespace vips {
 
         /**
          * Apply a math operation to an image.
-         * @param math math to perform.
+         * @param math Math to perform.
          * @return Output image.
          */
         math(math: OperationMath | Enum): Image;
@@ -7528,7 +7801,7 @@ declare namespace vips {
         /**
          * Binary math operations.
          * @param right Right-hand image argument.
-         * @param math2 math to perform.
+         * @param math2 Math to perform.
          * @return Output image.
          */
         math2(right: Image | ArrayConstant, math2: OperationMath2 | Enum): Image;
@@ -7802,10 +8075,6 @@ declare namespace vips {
              * Maximum blend size.
              */
             mblend?: number
-            /**
-             * Band to search for features on.
-             */
-            bandno?: number
         }): Image;
 
         /**
@@ -7862,7 +8131,7 @@ declare namespace vips {
         phasecor(in2: Image | ArrayConstant): Image;
 
         /**
-         * Save image to png file.
+         * Save image to file as png.
          * @param filename Filename to save to.
          * @param options Optional options.
          */
@@ -7880,7 +8149,7 @@ declare namespace vips {
              */
             profile?: string
             /**
-             * Libpng row filter flag(s).
+             * Libspng row filter flag(s).
              */
             filter?: ForeignPngFilter | Flag
             /**
@@ -7918,7 +8187,7 @@ declare namespace vips {
         }): void;
 
         /**
-         * Save image to png buffer.
+         * Save image to buffer as png.
          * @param options Optional options.
          * @return Buffer to save to.
          */
@@ -7936,7 +8205,7 @@ declare namespace vips {
              */
             profile?: string
             /**
-             * Libpng row filter flag(s).
+             * Libspng row filter flag(s).
              */
             filter?: ForeignPngFilter | Flag
             /**
@@ -7992,7 +8261,7 @@ declare namespace vips {
              */
             profile?: string
             /**
-             * Libpng row filter flag(s).
+             * Libspng row filter flag(s).
              */
             filter?: ForeignPngFilter | Flag
             /**
@@ -8235,7 +8504,7 @@ declare namespace vips {
 
         /**
          * Linear recombination with matrix.
-         * @param m matrix of coefficients.
+         * @param m Matrix of coefficients.
          * @return Output image.
          */
         recomb(m: Image | ArrayConstant): Image;
@@ -8252,6 +8521,10 @@ declare namespace vips {
              * Resampling kernel.
              */
             kernel?: Kernel | Enum
+            /**
+             * Reducing gap.
+             */
+            gap?: number
         }): Image;
 
         /**
@@ -8265,6 +8538,10 @@ declare namespace vips {
              * Resampling kernel.
              */
             kernel?: Kernel | Enum
+            /**
+             * Reducing gap.
+             */
+            gap?: number
         }): Image;
 
         /**
@@ -8278,12 +8555,16 @@ declare namespace vips {
              * Resampling kernel.
              */
             kernel?: Kernel | Enum
+            /**
+             * Reducing gap.
+             */
+            gap?: number
         }): Image;
 
         /**
          * Relational operation on two images.
          * @param right Right-hand image argument.
-         * @param relational relational to perform.
+         * @param relational Relational to perform.
          * @return Output image.
          */
         relational(right: Image | ArrayConstant, relational: OperationRelational | Enum): Image;
@@ -8314,6 +8595,10 @@ declare namespace vips {
              * Resampling kernel.
              */
             kernel?: Kernel | Enum
+            /**
+             * Reducing gap.
+             */
+            gap?: number
             /**
              * Vertical scale image by this factor.
              */
@@ -8374,7 +8659,7 @@ declare namespace vips {
 
         /**
          * Perform a round function on an image.
-         * @param round rounding operation to perform.
+         * @param round Rounding operation to perform.
          * @return Output image.
          */
         round(round: OperationRound | Enum): Image;
@@ -8485,23 +8770,41 @@ declare namespace vips {
          * Shrink an image.
          * @param hshrink Horizontal shrink factor.
          * @param vshrink Vertical shrink factor.
+         * @param options Optional options.
          * @return Output image.
          */
-        shrink(hshrink: number, vshrink: number): Image;
+        shrink(hshrink: number, vshrink: number, options?: {
+            /**
+             * Round-up output dimensions.
+             */
+            ceil?: boolean
+        }): Image;
 
         /**
          * Shrink an image horizontally.
          * @param hshrink Horizontal shrink factor.
+         * @param options Optional options.
          * @return Output image.
          */
-        shrinkh(hshrink: number): Image;
+        shrinkh(hshrink: number, options?: {
+            /**
+             * Round-up output dimensions.
+             */
+            ceil?: boolean
+        }): Image;
 
         /**
          * Shrink an image vertically.
          * @param vshrink Vertical shrink factor.
+         * @param options Optional options.
          * @return Output image.
          */
-        shrinkv(vshrink: number): Image;
+        shrinkv(vshrink: number, options?: {
+            /**
+             * Round-up output dimensions.
+             */
+            ceil?: boolean
+        }): Image;
 
         /**
          * Unit vector of pixel.
@@ -8674,6 +8977,10 @@ declare namespace vips {
              * Rendering intent.
              */
             intent?: Intent | Enum
+            /**
+             * Error level to fail on.
+             */
+            fail_on?: FailOn | Enum
         }): Image;
 
         /**
@@ -8884,6 +9191,110 @@ declare namespace vips {
             page_height?: number
         }): Uint8Array;
 
+        /**
+         * Save image to tiff target.
+         * @param target Target to save to.
+         * @param options Optional options.
+         */
+        tiffsaveTarget(target: Target, options?: {
+            /**
+             * Compression for this file.
+             */
+            compression?: ForeignTiffCompression | Enum
+            /**
+             * Q factor.
+             */
+            Q?: number
+            /**
+             * Compression prediction.
+             */
+            predictor?: ForeignTiffPredictor | Enum
+            /**
+             * Icc profile to embed.
+             */
+            profile?: string
+            /**
+             * Write a tiled tiff.
+             */
+            tile?: boolean
+            /**
+             * Tile width in pixels.
+             */
+            tile_width?: number
+            /**
+             * Tile height in pixels.
+             */
+            tile_height?: number
+            /**
+             * Write a pyramidal tiff.
+             */
+            pyramid?: boolean
+            /**
+             * Use 0 for white in 1-bit images.
+             */
+            miniswhite?: boolean
+            /**
+             * Write as a 1, 2, 4 or 8 bit image.
+             */
+            bitdepth?: number
+            /**
+             * Resolution unit.
+             */
+            resunit?: ForeignTiffResunit | Enum
+            /**
+             * Horizontal resolution in pixels/mm.
+             */
+            xres?: number
+            /**
+             * Vertical resolution in pixels/mm.
+             */
+            yres?: number
+            /**
+             * Write a bigtiff image.
+             */
+            bigtiff?: boolean
+            /**
+             * Write a properties document to imagedescription.
+             */
+            properties?: boolean
+            /**
+             * Method to shrink regions.
+             */
+            region_shrink?: RegionShrink | Enum
+            /**
+             * Zstd compression level.
+             */
+            level?: number
+            /**
+             * Enable webp lossless mode.
+             */
+            lossless?: boolean
+            /**
+             * Pyramid depth.
+             */
+            depth?: ForeignDzDepth | Enum
+            /**
+             * Save pyr layers as sub-ifds.
+             */
+            subifd?: boolean
+            /**
+             * Save with premultiplied alpha.
+             */
+            premultiply?: boolean
+            /**
+             * Strip all metadata from image.
+             */
+            strip?: boolean
+            /**
+             * Background value.
+             */
+            background?: ArrayConstant
+            /**
+             * Set page height for multipage save.
+             */
+            page_height?: number
+        }): void;
+
         /**
          * Cache an image as a set of tiles.
          * @param options Optional options.
@@ -9015,7 +9426,7 @@ declare namespace vips {
              */
             alpha_q?: number
             /**
-             * Optimise for minium size.
+             * Optimise for minimum size.
              */
             min_size?: boolean
             /**
@@ -9034,6 +9445,10 @@ declare namespace vips {
              * Icc profile to embed.
              */
             profile?: string
+            /**
+             * Allow mixed encoding (might reduce file size).
+             */
+            mixed?: boolean
             /**
              * Strip all metadata from image.
              */
@@ -9079,7 +9494,7 @@ declare namespace vips {
              */
             alpha_q?: number
             /**
-             * Optimise for minium size.
+             * Optimise for minimum size.
              */
             min_size?: boolean
             /**
@@ -9098,6 +9513,10 @@ declare namespace vips {
              * Icc profile to embed.
              */
             profile?: string
+            /**
+             * Allow mixed encoding (might reduce file size).
+             */
+            mixed?: boolean
             /**
              * Strip all metadata from image.
              */
@@ -9143,7 +9562,7 @@ declare namespace vips {
              */
             alpha_q?: number
             /**
-             * Optimise for minium size.
+             * Optimise for minimum size.
              */
             min_size?: boolean
             /**
@@ -9162,6 +9581,10 @@ declare namespace vips {
              * Icc profile to embed.
              */
             profile?: string
+            /**
+             * Allow mixed encoding (might reduce file size).
+             */
+            mixed?: boolean
             /**
              * Strip all metadata from image.
              */
@@ -9200,4 +9623,9 @@ declare namespace vips {
          */
         zoom(xfac: number, yfac: number): Image;
     }
-}
+
+    //#endregion
+
+}
+
+export = Vips;