@sardine/colour 2.1.0 → 2.1.1

package/dist/CIEDE2000.d.ts

@@ -0,0 +1,12 @@
+import type { LabColour } from "./types";
+/**
+ * Mesures the colour difference between two colours in the Lab space
+ *
+ * Math taken from:
+ *
+ * https://en.wikipedia.org/wiki/Color_difference#CIEDE2000
+ * http://www2.ece.rochester.edu/~gsharma/ciede2000/ciede2000noteCRNA.pdf
+ * @param colour1 First colour to be compared
+ * @param colour2 First colour to be compared
+ */
+export declare function ciede2000(colour1: LabColour, colour2: LabColour): number;

package/dist/RGBdistance.d.ts

@@ -0,0 +1,14 @@
+import type { RGBColour } from "./types";
+/**
+ * Calculate the distance between two RGB colours using the CIEDE2000 colour-difference formula.
+ *
+ * The CIEDE2000 colour-difference formula is a standard method for calculating the perceptual difference
+ * between two colours in the CIELAB colour space. It takes into account human visual perception and the
+ * non-linearities in how we perceive colour differences.
+ *
+ * @param colour1 - The first colour to compare.
+ * @param colour2 - The second colour to compare.
+ * @returns The distance between the two colours. Smaller numbers (minimum 0) mean the colours are more similar,
+ * larger numbers (typically not exceeding 100 for visible colours) indicate more dissimilar colours.
+ */
+export declare const RGBdistance: (colour1: RGBColour, colour2: RGBColour) => number;

package/dist/assertions.d.ts

@@ -0,0 +1,31 @@
+import type { NamedCSSColour } from "./types";
+/**
+ * Determines whether a string represents a valid CSS RGB or RGBA colour value.
+ *
+ * Captures the folowing CSS RGB formats:
+ * - `rgb(0,0,0)`
+ * - `rgba(0, 0, 0, 0.4)`
+ * - `rgba(0,0,0,50%)`
+ * - `rgb(0 0 0)`
+ * - `rgba(0 0 0 / 0.4)`
+ * - `rgb(0 0 0 / 0.5)`
+ * - `rgb(0 0 0 / 50%)`
+ *
+ * @param {string} colour - The string to test.
+ * @returns {boolean} `true` if the string represents a valid CSS RGB or RGBA colour value, `false` otherwise.
+ */
+export declare function isCSSRGBColour(colour: string): boolean;
+/**
+ * Determines whether a string represents a valid hexadecimal colour value.
+ *
+ * @param {string} colour - The string to test.
+ * @returns {boolean} True if the string represents a valid hexadecimal colour value, false otherwise.
+ */
+export declare function isHexColour(colour: string): boolean;
+/**
+ * Determines whether a string represents a valid named CSS colour.
+ *
+ * @param {NamedCSSColour} colour - The string to test.
+ * @returns {boolean} `true` if the string represents a valid named CSS colour, `false` otherwise.
+ */
+export declare function isNamedCSSColour(colour: NamedCSSColour): colour is NamedCSSColour;

package/dist/convertCSSRGBtoHex.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Converts CSS RGB colour format into Hexadecimal.
+ * @param {string} colour - A CSS RGB colour in the format:
+ *
+ * - `rgb(0,0,0)`
+ * - `rgba(0,0,0,0.4)`
+ * - `rgb(0 0 0)`
+ * - `rgba(0 0 0 / 0.4)`
+ *
+ * @returns {string} - An hexadecimal string
+ */
+export declare function convertCSSRGBtoHex(colour: string): string;

package/dist/convertCSSRGBtoRGB.d.ts

