typescript declaration file
nblthree opened this issue · comments
Try
npm install @types/colorthief
if it exists or add a new declaration (.d.ts) file containingdeclare module 'colorthief';
unfortunately it doesn't exist
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[];
}
}
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[];
}
}
getPalette
can return null
color-thief/src/color-thief.js
Line 96 in 4dc3bb0
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
}
}