Image converter

Variants images are generates by sharp module and require installation:

npm

npm install sharp

pnpm

pnpm install sharp

yarn

yarn add sharp

Configuration

// config/attachment.ts
const attachmentConfig = defineConfig({
  converters: {
    large: { 
      converter: () => import('@jrmc/adonis-attachment/converters/image_converter'), 
      options: {
        resize: 1280,
      }
    }
  }
})

Format

The default format is webp, for change, use options format:

const attachmentConfig = defineConfig({
  converters: {
    thumbnail: { 
      converter: () => import('@jrmc/adonis-attachment/converters/image_converter'),
      options: {
        resize: 300,
        format: 'jpeg', 
      }
    }
  }
})

Options format is string or object [ format, options ] details in documentation : sharp api outpout

Sample for personalize image quality:

const attachmentConfig = defineConfig({
  converters: {
    thumbnail: { 
      converter: () => import('@jrmc/adonis-attachment/converters/image_converter'),
      options: {
        resize: 300,
        format: {
          format: 'jpeg',
          options: {
            quality: 80
          }
        }
      }
    }
  }
})

ReSize

Options resize is number or object(options) details in documentation : sharp api resize

Sample:

import { defineConfig } from '@jrmc/adonis-attachment'
import { InferConverters } from '@jrmc/adonis-attachment/types/config'
import sharp from 'sharp'

const attachmentConfig = defineConfig({
  converters: {
    thumbnail: {
      converter: () => import('@jrmc/adonis-attachment/converters/image_converter'),
      options: {
        format: 'jpeg',
        resize: { // https://sharp.pixelplumbing.com/api-resize
          width: 400,
          height: 400,
          fit: sharp.fit.cover,
          position: 'top'
        },
      }
    }
  }
})

export default attachmentConfig

declare module '@jrmc/adonis-attachment' {
  interface AttachmentVariants extends InferConverters<typeof attachmentConfig> {}
}