@@ -0,0 +1,13 @@
+import type { RGBColour } from "./types";
+/**
+ * Converts CSS RGB colour format into RGB colour object.
+ * @param {string} colour - A CSS RGB colour in the format:
+ *
+ * - `rgb(0,0,0)`
+ * - `rgba(0,0,0,0.4)`
+ * - `rgb(0 0 0)`
+ * - `rgba(0 0 0 / 0.4)`
+ *
+ * @returns {RGBColour} - RGB colour object.
+ */
+export declare function convertCSSRGBtoRGB(colour: string): RGBColour;

package/dist/convertHextoNamedCSSColour.d.ts

@@ -0,0 +1,8 @@
+import type { NamedCSSColour } from "./types";
+/**
+ * Converts a hexadecimal colour value to a named CSS colour.
+ *
+ * @param {string} colour - The hexadecimal colour value to convert.
+ * @returns {NamedCSSColour | undefined} The named CSS colour that corresponds to the given hexadecimal colour value, or undefined if no named CSS colour matches the given value.
+ */
+export declare function convertHextoNamedCSSColour(colour: string): NamedCSSColour | undefined;

package/dist/convertHextoRGB.d.ts

@@ -0,0 +1,13 @@
+import type { RGBColour } from "./types";
+/**
+ * Converts an hexadecimal colour into RGB colour object.
+ * @param {string} hex - An hexadecimal colour in the format:
+ *
+ * - `#000`
+ * - `#102030`
+ * - `#ffff`
+ * - `#102030ff`
+ *
+ * @returns {RGBColour} - RGB colour object.
+ */
+export declare function convertHextoRGB(hex: string): RGBColour;

package/dist/convertNamedCSSColourtoHex.d.ts

@@ -0,0 +1,10 @@
+import type { NamedCSSColour } from "./types";
+/**
+ * Converts a named CSS Colour in an hexadecimal one.
+ *
+ * List of colours sourced here:
+ * https://developer.mozilla.org/en-US/docs/Web/CSS/named-color
+ * @param {NamedCSSColour} name - A named CSS colour
+ * @returns {string} - An hexadecimal string
+ */
+export declare function convertNamedCSSColourtoHex(name: NamedCSSColour): string | undefined;

package/dist/convertNamedCSSColourtoRGB.d.ts

@@ -0,0 +1,8 @@
+import type { NamedCSSColour, RGBColour } from "./types";
+/**
+ * Converts a named CSS colour to an RGB colour object.
+ *
+ * @param {NamedCSSColour} colour - The named CSS colour to convert.
+ * @returns {RGBColour | undefined} An RGB colour object representing the named CSS colour, or undefined if the named CSS colour is not recognized.
+ */
+export declare function convertNamedCSSColourtoRGB(colour: NamedCSSColour): RGBColour | undefined;

package/dist/convertRGBtoCSSRGB.d.ts

@@ -0,0 +1,8 @@
+import type { RGBColour } from "./types";
+/**
+ * Converts an RGB colour object to a CSS RGB colour string.
+ *
+ * @param {RGBColour} colour - The RGB colour object to convert.
+ * @returns {string} The CSS RGB colour string in the format `rgb(R G B)` or `rgb(R G B / A)` if the alpha channel is present.
+ */
+export declare function convertRGBtoCSSRGB({ R, G, B, A }: RGBColour): string;

package/dist/convertRGBtoHex.d.ts

@@ -0,0 +1,12 @@
+import type { RGBColour } from "./types";
+/**
+ * Converts a colour in the RGB format to Hexadecimal.
+ * It accepts an option Alpha channel `A`
+ * @param {RGBColour} colour - An object representing RGB Colour.
+ * @param {number} colour.R - A number between 0 and 255 to describe the Red colour channel
+ * @param {number} colour.G - A number between 0 and 255 to describe the Green colour channel
+ * @param {number} colour.B - A number between 0 and 255 to describe the Blue colour channel
+ * @param {number} colour.A - An optional number between 0 and 1 to describe the Alpha colour channel
+ * @returns - An hexadecimal string
+ */
+export declare function convertRGBtoHex({ R, G, B, A }: RGBColour): string;

