Skip to content

Referência da API ​

Referência completa de todos os exports públicos de @pantanal/pixu.

typescript
import {
  compress,
  compressBatch,
  compressStream,
  PixuCompressor,
  validateImage,
  isValidImage,
  analyzeImage,
  getPresetOptions,
  applyPreset,
  applyFilter,
  applyWatermark,
  calculateSmartCrop,
  optimizePNG,
  convertFormat,
  detectTransparency,
  shouldConvertToJPEG,
  analyzeImageContent,
  getSmartQuality,
  getOptimizationHints,
  estimateCompressionSavings,
  generateResponsiveImages,
  generateSrcset,
  generateSizes,
  analyzeColorSpace,
  normalizeToSRGB,
  supportsWideGamut,
  isProgressiveJPEG,
  supportsProgressiveJPEG,
  PerformanceMonitor,
  formatBytes,
  formatDuration,
  getMemoryInfo,
  shouldUseStreaming,
  calculateChunkSize,
  AdvancedBatchProcessor,
  PluginManager,
  canvasToPixu,
  isPixuSupported,
  PIXU_MIME_TYPE,
  buildDownloadName,
  estimatePixuCompression,
} from '@pantanal/pixu'

Núcleo ​

ExportDescrição
compressComprime uma imagem
compressBatchComprime várias imagens com concorrência
compressStreamPipeline com async generator
PixuCompressorAPI de classe: abort, plugins, reuso
AdvancedBatchProcessorRetry, prioridade, pause/cancel

Validação e análise ​

ExportDescrição
validateImage / isValidImageChecagens prévias
analyzeImageAnálise de conteúdo e recomendações
analyzeImageContent / getSmartQualityHelpers de smart quality

Transformações e helpers ​

ExportDescrição
PresetsgetPresetOptions, applyPreset
FiltersapplyFilter
WatermarkapplyWatermark
Smart cropcalculateSmartCrop
PNG optimizationoptimizePNG
Format conversionconvertFormat e helpers de transparência
PIXU formatEncode / constantes / estimativas / preview
Encode PIXUCaminho TECR — saída nativa .webp / .jpg
ResponsivegenerateResponsiveImages, helpers de srcset
Optimization hintsDicas e estimativa de ganho
Color spaceHelpers sRGB / wide-gamut
Progressive JPEGDetectar suporte progressivo
PerformancePerformanceMonitor, formatadores
MemoryHelpers de memória / streaming
PluginsPluginManager, Plugin

Tipos ​

Veja Tipos para CompressionOptions, CompressionResult e unions relacionadas.

Export default ​

typescript
import pixu from '@pantanal/pixu'

await pixu.compress(file, { quality: 0.8 })

O export default é uma instância compartilhada de PixuCompressor.

Publicado sob a licença MIT.