Skip to content

API de Utilitários

Sharp fornece várias funções utilitárias para auxiliar no processamento de imagem e conversão de formato.

Detecção de Formato

Detectar Formatos Suportados

javascript
import sharp from 'sharp';

// Obter formatos de entrada suportados
console.log('Formatos de entrada suportados:', sharp.format);

// Obter formatos de saída suportados
console.log('Formatos de saída suportados:', sharp.format);

Verificar Formato de Arquivo

javascript
async function checkImageFormat(filePath) {
  try {
    const metadata = await sharp(filePath).metadata();
    return {
      format: metadata.format,
      width: metadata.width,
      height: metadata.height,
      channels: metadata.channels
    };
  } catch (error) {
    return { error: error.message };
  }
}

Espaço de Cores

Constantes de Espaço de Cores

javascript
// Espaços de cores disponíveis
sharp.colourspace.srgb      // sRGB
sharp.colourspace.rgb       // RGB
sharp.colourspace.cmyk      // CMYK
sharp.colourspace.grey      // Escala de cinza
sharp.colourspace.multiband // Multibanda
sharp.colourspace.lab       // Lab
sharp.colourspace.xyz       // XYZ
sharp.colourspace.ycbcr     // YCbCr

Conversão de Espaço de Cores

javascript
// Converter para escala de cinza
sharp('input.jpg')
  .grayscale()
  .toFile('output.jpg');

// Converter para CMYK
sharp('input.jpg')
  .toColourspace(sharp.colourspace.cmyk)
  .tiff()
  .toFile('output.tiff');

Kernel e Filtros

Kernel de Redimensionamento

javascript
// Kernels de redimensionamento disponíveis
sharp.kernel.nearest      // Vizinho mais próximo
sharp.kernel.cubic        // Interpolação cúbica
sharp.kernel.mitchell     // Mitchell-Netravali
sharp.kernel.lanczos2     // Lanczos 2-lobed
sharp.kernel.lanczos3     // Lanczos 3-lobed (padrão)

Usar Kernel Personalizado

javascript
// Usar kernel de redimensionamento personalizado
sharp('input.jpg')
  .resize(300, 200, { kernel: sharp.kernel.lanczos3 })
  .toFile('output.jpg');

Constantes de Posição

Opções de Posição

javascript
// Opções de posição disponíveis
sharp.position.top         // Topo
sharp.position.right       // Direita
sharp.position.bottom      // Base
sharp.position.left        // Esquerda
sharp.position.center      // Centro (padrão)
sharp.position.centre      // Centro (ortografia britânica)
sharp.position.north       // Norte (topo)
sharp.position.east        // Leste (direita)
sharp.position.south       // Sul (base)
sharp.position.west        // Oeste (esquerda)
sharp.position.northeast   // Nordeste
sharp.position.southeast   // Sudeste
sharp.position.southwest   // Sudoeste
sharp.position.northwest   // Noroeste

Operações de Canal

Constantes de Canal

javascript
// Constantes de canal
sharp.channel.red          // Canal vermelho
sharp.channel.green        // Canal verde
sharp.channel.blue         // Canal azul
sharp.channel.alpha        // Canal de transparência
sharp.channel.grey         // Canal de escala de cinza

Operações de Canal

javascript
// Extrair canal vermelho
sharp('input.jpg')
  .extractChannel(sharp.channel.red)
  .toFile('red-channel.jpg');

// Extrair todos os canais
const channels = await sharp('input.jpg').separate();

Tratamento de Erros

Tipos de Erro

javascript
// Erros comuns do Sharp
sharp.errors.InputError     // Erro de entrada
sharp.errors.ProcessError   // Erro de processamento
sharp.errors.OutputError    // Erro de saída

Exemplo de Tratamento de Erros

javascript
try {
  await sharp('input.jpg')
    .resize(300, 200)
    .toFile('output.jpg');
} catch (error) {
  if (error instanceof sharp.errors.InputError) {
    console.error('Erro no arquivo de entrada:', error.message);
  } else if (error instanceof sharp.errors.ProcessError) {
    console.error('Erro de processamento:', error.message);
  } else if (error instanceof sharp.errors.OutputError) {
    console.error('Erro de saída:', error.message);
  } else {
    console.error('Erro desconhecido:', error.message);
  }
}