package/dist/convertRGBtoLab.d.ts

@@ -0,0 +1,8 @@
+import type { LabColour, RGBColour } from "./types";
+/**
+ * Indirectly converts RGB to Lab.
+ * First converts RGB to XYZ, then converts XYZ to Lab.
+ * @param {RGBColour} colour sRGB colour
+ * @return {LabColour} Lab colour
+ */
+export declare function convertRGBtoLab(colour: RGBColour): LabColour;

package/dist/convertRGBtoNamedCSSColour.d.ts

@@ -0,0 +1,8 @@
+import type { NamedCSSColour, RGBColour } from "./types";
+/**
+ * Converts an RGB colour object to a named CSS colour.
+ *
+ * @param {RGBColour} colour - The RGB colour object to convert.
+ * @returns {NamedCSSColour | undefined} The named CSS colour that corresponds to the given RGB colour, or undefined if no named CSS colour matches the given colour.
+ */
+export declare function convertRGBtoNamedCSSColour(colour: RGBColour): NamedCSSColour | undefined;

package/dist/convertRGBtoXYZ.d.ts

@@ -0,0 +1,8 @@
+import type { RGBColour, XYZColour } from "./types";
+/**
+ * Converts sRGB colour space to XYZ.
+ * Math comes from https://en.wikipedia.org/wiki/SRGB#The_reverse_transformation
+ * @param {RGBColour} colour sRGB colour
+ * @return {XYZColour} XYZ colour
+ */
+export declare function convertRGBtoXYZ(colour: RGBColour): XYZColour;

package/dist/convertXYZtoLab.d.ts

@@ -0,0 +1,8 @@
+import type { LabColour, XYZColour } from "./types";
+/**
+ * Converts XYZ colour space to Lab
+ * Math comes from https://en.wikipedia.org/wiki/CIELAB_color_space#From_CIEXYZ_to_CIELAB[11]
+ * @param colour XYZ colour
+ * @return {LabColour} Lab colour
+ */
+export declare function convertXYZtoLab(colour: XYZColour): LabColour;

package/dist/findNearestCSSRGBColour.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Finds the nearest CSS RGB colour in a palette to a given CSS RGB colour.
+ *
+ * @param {string} colour - The CSS RGB colour to find the nearest match for. Alpha channel is ignored.
+ * @param {string[]} palette - An array of CSS RGB colours to search for the nearest match.
+ * @returns {string} The CSS RGB colour in the palette that is closest to the given colour.
+ * If the palette has fewer than 2 colours, or if it is undefined or null, the original colour is returned.
+ * The CSS RGB colour string is in the format `rgb(R G B)`.
+ */
+export declare function findNearestCSSRGBColour(colour: string, palette: string[]): string;

package/dist/findNearestColour.d.ts

@@ -0,0 +1,9 @@
+import type { NamedCSSColour } from "./types";
+/**
+ * Finds the nearest colour in a palette to a given colour.
+ *
+ * @param {string | NamedCSSColour} colour - The colour to match. It can be a hexadecimal colour, a CSS RGB colour, or a named CSS colour.
+ * @param {string[] | NamedCSSColour[]} palette - The palette of colours to search.
+ * @returns {string} The nearest colour in the palette to the given colour.
+ */
+export declare function findNearestColour(colour: string | NamedCSSColour, palette: string[] | NamedCSSColour[]): string | NamedCSSColour | undefined;

package/dist/findNearestHexColour.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Finds the nearest hexadecimal colour in a palette to the given hex colour.
+ *
+ * @param {string} colour - The hexadecimal colour to find the nearest match for.
+ * @param {string[]} palette - An array of hexadecimal colours to search for the nearest match in.
+ * @returns {string} The hexadecimal colour in the palette that is closest to the given colour.
+ * If the palette has fewer than 2 colours, or if it is undefined or null, the original colour is returned.
+ */
+export declare function findNearestHexColour(colour: string, palette: string[]): string;

