blurhash-esm

    1.1.3 • Public • Published

    blurhash-esm

    NPM Version NPM Downloads

    Fork of the excellent Wolt BlurHash that exports ES Module. Because maintainers of the original haven't merged the PR since summer 2020.

    Install

    npm install --save blurhash-esm

    API

    decode(blurhash-esm: string, width: number, height: number, punch?: number) => Uint8ClampedArray

    Decodes a blurhash string to pixels

    Example

    import { decode } from 'blurhash-esm';
    
    const pixels = decode('LEHV6nWB2yk8pyo0adR*.7kCMdnj', 32, 32);
    
    const canvas = document.createElement('canvas');
    const ctx = canvas.getContext('2d');
    const imageData = ctx.createImageData(width, height);
    imageData.data.set(pixels);
    ctx.putImageData(imageData, 0, 0);
    document.body.append(canvas);

    encode(pixels: Uint8ClampedArray, width: number, height: number, componentX: number, componentY: number) => string

    Encodes pixels to a blurhash string

    import { encode } from 'blurhash-esm';
    
    const loadImage = async src =>
      new Promise((resolve, reject) => {
        const img = new Image();
        img.onload = () => resolve(img);
        img.onerror = (...args) => reject(args);
        img.src = src;
      });
    
    const getImageData = image => {
      const canvas = document.createElement('canvas');
      canvas.width = image.width;
      canvas.height = image.height;
      const context = canvas.getContext('2d');
      context.drawImage(image, 0, 0);
      return context.getImageData(0, 0, image.width, image.height);
    };
    
    const encodeImageToBlurhash = async imageUrl => {
      const image = await loadImage(imageUrl);
      const imageData = getImageData(image);
      return encode(imageData.data, imageData.width, imageData.height, 4, 4);
    };

    isBlurhashValid(blurhash: string) => { result: boolean; errorReason?: string }

    import { isBlurhashValid } from 'blurhash-esm';
    
    const validRes = isBlurhashValid('LEHV6nWB2yk8pyo0adR*.7kCMdnj');
    // { result: true }
    
    const invalidRes = isBlurhashValid('???');
    // { result: false, errorReason: 'The blurhash string must be at least 6 characters' }

    Install

    npm i blurhash-esm

    Homepage

    blurhash.com

    DownloadsWeekly Downloads

    1

    Version

    1.1.3

    License

    MIT

    Unpacked Size

    12.5 kB

    Total Files

    9

    Last publish

    Collaborators

    • mikekovarik