Repository files navigation

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

It can be used with all JavaScript runtimesthat provide support for Node-API v9, includingNode.js (^18.17.0 or >= 20.3.0), Deno and Bun.

Resizing an image is typically 4x-5x faster than using thequickest ImageMagick and GraphicsMagick settingsdue to its use oflibvips.

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 asrotation, extraction, compositing and gamma correction are available.

Most modern macOS, Windows and Linux systemsdo not require any additional install or runtime dependencies.

Visitsharp.pixelplumbing.com for completeinstallation instructions,API documentation,benchmark tests andchangelog.

npm install sharp

constsharp=require('sharp');

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

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

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

constroundedCorners=Buffer.from('<svg><rect x="0" y="0" width="200" height="200" rx="50" ry="50"/></svg>');constroundedCornerResizer=sharp().resize(200,200).composite([{input:roundedCorners,blend:'dest-in'}]).png();readableStream.pipe(roundedCornerResizer).pipe(writableStream);

Aguide for contributorscovers reporting bugs, requesting features and submitting code changes.

Copyright 2013 Lovell Fuller and others.

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 athttps://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, softwaredistributed 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 andlimitations under the License.