package/dist/findNearestNamedCSSColour.d.ts

@@ -0,0 +1,2 @@
+import type { NamedCSSColour } from "./types";
+export declare function findNearestNamedCSSColour(colour: NamedCSSColour, palette: NamedCSSColour[]): NamedCSSColour;

package/dist/findNearestRGBColour.d.ts

@@ -0,0 +1,10 @@
+import type { RGBColour } from "./types";
+/**
+ * Finds the nearest RGB colour in a palette to the given RGB colour.
+ *
+ * @param {RGBColour} colour - The RGB colour to find the nearest match for.
+ * @param {RGBColour[]} palette - An array of RGB colours to search for the nearest match in.
+ * @returns {RGBColour} The RGB colour in the palette that is closest to the given colour.
+ * If the palette has fewer than 2 colours, or if it is undefined or null, the original colour is returned.
+ */
+export declare function findNearestRGBColour(colour: RGBColour, palette: RGBColour[]): RGBColour;

package/dist/getSRGBLuminanceFromHex.d.ts

@@ -0,0 +1,13 @@
+import type { WCAG } from "./types";
+/**
+ * Returns the relative luminance of a colour in the sRGB space.
+ *
+ * The calculations are compatible with WCAG 3.0 as it aligns with the sRGB spec
+ * and difference to WCAG 2.1 is minimal in a 8 bit channel.
+ *
+ * https://www.w3.org/TR/2008/REC-WCAG20-20081211/#relativeluminancedef
+ *
+ * https://www.w3.org/WAI/GL/wiki/Relative_luminance
+ * @param colour an hexadecimal colour
+ */
+export declare function getSRGBLuminanceFromHex(colour: string, standard?: WCAG): number;

package/dist/getSRGBLuminanceFromRGB.d.ts

@@ -0,0 +1,13 @@
+import type { RGBColour, WCAG } from "./types";
+/**
+ * Returns the relative luminance of a colour in the sRGB space.
+ *
+ * The calculations are compatible with WCAG 3.0 as it aligns with the sRGB spec
+ * and difference to WCAG 2.1 is minimal in a 8 bit channel.
+ *
+ * https://www.w3.org/TR/2008/REC-WCAG20-20081211/#relativeluminancedef
+ *
+ * https://www.w3.org/WAI/GL/wiki/Relative_luminance
+ * @param colour an hexadecimal colour
+ */
+export declare function getSRGBLuminanceFromRGB({ R, G, B }: RGBColour, standard?: WCAG): number;

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+export { RGBdistance } from "./RGBdistance";
+export { ciede2000 } from "./CIEDE2000";
+export { convertCSSRGBtoHex } from "./convertCSSRGBtoHex";
+export { convertCSSRGBtoRGB } from "./convertCSSRGBtoRGB";
+export { convertHextoNamedCSSColour } from "./convertHextoNamedCSSColour";
+export { convertHextoRGB } from "./convertHextoRGB";
+export { convertNamedCSSColourtoHex } from "./convertNamedCSSColourtoHex";
+export { convertNamedCSSColourtoRGB } from "./convertNamedCSSColourtoRGB";
+export { convertRGBtoCSSRGB } from "./convertRGBtoCSSRGB";
+export { convertRGBtoHex } from "./convertRGBtoHex";
+export { convertRGBtoLab } from "./convertRGBtoLab";
+export { convertRGBtoNamedCSSColour } from "./convertRGBtoNamedCSSColour";
+export { convertRGBtoXYZ } from "./convertRGBtoXYZ";
+export { convertXYZtoLab } from "./convertXYZtoLab";
+export { findNearestCSSRGBColour } from "./findNearestCSSRGBColour";
+export { findNearestColour } from "./findNearestColour";
+export { findNearestHexColour } from "./findNearestHexColour";
+export { findNearestNamedCSSColour } from "./findNearestNamedCSSColour";
+export { findNearestRGBColour } from "./findNearestRGBColour";
+export { getSRGBLuminanceFromHex } from "./getSRGBLuminanceFromHex";
+export { getSRGBLuminanceFromRGB } from "./getSRGBLuminanceFromRGB";
+export { isCSSNamedDarkColour } from "./isCSSNameDarkColour";
+export { isCSSRGBColour } from "./assertions";
+export { isCSSRGBDarkColour } from "./isCSSRGBDarkColour";
+export { isDarkColour } from "./isDarkColour";
+export { isHexDarkColour } from "./isHexDarkColour";
+export { pickHexColourContrast } from "./pickHexColourContrast";

