typescript declaration file

[nblthree]

Try npm install @types/colorthief if it exists or add a new declaration (.d.ts) file containing declare module 'colorthief';

unfortunately it doesn't exist

[grahamking]

Here's a colorthief.d.ts that works for me. I put it in src/types and typescript picked it up automatically.

declare module 'colorthief' {
  type Color = [number, number, number];
  export default class ColorThief {
    getColor: (img: HTMLImageElement | null) => Color;
    getPalette: (img: HTMLImageElement | null) => Color[];
  }
}

[HeroadZ]

version with optional parameters:

declare module 'colorthief' {
    export type RGBColor = [number, number, number];
    export default class ColorThief {
        getColor: (img: HTMLImageElement | null, quality: number=10) => RGBColor;
        getPalette: (img: HTMLImageElement | null, colorCount: number=10, quality: number=10) => RGBColor[];
    }
}

[NatoBoram]

getPalette can return null

https://github.com/lokesh/color-thief/blob/4dc3bb0b43250f0d006278998aa91c4156f77cc3/src/color-thief.js#L96

[cabello]

This is what I've been using for over 4 months, create a file colorthief.d.ts in your source directory, a d.ts file only contains type definitions:

declare module "colorthief" {
  export type RGBColor = [number, number, number]
  export default class ColorThief {
    getColor: (
      img: HTMLImageElement | null,
      quality: number = 10,
    ) => RGBColor | null

    getPalette: (
      img: HTMLImageElement | null,
      colorCount: number = 10,
      quality: number = 10,
    ) => RGBColor[] | null
  }
}

[Fasteroid]

Why closed the issue? These are great type definitions here but I'd really love if they actually existed on the real package!