* Write output to a Buffer. JPEG, PNG, WebP, AVIF, TIFF, GIF and RAW output are supported. * By default, the format will match the input imag

* Resize image to width, height or width x height. * * When both a width and height are provided, the possible methods by which the

* Fast access to (uncached) image metadata without decoding any compressed image data. * @returns A sharp instance that can be used to chain

* Write output image data to a file. * If an explicit output format is not selected, it will be inferred from the extension, with JPEG, PNG,

* Use these PNG options for output image. * PNG output is always full colour at 8 or 16 bits per pixel. * Indexed PNG input at 1, 2

* Use these JPEG options for output image. * @param options Output options. * @throws {Error} Invalid options * @returns A

* Use these TIFF options for output image. * @param options Output options. * @throws {Error} Invalid options * @returns A

* Rotate the output image by either an explicit angle * or auto-orient based on the EXIF `Orientation` tag. * * If an angle

* Force output to be raw, uncompressed uint8 pixel data. * @param options Raw output options. * @throws {Error} Invalid options

* Use these WebP options for output image. * @param options Output options. * @throws {Error} Invalid options * @returns A

* Extract a region of the image. * - Use extract() before resize() for pre-resize extraction. * - Use extract() after resize() for

* Use tile-based deep zoom (image pyramid) output. * Set the format and options for tile images via the toFormat, jpeg, png or webp functions

* Composite image(s) over the processed (resized, extracted etc.) image. * * The images to composite must be the same size or smalle

* Use these GIF options for output image. * Requires libvips compiled with support for ImageMagick or GraphicsMagick. The prebuilt binaries d

* Set the output colourspace. * By default output image will be web-friendly sRGB, with additional channels interpreted as alpha channels.

* Access to pixel-derived image statistics for every channel in the image. * @returns A sharp instance that can be used to chain operations

* Extend / pad / extrude one or more edges of the image with either * the provided background colour or pixels derived from the image.

* Include all metadata (EXIF, XMP, IPTC) from the input image in the output image. * The default behaviour, when withMetadata is not used, is

* Trim pixels from all edges that contain values similar to the given background colour, which defaults to that of the top-left pixel. * Imag

* Perform an affine transform on an image. This operation will always occur after resizing, extraction and rotation, if any. * You must provi

* Perform contrast limiting adaptive histogram equalization (CLAHE) * * This will, in general, enhance the clarity of the image by b

* Blur the image. * When used without parameters, performs a fast, mild blur of the output image. * When a sigma is provided, perfor

* Join one or more channels to the image. The meaning of the added channels depends on the output colourspace, set with toColourspace(). * By

* Force output to a given format. * @param format a String or an Object with an 'id' attribute * @param options output options

* Use these HEIF options for output image. * Support for patent-encumbered HEIC images requires the use of a globally-installed libvips compi

* Produce the "negative" of the image. * @param negate true to enable and false to disable, or an object of options (defaults to true)

* Sharpen the image. * When used without parameters, performs a fast, mild sharpen of the output image. * When a sigma is provided,

* Use these JPEG-XL (JXL) options for output image. * This feature is experimental, please do not use in production systems. * Requi

* Apply the linear formula a * input + b to the image (levels adjustment) * @param a multiplier (optional, default 1.0) * @param b o

* Use these AVIF options for output image. * @param options Output options. * @throws {Error} Invalid options * @returns A

* Enhance output image contrast by stretching its luminance to cover a full dynamic range. * * Uses a histogram-based approach, taki

* Any pixel value greather than or equal to the threshold value will be set to 255, otherwise it will be set to 0. * @param threshold a value

