Basic Examples

Here are some basic Sharp usage examples to help you get started quickly.

Image Resizing

Simple Resize

import sharp from 'sharp';

// Resize to specific dimensions
await sharp('input.jpg')
  .resize(300, 200)
  .toFile('output.jpg');

Maintain Aspect Ratio

// Specify width only, height auto-calculated
await sharp('input.jpg')
  .resize(300)
  .toFile('output.jpg');

// Specify height only, width auto-calculated
await sharp('input.jpg')
  .resize(null, 200)
  .toFile('output.jpg');

Fit Modes

// cover: Maintain aspect ratio, crop excess
await sharp('input.jpg')
  .resize(300, 200, { fit: 'cover' })
  .toFile('output.jpg');

// contain: Maintain aspect ratio, add background
await sharp('input.jpg')
  .resize(300, 200, { fit: 'contain', background: { r: 255, g: 255, b: 255 } })
  .toFile('output.jpg');

Format Conversion

JPEG to PNG

await sharp('input.jpg')
  .png()
  .toFile('output.png');

PNG to JPEG

await sharp('input.png')
  .jpeg({ quality: 80 })
  .toFile('output.jpg');

Convert to WebP

await sharp('input.jpg')
  .webp({ quality: 80 })
  .toFile('output.webp');

Convert to AVIF

await sharp('input.jpg')
  .avif({ quality: 80 })
  .toFile('output.avif');

Image Rotation

Rotate 90 Degrees

await sharp('input.jpg')
  .rotate(90)
  .toFile('output.jpg');

Auto-rotate (Based on EXIF)

await sharp('input.jpg')
  .rotate()  // Auto-rotate
  .toFile('output.jpg');

Image Flipping

Vertical Flip

await sharp('input.jpg')
  .flip()
  .toFile('output.jpg');

Horizontal Flip

await sharp('input.jpg')
  .flop()
  .toFile('output.jpg');

Image Cropping

Crop Specific Region

await sharp('input.jpg')
  .extract({ left: 100, top: 100, width: 300, height: 200 })
  .toFile('output.jpg');

Crop and Resize

await sharp('input.jpg')
  .extract({ left: 100, top: 100, width: 300, height: 200 })
  .resize(150, 100)
  .toFile('output.jpg');

Filter Effects

Grayscale Conversion

await sharp('input.jpg')
  .grayscale()
  .toFile('output.jpg');

Blur Effect

await sharp('input.jpg')
  .blur(5)
  .toFile('output.jpg');

Sharpen Effect

await sharp('input.jpg')
  .sharpen()
  .toFile('output.jpg');

Color Negation

await sharp('input.jpg')
  .negate()
  .toFile('output.jpg');

Color Adjustments

Brightness Adjustment

await sharp('input.jpg')
  .modulate({ brightness: 1.2 })
  .toFile('output.jpg');

Saturation Adjustment

await sharp('input.jpg')
  .modulate({ saturation: 0.8 })
  .toFile('output.jpg');

Hue Adjustment

await sharp('input.jpg')
  .modulate({ hue: 180 })
  .toFile('output.jpg');

Transparency Handling

Add Transparency

await sharp('input.jpg')
  .ensureAlpha()
  .png()
  .toFile('output.png');

Remove Transparency

await sharp('input.png')
  .flatten({ background: { r: 255, g: 255, b: 255 } })
  .jpeg()
  .toFile('output.jpg');

Quality Settings

JPEG Quality

// High quality
await sharp('input.png')
  .jpeg({ quality: 95 })
  .toFile('output.jpg');

// Medium quality
await sharp('input.png')
  .jpeg({ quality: 80 })
  .toFile('output.jpg');

// Low quality (smaller files)
await sharp('input.png')
  .jpeg({ quality: 50 })
  .toFile('output.jpg');

WebP Quality

await sharp('input.jpg')
  .webp({ quality: 80, lossless: false })
  .toFile('output.webp');

Chaining Operations

Multiple Operations Combination

await sharp('input.jpg')
  .resize(800, 600)
  .rotate(90)
  .blur(2)
  .sharpen()
  .jpeg({ quality: 80 })
  .toFile('output.jpg');

Conditional Processing

const image = sharp('input.jpg').resize(300, 200);

if (needsBlur) {
  image.blur(3);
}

if (needsSharpen) {
  image.sharpen();
}

await image.jpeg({ quality: 80 }).toFile('output.jpg');

Error Handling

Basic Error Handling

try {
  await sharp('input.jpg')
    .resize(300, 200)
    .toFile('output.jpg');
} catch (error) {
  console.error('Image processing failed:', error.message);
}

Check File Existence

const fs = require('fs');

if (fs.existsSync('input.jpg')) {
  await sharp('input.jpg')
    .resize(300, 200)
    .toFile('output.jpg');
} else {
  console.error('Input file does not exist');
}

Stream Processing

Read from Stream

const fs = require('fs');

fs.createReadStream('input.jpg')
  .pipe(sharp().resize(300, 200))
  .pipe(fs.createWriteStream('output.jpg'));

Output to Stream

const fs = require('fs');

sharp('input.jpg')
  .resize(300, 200)
  .jpeg({ quality: 80 })
  .pipe(fs.createWriteStream('output.jpg'));

Buffer Processing

Create from Buffer

const fs = require('fs');

const inputBuffer = fs.readFileSync('input.jpg');
const outputBuffer = await sharp(inputBuffer)
  .resize(300, 200)
  .jpeg({ quality: 80 })
  .toBuffer();

fs.writeFileSync('output.jpg', outputBuffer);

Output to Buffer

const buffer = await sharp('input.jpg')
  .resize(300, 200)
  .jpeg({ quality: 80 })
  .toBuffer();

// Can use buffer directly
console.log('Image size:', buffer.length);

Batch Processing

Process All Images in Directory

const fs = require('fs').promises;
const path = require('path');

async function processImages(inputDir, outputDir) {
  const files = await fs.readdir(inputDir);

  for (const file of files) {
    if (file.match(/\.(jpg|jpeg|png|webp)$/i)) {
      try {
        await sharp(path.join(inputDir, file))
          .resize(300, 200)
          .jpeg({ quality: 80 })
          .toFile(path.join(outputDir, file));

        console.log(`Processing completed: ${file}`);
      } catch (error) {
        console.error(`Processing failed ${file}:`, error.message);
      }
    }
  }
}

processImages('./input', './output');

Related Links

• Advanced Examples
• Performance Examples
• API Reference
• Installation Guide