Monitoramento de Performance

Uso de Memória

javascript
// Obter uso de memória do Sharp
const stats = sharp.cache();
console.log('Estatísticas de cache:', stats);

// Limpar cache
sharp.cache(false);

Controle de Concorrência

javascript
// Definir limite de concorrência
sharp.concurrency(4); // Máximo de 4 operações concorrentes

// Obter número atual de concorrência
console.log('Concorrência atual:', sharp.concurrency());

Funções Utilitárias

Criar Imagem de Teste

javascript
// Criar imagem de cor sólida
const redImage = sharp({
  create: {
    width: 300,
    height: 200,
    channels: 3,
    background: { r: 255, g: 0, b: 0 }
  }
});

// Criar imagem gradiente
const gradient = sharp({
  create: {
    width: 300,
    height: 200,
    channels: 3,
    background: { r: 0, g: 0, b: 0 }
  }
});

Composição de Imagem

javascript
// Compositar múltiplas imagens
const composite = await sharp('background.jpg')
  .composite([
    {
      input: 'overlay.png',
      top: 100,
      left: 100
    }
  ])
  .jpeg()
  .toBuffer();

Ferramentas de Processamento em Lote

Redimensionamento em Lote

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

async function batchResize(inputDir, outputDir, width, height) {
  const files = await fs.readdir(inputDir);
  
  for (const file of files) {
    if (file.match(/\.(jpg|jpeg|png|webp)$/i)) {
      try {
        await sharp(`${inputDir}/${file}`)
          .resize(width, height)
          .jpeg({ quality: 80 })
          .toFile(`${outputDir}/${file}`);
        
        console.log(`Processamento concluído: ${file}`);
      } catch (error) {
        console.error(`Falha ao processar ${file}:`, error.message);
      }
    }
  }
}

Conversão de Formato em Lote

javascript
async function batchConvert(inputDir, outputDir, format) {
  const files = await fs.readdir(inputDir);
  
  for (const file of files) {
    if (file.match(/\.(jpg|jpeg|png|webp)$/i)) {
      const outputFile = file.replace(/\.[^.]+$/, `.${format}`);
      
      try {
        const image = sharp(`${inputDir}/${file}`);
        
        switch (format) {
          case 'jpg':
          case 'jpeg':
            await image.jpeg({ quality: 80 }).toFile(`${outputDir}/${outputFile}`);
            break;
          case 'png':
            await image.png().toFile(`${outputDir}/${outputFile}`);
            break;
          case 'webp':
            await image.webp({ quality: 80 }).toFile(`${outputDir}/${outputFile}`);
            break;
          case 'avif':
            await image.avif({ quality: 80 }).toFile(`${outputDir}/${outputFile}`);
            break;
        }
        
        console.log(`Conversão concluída: ${file} -> ${outputFile}`);
      } catch (error) {
        console.error(`Falha na conversão ${file}:`, error.message);
      }
    }
  }
}

Ferramentas de Validação

Validar Integridade da Imagem

javascript
async function validateImage(filePath) {
  try {
    const metadata = await sharp(filePath).metadata();
    
    // Verificar propriedades básicas
    if (!metadata.width || !metadata.height) {
      return { valid: false, error: 'Faltam informações de dimensão' };
    }
    
    if (metadata.width <= 0 || metadata.height <= 0) {
      return { valid: false, error: 'Dimensões inválidas' };
    }
    
    if (!metadata.format) {
      return { valid: false, error: 'Faltam informações de formato' };
    }
    
    // Tentar processar imagem
    await sharp(filePath).resize(1, 1).toBuffer();
    
    return { valid: true, metadata };
  } catch (error) {
    return { valid: false, error: error.message };
  }
}

Verificar Tamanho do Arquivo

javascript
const fs = require('fs');

function checkFileSize(filePath, maxSize = 10 * 1024 * 1024) { // 10MB
  const stats = fs.statSync(filePath);
  const sizeInMB = stats.size / (1024 * 1024);
  
  return {
    size: stats.size,
    sizeInMB,
    isValid: stats.size <= maxSize,
    maxSizeInMB: maxSize / (1024 * 1024)
  };
}

Lançado sob a Licença Apache 2.0.