UNPKG

1.22 kBTypeScriptView Raw
1type IFastAverageColorRgba = [number, number, number, number]; // [red, green, blue, opacity]
2
3interface IFastAverageColorOptions {
4 algorithm?: 'simple' | 'sqrt' | 'dominant';
5 mode?: 'precision' | 'speed';
6 step?: number;
7 left?: number;
8 top?: number;
9 width?: number;
10 height?: number;
11 defaultColor?: IFastAverageColorRgba;
12 silent?: boolean;
13}
14
15interface IFastAverageColorResult {
16 value: IFastAverageColorRgba;
17 rgb: string;
18 rgba: string;
19 hex: string;
20 hexa: string;
21 isDark: boolean;
22 isLight: boolean;
23 error?: Error;
24}
25
26interface IFastAverageColor {
27 getColor(resource: HTMLImageElement | HTMLVideoElement | HTMLCanvasElement | null, options?: IFastAverageColorOptions): IFastAverageColorResult;
28 getColorAsync(resource: HTMLImageElement | null, options?: IFastAverageColorOptions): Promise<IFastAverageColorResult>;
29 getColorFromArray4(arr: number[] | Uint8Array, options?: IFastAverageColorOptions): IFastAverageColorRgba;
30 destroy(): void;
31}
32
33interface IFastAverageColorStatic {
34 new (): IFastAverageColor;
35}
36
37declare module 'fast-average-color' {
38 const FastAverageColor: IFastAverageColorStatic;
39
40 export = FastAverageColor;
41}