🚨 Announcing Vendure v2 Beta

AssetPreviewStrategy

AssetPreviewStrategy

The AssetPreviewStrategy determines how preview images for assets are created. For image assets, this would usually typically involve resizing to sensible dimensions. Other file types could be previewed in a variety of ways, e.g.:

  • waveform images generated for audio files
  • preview images generated for pdf documents
  • watermarks added to preview images

Signature

interface AssetPreviewStrategy extends InjectableStrategy {
  generatePreviewImage(ctx: RequestContext, mimeType: string, data: Buffer): Promise<Buffer>;
}

Extends

Members

generatePreviewImage

method
type:
(ctx: RequestContext, mimeType: string, data: Buffer) => Promise<Buffer>