package/dist/isCSSNameDarkColour.d.ts

@@ -0,0 +1,8 @@
+import type { NamedCSSColour, WCAG } from "./types";
+/**
+ * Evaluates if a named CSS colour is dark by measuring the contrast ratio against black and white
+ * @param {string} name - A named CSS colour, ie: `hotpink`
+ * @param {"WCAG2.1" | "WCAG3.0"} standard - Evaluate agains "WCAG2.1" or "WCAG3.0"
+ * @returns { boolean } Returns `true`, `false` or `undefined` if name is not a valid CSS named colour
+ */
+export declare function isCSSNamedDarkColour(name: NamedCSSColour, standard: WCAG): boolean;

package/dist/isCSSRGBDarkColour.d.ts

@@ -0,0 +1,2 @@
+import type { WCAG } from "./types";
+export declare function isCSSRGBDarkColour(colour: string, standard: WCAG): boolean;

package/dist/isDarkColour.d.ts

@@ -0,0 +1,11 @@
+import type { NamedCSSColour, WCAG } from "./types";
+/**
+ * Evaluates if a colour is dark by measuring the contrast ratio against black and white.
+ * It accepts CSS RGB colours, named CSS or hexadecimal.
+ *
+ * If you know in advance the type of colour you want to evaluate consider using `isCSSNamedDarkColour`, `isCSSRGBDarkColour` or `isHexDarkColour` as they are smaller functions
+ * @param {string | NamedCSSColour} colour - A colour value, ie: `hotpink`, `#333222` or `rgb(12,34,45)`
+ * @param {"WCAG2.1" | "WCAG3.0"} standard - Evaluate agains "WCAG2.1" or "WCAG3.0"
+ * @returns {boolean} Returns `true`, `false` or `undefined` if name is not a valid CSS named colour
+ */
+export declare function isDarkColour(colour: string | NamedCSSColour, standard: WCAG): boolean;

package/dist/isHexDarkColour.d.ts

@@ -0,0 +1,8 @@
+import type { WCAG } from "./types";
+/**
+ * Evaluates if a colour is dark by measuring the contrast ratio against black and white
+ * @param {string} colour - A colour in the hexadecimal format
+ * @param {"WCAG2.1" | "WCAG3.0"} standard - Evaluate agains "WCAG2.1" or "WCAG3.0"
+ * @returns {boolean} Returns either `true` or `false`
+ */
+export declare function isHexDarkColour(colour: string, standard: WCAG): boolean;

package/dist/pickHexColourContrast.d.ts

@@ -0,0 +1,8 @@
+import type { WCAG } from "./types";
+type ColorArgs = {
+    backgroundColour: string;
+    optionOneColour: string;
+    optionTwoColour: string;
+};
+export declare const pickHexColourContrast: ({ backgroundColour, optionOneColour, optionTwoColour }: ColorArgs, standard: WCAG) => string;
+export {};

package/dist/types.d.ts

