Installation

npm install --save @types/color-string

Summary

This package contains type definitions for color-string (https://github.com/qix-/color-string#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/color-string.

index.d.ts

// Type definitions for color-string 1.5
// Project: https://github.com/qix-/color-string#readme
// Definitions by: BendingBender <https://github.com/BendingBender>
//                 Dan Marshall <https://github.com/danmarshall>
//                 Eric NICOLAS (ccjmne) <https://github.com/ccjmne>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

export type Color = [number, number, number, number];

export interface ColorDescriptor {
    model: 'rgb' | 'hsl' | 'hwb';
    value: Color;
}

export function get(colorString: string): ColorDescriptor | null;

export namespace get {
    function hsl<TColorStr extends string | null>(colorString: TColorStr): TColorStr extends string ? Color : null;
    function hwb<TColorStr extends string | null>(colorString: TColorStr): TColorStr extends string ? Color : null;
    function rgb<TColorStr extends string | null>(colorString: TColorStr): TColorStr extends string ? Color : null;
}

export namespace to {
    function hex(...args: Array<number | number[]>): string;
    function rgb(...args: Array<number | number[]>): string;
    namespace rgb {
        function percent(...args: Array<number | number[]>): string;
    }
    function keyword(...args: Array<number | number[]>): string;
    function hsl(...args: Array<number | number[]>): string;
    function hwb(...args: Array<number | number[]>): string;
}

Additional Details

Last updated: Tue, 30 Nov 2021 23:01:03 GMT
Dependencies: none
Global values: none

Credits

These definitions were written by BendingBender, Dan Marshall, and Eric NICOLAS (ccjmne).

Current Tags

3 Versions

1.5.2 ... 4 years ago
1.5.1 ... 4 years ago
1.5.0 ... 9 years ago