@danielbiegler/vendure-plugin-blurry-image-lazy-loading/dist/types.d.ts

Generates image hashes for displaying blurry previews when loading images on the frontend.

import { PreviewImageHashStrategy } from "./config/PreviewImageHashStrategy";
import { CUSTOMFIELD_NAME } from "./constants";
/**
 * These are the configuration options for the plugin.
 *
 * @category Plugin
 */
export interface PluginPreviewImageHashOptions {
    /**
     * Makes the plugin subscribe to the `AssetEvent` of type `"created"` and adds the hashing to the dedicated job queue.
     * This ensures every new asset gets automatically hashed after being uploaded to your Vendure instance.
     *
     * @default true
     */
    enqueueHashingAfterAssetCreation?: boolean;
    /**
     * Determines the way assets will be hashed
     *
     * 1. ThumbHashStrategy supports transparency and approximate aspect ratios
     * 2. BlurHash is older and more widely used, but does not support transparency nor encoding aspect ratio
     *
     * @see ThumbHash https://github.com/evanw/thumbhash
     * @see BlurHash https://github.com/woltapp/blurhash
     */
    hashingStrategy: PreviewImageHashStrategy;
}
declare module "@vendure/core/dist/entity/custom-entity-fields" {
    interface CustomAssetFields {
        /** Technically its nullable, but typescript complains that the type is `string | undefined` */
        [CUSTOMFIELD_NAME]: string | null;
    }
}