sharp/docs/api-output.md

toFile

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, WebP, TIFF, DZI, and libvips' V format supported. Note that raw pixel data is only supported for buffer output.

By default all metadata will be removed, which includes EXIF-based orientation. See withMetadata for control over this.

A Promise is returned when callback is not provided.

Parameters

• fileOut String the path to write the image data to.
• callback Function? called on completion with two arguments (err, info). info contains the output image format, size (bytes), width, height, channels and premultiplied (indicating if premultiplication was used). When using a crop strategy also contains cropOffsetLeft and cropOffsetTop.

Examples

sharp(input)
  .toFile('output.png', (err, info) => { ... });

sharp(input)
  .toFile('output.png')
  .then(info => { ... })
  .catch(err => { ... });

• Throws Error Invalid parameters

Returns Promise<Object> when no callback is provided

toBuffer

Write output to a Buffer. JPEG, PNG, WebP, TIFF and RAW output are supported.

If no explicit format is set, the output format will match the input image, except GIF and SVG input which become PNG output.

By default all metadata will be removed, which includes EXIF-based orientation. See withMetadata for control over this.

callback, if present, gets three arguments (err, data, info) where:

• err is an error, if any.
• data is the output image data.
• info contains the output image format, size (bytes), width, height, channels and premultiplied (indicating if premultiplication was used). When using a crop strategy also contains cropOffsetLeft and cropOffsetTop.

A Promise is returned when callback is not provided.

Parameters

• options Object?
  • options.resolveWithObject Boolean? Resolve the Promise with an Object containing data and info properties instead of resolving only with data.
• callback Function?

Examples

sharp(input)
  .toBuffer((err, data, info) => { ... });

sharp(input)
  .toBuffer()
  .then(data => { ... })
  .catch(err => { ... });

sharp(input)
  .toBuffer({ resolveWithObject: true })
  .then(({ data, info }) => { ... })
  .catch(err => { ... });

Returns Promise<Buffer> when no callback is provided

withMetadata

Include all metadata (EXIF, XMP, IPTC) from the input image in the output image. The default behaviour, when withMetadata is not used, is to strip all metadata and convert to the device-independent sRGB colour space. This will also convert to and add a web-friendly sRGB ICC profile.

Parameters

• options Object?
  • options.orientation Number? value between 1 and 8, used to update the EXIF Orientation tag.

Examples

sharp('input.jpg')
  .withMetadata()
  .toFile('output-with-metadata.jpg')
  .then(info => { ... });

• Throws Error Invalid parameters

Returns Sharp

toFormat

Force output to a given format.

Parameters

• format (String | Object) as a String or an Object with an 'id' attribute
• options Object output options

Examples

// Convert any input to PNG output
const data = await sharp(input)
  .toFormat('png')
  .toBuffer();

• Throws Error unsupported format or options

Returns Sharp

jpeg

Use these JPEG options for output image.

Parameters

• options Object? output options
  • options.quality Number quality, integer 1-100 (optional, default 80)
  • options.progressive Boolean use progressive (interlace) scan (optional, default false)
  • options.chromaSubsampling String set to '4:4:4' to prevent chroma subsampling when quality <= 90 (optional, default '4:2:0')
  • options.trellisQuantisation Boolean apply trellis quantisation, requires libvips compiled with support for mozjpeg (optional, default false)
  • options.overshootDeringing Boolean apply overshoot deringing, requires libvips compiled with support for mozjpeg (optional, default false)
  • options.optimiseScans Boolean optimise progressive scans, forces progressive, requires libvips compiled with support for mozjpeg (optional, default false)
  • options.optimizeScans Boolean alternative spelling of optimiseScans (optional, default false)
  • options.optimiseCoding Boolean optimise Huffman coding tables (optional, default true)
  • options.optimizeCoding Boolean alternative spelling of optimiseCoding (optional, default true)
  • options.quantisationTable Number quantization table to use, integer 0-8, requires libvips compiled with support for mozjpeg (optional, default 0)
  • options.quantizationTable Number alternative spelling of quantisationTable (optional, default 0)
  • options.force Boolean force JPEG output, otherwise attempt to use input format (optional, default true)

Examples

// Convert any input to very high quality JPEG output
const data = await sharp(input)
  .jpeg({
    quality: 100,
    chromaSubsampling: '4:4:4'
  })
  .toBuffer();

• Throws Error Invalid options

Returns Sharp

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 or 4 bits per pixel is converted to 8 bits per pixel.

Parameters

• options Object?
  • options.progressive Boolean use progressive (interlace) scan (optional, default false)
  • options.compressionLevel Number zlib compression level, 0-9 (optional, default 9)
  • options.adaptiveFiltering Boolean use adaptive row filtering (optional, default false)
  • options.palette Boolean quantise to a palette-based image with alpha transparency support, requires libvips compiled with support for libimagequant (optional, default false)
  • options.quality Number use the lowest number of colours needed to achieve given quality, requires libvips compiled with support for libimagequant (optional, default 100)
  • options.colours Number maximum number of palette entries, requires libvips compiled with support for libimagequant (optional, default 256)
  • options.colors Number alternative spelling of options.colours, requires libvips compiled with support for libimagequant (optional, default 256)
  • options.dither Number level of Floyd-Steinberg error diffusion, requires libvips compiled with support for libimagequant (optional, default 1.0)
  • options.force Boolean force PNG output, otherwise attempt to use input format (optional, default true)

