Sharp

High performance Node.js image processing, the fastest module to resize JPE...

Image processing
lovell/sharpsharp.pixelplumbing.comsharp

README

sharp


sharp logo

The typical use case for this high speed Node.js module
is to convert large images in common formats to
smaller, web-friendly JPEG, PNG, WebP, GIF and AVIF images of varying dimensions.

Resizing an image is typically 4x-5x faster than using the
quickest ImageMagick and GraphicsMagick settings
due to its use of libvips.

Colour spaces, embedded ICC profiles and alpha transparency channels are all handled correctly.
Lanczos resampling ensures quality is not sacrificed for speed.

As well as image resizing, operations such as
rotation, extraction, compositing and gamma correction are available.

Most modern macOS, Windows and Linux systems running Node.js >= 14.15.0
do not require any additional install or runtime dependencies.

Documentation


Visit sharp.pixelplumbing.com for complete
installation instructions,
API documentation,
benchmark tests and
changelog.

Examples


  1. ```sh
  2. npm install sharp
  3. ```

  1. ``` js
  2. const sharp = require('sharp');
  3. ```

Callback


  1. ``` js
  2. sharp(inputBuffer)
  3.   .resize(320, 240)
  4.   .toFile('output.webp', (err, info) => { ... });
  5. ```

Promise


  1. ``` js
  2. sharp('input.jpg')
  3.   .rotate()
  4.   .resize(200)
  5.   .jpeg({ mozjpeg: true })
  6.   .toBuffer()
  7.   .then( data => { ... })
  8.   .catch( err => { ... });
  9. ```

Async/await


  1. ``` js
  2. const semiTransparentRedPng = await sharp({
  3.   create: {
  4.     width: 48,
  5.     height: 48,
  6.     channels: 4,
  7.     background: { r: 255, g: 0, b: 0, alpha: 0.5 }
  8.   }
  9. })
  10.   .png()
  11.   .toBuffer();
  12. ```

Stream


  1. ``` js
  2. const roundedCorners = Buffer.from(
  3.   '<svg><rect x="0" y="0" width="200" height="200" rx="50" ry="50"/></svg>'
  4. );

  6. const roundedCornerResizer =
  7.   sharp()
  8.     .resize(200, 200)
  9.     .composite([{
  10.       input: roundedCorners,
  11.       blend: 'dest-in'
  12.     }])
  13.     .png();

  15. readableStream
  16.   .pipe(roundedCornerResizer)
  17.   .pipe(writableStream);
  18. ```

Contributing


A guide for contributors
covers reporting bugs, requesting features and submitting code changes.
Node-API v5

Licensing


Copyright 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022 Lovell Fuller and contributors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.