@@ -0,0 +1,52 @@
+/**
+ * The RGB colour model represents a broad array of colours by describing the Red, Green and Blue channels.
+ */
+export interface RGBColour {
+    /** A number between 0 and 255 to describe the Red colour channel */
+    R: number;
+    /** A number between 0 and 255 to describe the Green colour channel */
+    G: number;
+    /** A number between 0 and 255 to describe the Blue colour channel */
+    B: number;
+    /** A optional number between 0 and 1 to describe the Alpha colour channel */
+    A?: number | undefined;
+}
+/**
+ * L*a*b* space is three-dimensional and covers the entire range of human colour perception
+ */
+export interface LabColour {
+    /** A number between 0 and 100 to describe the colour's lightness. (0 - black, 100 - white)  */
+    L: number;
+    /** A number between -128 and 127 to describe the green–red opponent colours, with negative values toward green and positive values toward red */
+    a: number;
+    /** A number between -128 and 127 to describe  blue–yellow opponents, with negative numbers toward blue and positive toward yellow */
+    b: number;
+}
+/**
+ * The CIE XYZ colour space is a device independent colour representation
+ */
+export interface XYZColour {
+    /** X is a mix of response curves chosen to be nonnegative */
+    X: number;
+    /** Y as luminance */
+    Y: number;
+    /** Z is quasi-equal to blue */
+    Z: number;
+}
+export interface HueHelper {
+    /** Chroma for colour 1 */
+    C1: number;
+    /** Chroma for colour 2 */
+    C2: number;
+    /** Derivative of colour 1 Hue */
+    h1_d: number;
+    /** Derivative of colour 2 Hue */
+    h2_d: number;
+}
+export type ColourSpace = "sRGB";
+export type WCAG = "WCAG2.1" | "WCAG3.0";
+/**
+ * Named list from https://developer.mozilla.org/en-US/docs/Web/CSS/named-color
+ */
+export type NamedCSSColour = "aliceblue" | "antiquewhite" | "aqua" | "aquamarine" | "azure" | "beige" | "bisque" | "black" | "blanchedalmond" | "blue" | "blueviolet" | "brown" | "burlywood" | "cadetblue" | "chartreuse" | "chocolate" | "coral" | "cornflowerblue" | "cornsilk" | "crimson" | "cyan" | "darkblue" | "darkcyan" | "darkgoldenrod" | "darkgray" | "darkgreen" | "darkgrey" | "darkkhaki" | "darkmagenta" | "darkolivegreen" | "darkorange" | "darkorchid" | "darkred" | "darksalmon" | "darkseagreen" | "darkslateblue" | "darkslategray" | "darkslategrey" | "darkturquoise" | "darkviolet" | "deeppink" | "deepskyblue" | "dimgray" | "dimgrey" | "dodgerblue" | "firebrick" | "floralwhite" | "forestgreen" | "fuchsia" | "gainsboro" | "ghostwhite" | "gold" | "goldenrod" | "gray" | "green" | "greenyellow" | "grey" | "honeydew" | "hotpink" | "indianred" | "indigo" | "ivory" | "khaki" | "lavender" | "lavenderblush" | "lawngreen" | "lemonchiffon" | "lightblue" | "lightcoral" | "lightcyan" | "lightgoldenrodyellow" | "lightgray" | "lightgreen" | "lightgrey" | "lightpink" | "lightsalmon" | "lightseagreen" | "lightskyblue" | "lightslategray" | "lightslategrey" | "lightsteelblue" | "lightyellow" | "lime" | "limegreen" | "linen" | "magenta" | "maroon" | "mediumaquamarine" | "mediumblue" | "mediumorchid" | "mediumpurple" | "mediumseagreen" | "mediumslateblue" | "mediumspringgreen" | "mediumturquoise" | "mediumvioletred" | "midnightblue" | "mintcream" | "mistyrose" | "moccasin" | "navajowhite" | "navy" | "oldlace" | "olive" | "olivedrab" | "orangered" | "orchid" | "palegoldenrod" | "palegreen" | "paleturquoise" | "palevioletred" | "papayawhip" | "peachpuff" | "peru" | "pink" | "plum" | "powderblue" | "purple" | "red" | "rosybrown" | "royalblue" | "saddlebrown" | "salmon" | "sandybrown" | "seagreen" | "seashell" | "sienna" | "silver" | "skyblue" | "slateblue" | "slategray" | "slategrey" | "snow" | "springgreen" | "steelblue" | "tan" | "teal" | "thistle" | "tomato" | "transparent" | "turquoise" | "violet" | "wheat" | "white" | "whitesmoke" | "yellow" | "yellowgreen";
+export type NamedCSSColours = Array<[NamedCSSColour, string]>;