* Recomb the image with the specified matrix. * @param inputMatrix 3x3 Recombination matrix or 4x4 Recombination matrix * @throws {E

* Transform using an ICC profile and attach to the output image. * @param {string} icc - Absolute filesystem path to output ICC profile or bu

* Extract a single channel from a multi-channel image. * @param channel zero-indexed channel/band number to extract, or red, green, blue or a

* Transforms the image using brightness, saturation, hue rotation and lightness. * Brightness and lightness both operate on luminance, with t

* Tint the image using the provided colour. * An alpha channel may be present and will be unchanged by the operation. * @param tint

* Set XMP metadata in the output image. * @param {string} xmp - String containing XMP metadata to be embedded in the output image. *

* Convolve the image with the specified kernel. * @param kernel the specified kernel * @throws {Error} Invalid parameters *

* Merge alpha transparency channel, if any, with background. * @param flatten true to enable and false to disable (defaults to true)

* Apply a gamma correction by reducing the encoding (darken) pre-resize at a factor of 1/gamma then increasing the encoding (brighten) post-resize at

* Convert to 8-bit greyscale; 256 shades of grey. * This is a linear operation. * If the input image is in a non-linear colour space

* Alias for calling `rotate()` with no arguments, which orients the image based * on EXIF orientsion. * * This operation is

* Flip the image about the vertical Y axis. This always occurs after rotation, if any. * The use of flip implies the removal of the EXIF Orie

* Set the pipeline colourspace. * The input image will be converted to the provided colourspace at the start of the pipeline. * All

* Perform a bitwise boolean operation with operand image. * This operation creates an output image where each pixel is the result of the sele

* Take a "snapshot" of the Sharp instance, returning a new instance. * Cloned instances inherit the input of their parent instance.

* Keep ICC profile from the input image in the output image where possible. * @returns A sharp instance that can be used to chain operations

* Flop the image about the horizontal X axis. This always occurs after rotation, if any. * The use of flop implies the removal of the EXIF Or

* Use these JP2 (JPEG 2000) options for output image. * @param options Output options. * @throws {Error} Invalid options *

* Alternative spelling of normalise. * @param normalize options * @throws {Error} Invalid parameters * @returns A sharp ins

* Set EXIF metadata in the output image, ignoring any EXIF in the input image. * @param {Exif} exif Object keyed by IFD0, IFD1 etc. of key/va

* Perform a bitwise boolean operation on all input image channels (bands) to produce a single channel output image. * @param boolOp one of "a

* Expand foreground objects using the dilate morphological operator. * @param {Number} [width=1] dilation width in pixels. * @throws

* Shrink foreground objects using the erode morphological operator. * @param {Number} [width=1] erosion width in pixels. * @throws {

* @private

* Apply median filter. When used without parameters the default window is 3x3. * @param size square mask size: size x size (optional, default

* Set a timeout for processing, in seconds. Use a value of zero to continue processing indefinitely, the default behaviour. * The clock start

* Set output density (DPI) in EXIF metadata. * @param density Density in dots per inch (DPI). * @returns A sharp instance that can b

* Ensure alpha channel, if missing. The added alpha channel will be fully opaque. This is a no-op if the image already has an alpha channel.

* @private

* Keep all EXIF metadata from the input image in the output image. * EXIF metadata is unsupported for TIFF output. * @returns A shar

* Alternative spelling of toColourspace(). * @param colorspace output colorspace e.g. srgb, rgb, cmyk, lab, b-w ... * @throws {Error

* Write output to a Uint8Array backed by a transferable ArrayBuffer. JPEG, PNG, WebP, AVIF, TIFF, GIF and RAW output are supported. * By defa

* Set animation options if available. * @private * * @param {Object} [source] - output options * @param {number} [source.loop=0] - number of anima

* Ensure the image has an alpha channel with all white pixel values made fully transparent. * Existing alpha channel values for non-white pix

* Keep all metadata (EXIF, ICC, XMP, IPTC) from the input image in the output image. * @returns A sharp instance that can be used to chain op

* Update EXIF metadata from the input image in the output image. * @param {Exif} exif Object keyed by IFD0, IFD1 etc. of key/value string pai

* Create a RGBA colour array from a given value. * @private * @param {string|Object} value * @throws {Error} Invalid value

* Extract input options, if any, from an object. * @private

* Gets or, when options are provided, sets the limits of _libvips'_ operation cache. * Existing entries in the cache will be trimmed after any change