colorsCalc

A simple, type-safe npm package for color conversions and calculations in TypeScript/JavaScript.

Features

• Convert between HEX, RGB, HSL, and LCH color spaces
• Type-safe color objects with runtime validation
• Utility functions for color manipulation

Installation

npm install colorscalc

Usage Example

import {
  hexToRgb,
  rgbToHex,
  hexToHsl,
  hslToHex,
  hexToLch,
  lchToHex,
} from "colorscalc";

const rgb = hexToRgb("#ff0000"); // { r, g, b }
const hex = rgbToHex(rgb); // "#ff0000"
const hsl = hexToHsl("#ff0000"); // { h, s, l }
const hex2 = hslToHex(hsl); // "#ff0000"
const lch = hexToLch("#ff0000"); // { l, c, h }
const hex3 = lchToHex(lch); // "#ff0000"

API

Color Conversion Functions

• hexToRgb(hex: HEX): RGB — Convert HEX to RGB
• rgbToHex(rgb: RGB): HEX — Convert RGB to HEX
• hexToHsl(hex: HEX): HSL — Convert HEX to HSL
• hslToHex(hsl: HSL): HEX — Convert HSL to HEX
• hexToLch(hex: HEX): LCH — Convert HEX to LCH
• lchToHex(lch: LCH): HEX — Convert LCH to HEX

Validation & Creation Helpers

• createHEX(value: string): HEX — Validate and create a HEX color
• createRGBValue(value: number): RGBValue — Validate and create an RGB channel value
• createHue(value: number): Hue — Validate and create a Hue value
• createPercentage(value: number): Percentage — Validate and create a Percentage value
• createLCHLightness(value: number): LCHLightness — Validate and create LCH lightness
• createLCHChroma(value: number): LCHChroma — Validate and create LCH chroma
• createHSL(h: number, s: number, l: number): HSL — Create a validated HSL object
• createRGB(r: number, g: number, b: number): RGB — Create a validated RGB object
• createLCH(l: number, c: number, h: number): LCH — Create a validated LCH object

Type Guards

• isHue(value: number): value is Hue — Check if a number is a valid Hue
• isPercentage(value: number): value is Percentage — Check if a number is a valid Percentage
• isRGBValue(value: number): value is RGBValue — Check if a number is a valid RGB channel
• isValidHEX(value: string): value is HEX — Check if a string is a valid HEX color

Types

• HEX — Branded string type for hex colors (e.g., "#ff0000")
• RGB — Object: { r, g, b } (0-255)
• HSL — Object: { h, s, l } (h: 0-360, s/l: 0-100)
• LCH — Object: { l, c, h } (l: 0-100, c: 0+, h: 0-360)

License

MIT