package/dist/util/index.d.ts

@@ -0,0 +1,46 @@
+import type { HueHelper } from "../types";
+/**
+ * Calculates the Hue derivative
+ * @param x A numeric expression representing the cartesian x-coordinate.
+ * @param y A numeric expression representing the cartesian y-coordinate.
+ */
+export declare function hue_d(x: number, y: number): number;
+/**
+ * Calculates the difference between two Hue derivatives
+ * @param HueHelper param
+ */
+export declare function deltaHue_d({ C1, C2, h1_d, h2_d }: HueHelper): number;
+/**
+ * Calculates the mean between two Hue derivatives
+ * @param HueHelper param
+ */
+export declare function meanHue_d({ C1, C2, h1_d, h2_d }: HueHelper): number;
+/**
+ * Converts a number in degrees to radians
+ * @param n Number in degrees to be converted
+ */
+export declare const toRadians: (n: number) => number;
+/**
+ * Calculates a recurring square root
+ * @param n Input number
+ */
+export declare const bigSquare: (n: number) => number;
+/**
+ * Normalise black and white colorimetry as specified in IEC 61966-2-1
+ * It takes a RGB channel in the range [0 - 255] and returns a value between 0 and 1
+ * @param rgbValue number to be normalised
+ */
+export declare function linearRGB(rgbValue: number, WCAG21?: boolean): number;
+/**
+ * The division of the f function domain into two parts was done to prevent an infinite slope at n = 0
+ * @param n Number to be constrained
+ */
+export declare function constrainLab(n: number): number;
+/**
+ * Clamps a number between two values
+ * @param {number} value - The value to be clamped
+ * @param {number} min - The minimum value
+ * @param {number} max - The maximum value
+ * @returns {number} - A clamped value
+ */
+export declare function clamp(value: number, min: number, max: number): number;

package/dist/util/namedCSSColours.d.ts

@@ -0,0 +1,5 @@
+import type { NamedCSSColour } from "../types";
+/**
+ * Named list from https://developer.mozilla.org/en-US/docs/Web/CSS/named-color
+ */
+export declare const namedCSSColours: Map<NamedCSSColour, string>;

package/dist/util/regexers.d.ts

@@ -0,0 +1,19 @@
+/** Six digit Hexadecimal colour, ie: #12FF21 */
+export declare const hexRegex: RegExp;
+/** Eight digit Hexadecimal colour, ie: #12FF21BE */
+export declare const hexAlphaRegex: RegExp;
+/** Three digit Hexadecimal colour, ie: #FFF */
+export declare const shortHexRegex: RegExp;
+/** Four digit Hexadecimal colour, ie: #FFF4 */
+export declare const shortAlphaHexRegex: RegExp;
+/**
+ * Captures the folowing CSS RGB formats:
+ * - `rgb(0,0,0)`
+ * - `rgba(0, 0, 0, 0.4)`
+ * - `rgba(0,0,0,50%)`
+ * - `rgb(0 0 0)`
+ * - `rgba(0 0 0 / 0.4)`
+ * - `rgb(0 0 0 / 0.5)`
+ * - `rgb(0 0 0 / 50%)`
+ */
+export declare const cssRGBARegex: RegExp;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sardine/colour",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "It does things to colours",
   "type": "module",
   "module": "./dist/index.mjs",