pretty-easy-hex-to-rgb/lib/checkInput.ts

Converts a hex color value to it's coresponding rgb value and returns it in an array like format of red, green, blue color values

//  Dependancies
import { isString } from 'pretty-easy-data-types';
import { rgb } from './hex-rgb';


/**
 * @description
 *  Trims the string passed and checks if it's a valid HEX color value representation
 *  if it's not it will throw an Error and stop the execution
 *  else, it will make an rgb color value representation of the HEX color value passed
 *  and return the output in the Array like format
 *
 * @export
 * @param {string} hex
 * @returns {number[]}
 */
export function hexToRgb(hex: string): number[] | Error {

    //  Not string or empty
    if(!isString(hex) || !hex) return new Error('Hex color code expected');

    //  Remove the hash, if present
    hex = hex.replace(/^#/, '');

    //  Not valid string
    if(!(hex.length === 3) && !(hex.length === 6)) {
        return new Error(`Hex color representations should be in the format of :
            => '#xxx'
                or
            => '#xxxxxx'
        `);
    }

    //  Return the array
    return rgb(hex);
}