Examples

// Convert any input to PNG output
const data = await sharp(input)
  .png()
  .toBuffer();

• Throws Error Invalid options

Returns Sharp

webp

Use these WebP options for output image.

Parameters

• options Object? output options
  • options.quality Number quality, integer 1-100 (optional, default 80)
  • options.alphaQuality Number quality of alpha layer, integer 0-100 (optional, default 100)
  • options.lossless Boolean use lossless compression mode (optional, default false)
  • options.nearLossless Boolean use near_lossless compression mode (optional, default false)
  • options.smartSubsample Boolean use high quality chroma subsampling (optional, default false)
  • options.reductionEffort Number level of CPU effort to reduce file size, integer 0-6 (optional, default 4)
  • options.force Boolean force WebP output, otherwise attempt to use input format (optional, default true)

Examples

// Convert any input to lossless WebP output
const data = await sharp(input)
  .webp({ lossless: true })
  .toBuffer();

• Throws Error Invalid options

Returns Sharp

tiff

Use these TIFF options for output image.

Parameters

• options Object? output options
  • options.quality Number quality, integer 1-100 (optional, default 80)
  • options.force Boolean force TIFF output, otherwise attempt to use input format (optional, default true)
  • options.compression Boolean compression options: lzw, deflate, jpeg, ccittfax4 (optional, default 'jpeg')
  • options.predictor Boolean compression predictor options: none, horizontal, float (optional, default 'horizontal')
  • options.pyramid Boolean write an image pyramid (optional, default false)
  • options.tile Boolean write a tiled tiff (optional, default false)
  • options.tileWidth Boolean horizontal tile size (optional, default 256)
  • options.tileHeight Boolean vertical tile size (optional, default 256)
  • options.xres Number horizontal resolution in pixels/mm (optional, default 1.0)
  • options.yres Number vertical resolution in pixels/mm (optional, default 1.0)
  • options.squash Boolean squash 8-bit images down to 1 bit (optional, default false)

Examples

// Convert SVG input to LZW-compressed, 1 bit per pixel TIFF output
sharp('input.svg')
  .tiff({
    compression: 'lzw',
    squash: true
  })
  .toFile('1-bpp-output.tiff')
  .then(info => { ... });

• Throws Error Invalid options

Returns Sharp

heif

Use these HEIF options for output image.

Support for HEIF (HEIC/AVIF) is experimental. Do not use this in production systems.

Requires a custom, globally-installed libvips compiled with support for libheif.

Most versions of libheif support only the patent-encumbered HEVC compression format.

Parameters

• options Object? output options

  • options.quality Number quality, integer 1-100 (optional, default 80)
  • options.compression Boolean compression format: hevc, avc, jpeg, av1 (optional, default 'hevc')
  • options.lossless Boolean use lossless compression (optional, default false)

• Throws Error Invalid options

Returns Sharp

Meta

• since: 0.23.0

raw

Force output to be raw, uncompressed uint8 pixel data.

Examples

// Extract raw RGB pixel data from JPEG input
const { data, info } = await sharp('input.jpg')
  .raw()
  .toBuffer({ resolveWithObject: true });

Returns Sharp

tile

Use tile-based deep zoom (image pyramid) output. Set the format and options for tile images via the toFormat, jpeg, png or webp functions. Use a .zip or .szi file extension with toFile to write to a compressed archive file format.

Warning: multiple sharp instances concurrently producing tile output can expose a possible race condition in some versions of libgsf.

Parameters

• options Object?
  • options.size Number tile size in pixels, a value between 1 and 8192. (optional, default 256)
  • options.overlap Number tile overlap in pixels, a value between 0 and 8192. (optional, default 0)
  • options.angle Number tile angle of rotation, must be a multiple of 90. (optional, default 0)
  • options.background (String | Object) background colour, parsed by the color module, defaults to white without transparency. (optional, default {r:255,g:255,b:255,alpha:1})
  • options.depth String? how deep to make the pyramid, possible values are onepixel, onetile or one, default based on layout.
  • options.skipBlanks Number threshold to skip tile generation, a value 0 - 255 for 8-bit images or 0 - 65535 for 16-bit images (optional, default -1)
  • options.container String tile container, with value fs (filesystem) or zip (compressed file). (optional, default 'fs')
  • options.layout String filesystem layout, possible values are dz, zoomify or google. (optional, default 'dz')

Examples

sharp('input.tiff')
  .png()
  .tile({
    size: 512
  })
  .toFile('output.dz', function(err, info) {
    // output.dzi is the Deep Zoom XML definition
    // output_files contains 512x512 tiles grouped by zoom level
  });

• Throws Error Invalid parameters

Returns Sharp