Sirv

Setup

Install the framework package and the core package for the provider import:

npm install @desource/image @desource/image-svelte

Save this as image.config.ts beside your example component. Replace sample domains and identifiers with your own.

import type { ImageConfig } from '@desource/image';
import { sirvProvider } from '@desource/image/providers/sirv';

export const imageConfig = {
  provider: 'sirv',
  providers: {
    sirv: sirvProvider({
      "baseURL": "https://your-account.sirv.com"
    })
  }
} satisfies ImageConfig;

Registering this provider makes it the default for the configured components. To mix services, register each provider and set provider="sirv" on the image that should use this one.

Image source

Use a path in your Sirv account.

/photo.jpg

Usage

The example uses the shared configuration above and the Svelte image component.

<script lang="ts">
  import { Image, setImageConfig } from '@desource/image-svelte';
  import { imageConfig } from './image.config';

  setImageConfig(imageConfig);
</script>

<Image
  src="/photo.jpg"
  alt="Sample image" width={800} height={500}
  modifiers={{
  "quality": 80,
  "format": "webp"
}}
/>

Provider options

baseURL

Your Sirv account delivery hostname or configured custom domain.

Pass shared defaults such as screens, domains, aliases and presets to the image configuration. Pass provider-specific defaults as modifiers in the provider factory.

Modifiers

Supports width, height, quality, format, fit, profile, canvas, sharpen, frame, rotate, grayscale, watermark and text overlays. Unmapped parameter names are passed through.

Set dimensions on the component and pass service-specific operations through modifiers, as shown above. See the provider source for exact mappings and the service documentation for accepted values.

Provider notes

• Fit fill maps to ignore, inside and outside map to fill, and noUpscaling maps to noup.
• Use profile for a saved group of transformations. Sirv chooses its delivery format when you omit format.