sharp
    Overview
    Documentation
    Insights
    Code
    Contributors
    Dependencies
    Alternatives

sharp

High performance Node.js image processing, the fastest module to resize JPEG, PNG, WebP and TIFF images

0.23.0  •  Published 4 months ago  •  by Lovell Fuller  •  Apache License 2.0

sharp logo
npm install sharp

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 and WebP images of varying dimensions.

Resizing an image is typically 4x-5x faster than using the quickest ImageMagick and GraphicsMagick settings.

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 64-bit OS X, Windows and Linux systems running Node versions 8, 10 and 12 do not require any additional install or runtime dependencies.

Examples

const sharp = require('sharp');

Callback

sharp(inputBuffer)
  .resize(320, 240)
  .toFile('output.webp', (err, info) => { ... });

Promise

sharp('input.jpg')
  .rotate()
  .resize(200)
  .toBuffer()
  .then( data => { ... })
  .catch( err => { ... });

Async/await

const semiTransparentRedPng = await sharp({
  create: {
    width: 48,
    height: 48,
    channels: 4,
    background: { r: 255, g: 0, b: 0, alpha: 0.5 }
  }
})
  .png()
  .toBuffer();

Stream

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

const roundedCornerResizer =
  sharp()
    .resize(200, 200)
    .composite([{
      input: roundedCorners,
      blend: 'dest-in'
    }])
    .png();

readableStream
  .pipe(roundedCornerResizer)
  .pipe(writableStream);

Test Coverage

Documentation

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

Contributing

A guide for contributors covers reporting bugs, requesting features and submitting code changes.

Licensing

Copyright 2013, 2014, 2015, 2016, 2017, 2018, 2019 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.

Popularity

Weekly Downloads
510.9K
Stars
14.8K

Maintenance

Development

Last ver 4 months ago
Created 6 years ago
Last commit 6 days ago
2 days between commits

Technology

Node version: 10.13.0
498.1K unpacked

Compliance

Apache License 2.0
OSI Approved
0 vulnerabilities

Contributors

109 contributors
Lovell Fuller
Maintainer, 853 commits, 160 merges, 1 PRs
Works at Styling Ltd, Dispatches LLP
Matt Hirsch
12 commits, 16 PRs
Andreas Lind
10 commits, 9 PRs
Works at peakon
Pierre Inglebert
8 commits, 10 PRs
Daniel Gasienica
8 commits
Brandon Aaron
5 commits, 6 PRs

Tags

jpeg
png
webp
tiff
gif
svg
dzi
image
resize
thumbnail
crop
embed
libvips
vips
Ready for the next level?
Join Devstore's founding team to help us build the ultimate open-source app store, work with the latest technologies, and enjoy great culture, impact and autonomy
© 2019 Devstore, Inc.
Devstore helps developers find and use open-source packages, so they can focus on building amazing things