@akashshyam/color-utilities/lib/colorConversion.d.ts

A handy, tiny utility library compatible with typescript. We offer color conversions, color validation, constrast comparison etc

export declare type Color = number | string;
export declare type ColorFormat = 'hex' | 'rgb' | 'hsl';
/**
 * Converts a hex string into RGB
 * @param hex A hexadecimal string
 * @returns A rgb string in this format - rgb(SOME_VALUE, SOME_VALUE, SOME_VALUE)
 */
export declare function hexToRGB(hex: string, returnSeparatedValues?: boolean): string | Color[];
/**
 * Convert rgb value to hex string
 * @param r - red value
 * @param g - green value
 * @param b - blue value
 * @returns a hexadecimal string, eg - #ffffff
 */
export declare function RGBToHex(r: Color, g: Color, b: Color): string;
/**
 * Converts RGB colors to HSL
 * @param r red value
 * @param g green value
 * @param b blue value
 * @returns a color in HSL format, eg - hsl(255, 25, 25)
 */
export declare function RGBToHSL(r: number, g: number, b: number): string;
/**
 * Converts HSL colors to RGB
 * @param h hue value
 * @param s saturation value
 * @param l lightness value
 * @returns a color in RGB format, eg - rgb(20, 20, 20)
 */
export declare function HSLToRGB(h: number, s: number, l: number, returnSeparatedValues?: boolean): string | number[];
/**
 * Converts hex string to HSL
 * @param hex a hex string
 * @returns a color in HSL format, eg - hsl(20, 20, 20)
 */
export declare function hexToHSL(hex: string): string;
/**
 * Converts HSL color to hex
 * @param h hue value
 * @param s saturation value
 * @param l lightness value
 * @returns a color in hex format, eg - #ffffff
 */
export declare function HSLToHex(h: Color, s: Color, l: Color): string;