Skip to content

API de Utilidades

Sharp proporciona múltiples funciones de utilidad para ayudar en el procesamiento de imágenes y conversión de formatos.

Detección de Formatos

Detectar Formatos Soportados

javascript
import sharp from 'sharp';

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

// Obtener formatos de salida soportados
console.log('Formatos de salida soportados:', sharp.format);

Verificar Formato de Archivo

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 };
  }
}

Espacios de Color

Constantes de Espacios de Color

javascript
// Espacios de color disponibles
sharp.colourspace.srgb      // sRGB
sharp.colourspace.rgb        // RGB
sharp.colourspace.cmyk      // CMYK
sharp.colourspace.grey      // Escala de grises
sharp.colourspace.multiband // Multibanda
sharp.colourspace.lab       // Lab
sharp.colourspace.xyz       // XYZ
sharp.colourspace.ycbcr     // YCbCr

Conversión de Espacios de Color

javascript
// Convertir a escala de grises
sharp('input.jpg')
  .grayscale()
  .toFile('output.jpg');

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

Kernels y Filtros

Kernels de Redimensionamiento

javascript
// Kernels de redimensionamiento disponibles
sharp.kernel.nearest      // Vecino más cercano
sharp.kernel.cubic        // Interpolación cúbica
sharp.kernel.mitchell     // Mitchell-Netravali
sharp.kernel.lanczos2     // Lanczos 2-lobed
sharp.kernel.lanczos3     // Lanczos 3-lobed (por defecto)

Usar Kernel Personalizado

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

Constantes de Posición

Opciones de Posición

javascript
// Opciones de posición disponibles
sharp.position.top         // Superior
sharp.position.right       // Derecha
sharp.position.bottom      // Inferior
sharp.position.left       // Izquierda
sharp.position.center      // Centro (por defecto)
sharp.position.centre      // Centro (ortografía británica)
sharp.position.north       // Norte (superior)
sharp.position.east        // Este (derecha)
sharp.position.south       // Sur (inferior)
sharp.position.west        // Oeste (izquierda)
sharp.position.northeast   // Noreste
sharp.position.southeast   // Sureste
sharp.position.southwest   // Suroeste
sharp.position.northwest   // Noroeste

Operaciones de Canales

Constantes de Canales

javascript
// Constantes de canales
sharp.channel.red          // Canal rojo
sharp.channel.green        // Canal verde
sharp.channel.blue         // Canal azul
sharp.channel.alpha        // Canal de transparencia
sharp.channel.grey         // Canal de grises

Operaciones de Canales

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

// Extraer todos los canales
const channels = await sharp('input.jpg').separate();

Manejo de Errores

Tipos de Error

javascript
// Errores comunes de Sharp
sharp.errors.InputError     // Error de entrada
sharp.errors.ProcessError   // Error de procesamiento
sharp.errors.OutputError    // Error de salida

Ejemplo de Manejo de Errores

javascript
try {
  await sharp('input.jpg')
    .resize(300, 200)
    .toFile('output.jpg');
} catch (error) {
  if (error instanceof sharp.errors.InputError) {
    console.error('Error de archivo de entrada:', error.message);
  } else if (error instanceof sharp.errors.ProcessError) {
    console.error('Error de procesamiento:', error.message);
  } else if (error instanceof sharp.errors.OutputError) {
    console.error('Error de salida:', error.message);
  } else {
    console.error('Error desconocido:', error.message);
  }
}

Monitoreo de Rendimiento

Uso de Memoria

javascript
// Obtener uso de memoria de Sharp
const stats = sharp.cache();
console.log('Estadísticas de caché:', stats);

// Limpiar caché
sharp.cache(false);

Control de Concurrencia

javascript
// Establecer límite de concurrencia
sharp.concurrency(4); // Máximo 4 operaciones concurrentes

// Obtener concurrencia actual
console.log('Concurrencia actual:', sharp.concurrency());

Funciones de Utilidad

Crear Imagen de Prueba

javascript
// Crear imagen de color sólido
const redImage = sharp({
  create: {
    width: 300,
    height: 200,
    channels: 3,
    background: { r: 255, g: 0, b: 0 }
  }
});

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

Composición de Imágenes

javascript
// Componer múltiples imágenes
const composite = await sharp('background.jpg')
  .composite([
    {
      input: 'overlay.png',
      top: 100,
      left: 100
    }
  ])
  .jpeg()
  .toBuffer();

Herramientas de Procesamiento por Lotes

Redimensionamiento por Lotes

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(`Procesamiento completado: ${file}`);
      } catch (error) {
        console.error(`Error al procesar ${file}:`, error.message);
      }
    }
  }
}

Conversión de Formatos por Lotes

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(`Conversión completada: ${file} -> ${outputFile}`);
      } catch (error) {
        console.error(`Error al convertir ${file}:`, error.message);
      }
    }
  }
}

Herramientas de Validación

Validar Integridad de Imagen

javascript
async function validateImage(filePath) {
  try {
    const metadata = await sharp(filePath).metadata();
    
    // Verificar propiedades básicas
    if (!metadata.width || !metadata.height) {
      return { valid: false, error: 'Falta información de dimensiones' };
    }
    
    if (metadata.width <= 0 || metadata.height <= 0) {
      return { valid: false, error: 'Dimensiones inválidas' };
    }
    
    if (!metadata.format) {
      return { valid: false, error: 'Falta información de formato' };
    }
    
    // Intentar procesar imagen
    await sharp(filePath).resize(1, 1).toBuffer();
    
    return { valid: true, metadata };
  } catch (error) {
    return { valid: false, error: error.message };
  }
}

Verificar Tamaño de Archivo

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)
  };
}

Enlaces Relacionados

Liberado bajo la Licencia Apache 2.0.