30-seconds-of-code/node_modules/sharp/docs/api-constructor.md

Sharp

Parameters

• input (Buffer | String)? if present, can be a Buffer containing JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data, or a String containing the path to an JPEG, PNG, WebP, GIF, SVG or TIFF image file. JPEG, PNG, WebP, GIF, SVG, TIFF or raw pixel image data can be streamed into the object when not present.
• options Object? if present, is an Object with optional attributes.
  • options.failOnError Boolean by default halt processing and raise an error when loading invalid images. Set this flag to false if you'd rather apply a "best effort" to decode images, even if the data is corrupt or invalid. (optional, default true)
  • options.density Number number representing the DPI for vector images. (optional, default 72)
  • options.pages Number number of pages to extract for multi-page input (GIF, TIFF, PDF), use -1 for all pages. (optional, default 1)
  • options.page Number page number to start extracting from for multi-page input (GIF, TIFF, PDF), zero based. (optional, default 0)
  • options.raw Object? describes raw pixel input image data. See raw() for pixel ordering.
    • options.raw.width Number?
    • options.raw.height Number?
    • options.raw.channels Number? 1-4
  • options.create Object? describes a new image to be created.
    • options.create.width Number?
    • options.create.height Number?
    • options.create.channels Number? 3-4
    • options.create.background (String | Object)? parsed by the color module to extract values for red, green, blue and alpha.

Examples

sharp('input.jpg')
  .resize(300, 200)
  .toFile('output.jpg', function(err) {
    // output.jpg is a 300 pixels wide and 200 pixels high image
    // containing a scaled and cropped version of input.jpg
  });

// Read image data from readableStream,
// resize to 300 pixels wide,
// emit an 'info' event with calculated dimensions
// and finally write image data to writableStream
var transformer = sharp()
  .resize(300)
  .on('info', function(info) {
    console.log('Image height is ' + info.height);
  });
readableStream.pipe(transformer).pipe(writableStream);

// Create a blank 300x200 PNG image of semi-transluent red pixels
sharp({
  create: {
    width: 300,
    height: 200,
    channels: 4,
    background: { r: 255, g: 0, b: 0, alpha: 0.5 }
  }
})
.png()
.toBuffer()
.then( ... );

• Throws Error Invalid parameters

Returns Sharp

format

An Object containing nested boolean values representing the available input and output formats/methods.

Examples

console.log(sharp.format);

Returns Object

versions

An Object containing the version numbers of libvips and its dependencies.

Examples

console.log(sharp.versions);

queue

An EventEmitter that emits a change event when a task is either:

• queued, waiting for libuv to provide a worker thread
• complete

Examples

sharp.queue.on('change', function(queueLength) {
  console.log('Queue contains ' + queueLength + ' task(s)');
});