From f0fe9e8ed59b87490ec606a41e1899074a2d8713 Mon Sep 17 00:00:00 2001 From: ExE Boss <3889017+ExE-Boss@users.noreply.github.com> Date: Fri, 20 Sep 2019 16:30:00 +0200 Subject: [PATCH 1/8] =?UTF-8?q?feat:=20Add=C2=A0TypeScript=20type=C2=A0def?= =?UTF-8?q?inition?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- index.d.ts | 84 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 84 insertions(+) create mode 100644 index.d.ts diff --git a/index.d.ts b/index.d.ts new file mode 100644 index 0000000..95dc13c --- /dev/null +++ b/index.d.ts @@ -0,0 +1,84 @@ +/** Declaration file generated by dts-gen */ + +import * as colorConvert from 'color-convert'; + +declare namespace ansiStyles { + declare interface CSIPair { + open: string; + close: string; + } + + declare interface ColorBase { + ansi: typeof colorConvert; + ansi256: typeof colorConvert; + ansi16m: typeof colorConvert; + + close: string; + } + + declare interface Modifier { + bold: CSIPair; + dim: CSIPair; + hidden: CSIPair; + inverse: CSIPair; + italic: CSIPair; + reset: CSIPair; + strikethrough: CSIPair; + underline: CSIPair; + } + + declare interface ForegroundColor { + black: CSIPair; + red: CSIPair; + green: CSIPair; + yellow: CSIPair; + blue: CSIPair; + cyan: CSIPair; + magenta: CSIPair; + white: CSIPair; + + gray: CSIPair; + grey: CSIPair; + + blackBright: CSIPair; + redBright: CSIPair; + greenBright: CSIPair; + yellowBright: CSIPair; + blueBright: CSIPair; + cyanBright: CSIPair; + magentaBright: CSIPair; + whiteBright: CSIPair; + } + + declare interface BackgroundColor { + bgBlack: CSIPair; + bgRed: CSIPair; + bgGreen: CSIPair; + bgYellow: CSIPair; + bgBlue: CSIPair; + bgCyan: CSIPair; + bgMagenta: CSIPair; + bgWhite: CSIPair; + + bgGray: CSIPair; + bgGrey: CSIPair; + + bgBlackBright: CSIPair; + bgRedBright: CSIPair; + bgGreenBright: CSIPair; + bgYellowBright: CSIPair; + bgBlueBright: CSIPair; + bgCyanBright: CSIPair; + bgMagentaBright: CSIPair; + bgWhiteBright: CSIPair; + } +} + +declare const ansiStyles: { + modifier: ansiStyles.Modifier; + color: ansiStyles.ForegroundColor & ansiStyles.ColorBase; + bgColor: ansiStyles.BackgroundColor & ansiStyles.ColorBase; + codes: Map; +} & ansiStyles.BackgroundColor & ansiStyles.ForegroundColor & ansiStyles.Modifier; + +export = ansiStyles; From 3dd1e3b413cfa6d762f786366df24c34696b2284 Mon Sep 17 00:00:00 2001 From: ExE Boss <3889017+ExE-Boss@users.noreply.github.com> Date: Sat, 21 Sep 2019 15:40:00 +0200 Subject: [PATCH 2/8] =?UTF-8?q?Address=C2=A0review=C2=A0comments?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- index.d.ts | 245 +++++++++++++++++++++++++++++++++++------------- index.test-d.ts | 144 ++++++++++++++++++++++++++++ package.json | 7 +- 3 files changed, 328 insertions(+), 68 deletions(-) create mode 100644 index.test-d.ts diff --git a/index.d.ts b/index.d.ts index 95dc13c..d881306 100644 --- a/index.d.ts +++ b/index.d.ts @@ -1,84 +1,197 @@ -/** Declaration file generated by dts-gen */ - -import * as colorConvert from 'color-convert'; +import {KEYWORD} from 'color-convert/conversions'; declare namespace ansiStyles { - declare interface CSIPair { - open: string; - close: string; + interface ColorConvert { + /** + * The RGB color space + * + * @param red (0-255) + * @param green (0-255) + * @param blue (0-255) + */ + rgb(red: number, green: number, blue: number): string; + + /** + * The HSL color space + * + * @param hue (0-360) + * @param saturation (0-100) + * @param lightness (0-100) + */ + hsl(hue: number, saturation: number, lightness: number): string; + + /** + * The HSV color space + * + * @param hue (0-360) + * @param saturation (0-100) + * @param value (0-100) + */ + hsv(hue: number, saturation: number, value: number): string; + + /** + * The HSV color space + * + * @param hue (0-360) + * @param whiteness (0-100) + * @param blackness (0-100) + */ + hwb(hue: number, whiteness: number, blackness: number): string; + + /** + * The CMYK color space + * + * @param cyan (0-100) + * @param magenta (0-100) + * @param yellow (0-100) + * @param black (0-100) + */ + cmyk(cyan: number, magenta: number, yellow: number, black: number): string; + + /** + * The XYZ color space + * + * @param x (0-100) + * @param y (0-100) + * @param z (0-100) + */ + xyz(x: number, y: number, z: number): string; + + /** + * The LAB color space + * + * @param x (0-100) + * @param y (0-100) + * @param z (0-100) + */ + lab(lightness: number, a: number, b: number): string; + + /** + * The LCH/HCL color space + * + * @param lightness (0-100) + * @param chroma (0-100) + * @param hue (0-360) + */ + lch(lightness: number, chroma: number, hue: number): string; + + /** + * The RGB HEX color space + * + * @param hex A hexadecimal string containing RGB data + */ + hex(hex: string): string; + + keyword(keyword: KEYWORD): string; + ansi(ansi: number): string; + ansi256(ansi: number): string; + + /** + * The HCG color space + * + * @param hue (0-360) + * @param chroma (0-100) + * @param gray (0-100) + */ + hcg(hue: number, chroma: number, gray: number): string; + + /** + * The Apple RGB 16-bit color space + * + * @param red (0-65535) + * @param green (0-65535) + * @param blue (0-65535) + */ + apple(r16: number, g16: number, b16: number): string; + + /** + * Grayscale color + * + * @param gray (0-100) + */ + gray(gray: number): string; + } + + interface CSIPair { + /** The ANSI terminal Control Sequence for setting this style */ + readonly open: string; + + /** The ANSI terminal Control Sequence for resetting this style */ + readonly close: string; } - declare interface ColorBase { - ansi: typeof colorConvert; - ansi256: typeof colorConvert; - ansi16m: typeof colorConvert; + interface ColorBase { + readonly ansi: ColorConvert; + readonly ansi256: ColorConvert; + readonly ansi16m: ColorConvert; - close: string; + /** The ANSI terminal Control Sequence for resetting this color */ + readonly close: Close; } - declare interface Modifier { - bold: CSIPair; - dim: CSIPair; - hidden: CSIPair; - inverse: CSIPair; - italic: CSIPair; - reset: CSIPair; - strikethrough: CSIPair; - underline: CSIPair; + interface Modifier { + readonly bold: CSIPair; + readonly dim: CSIPair; + readonly hidden: CSIPair; + readonly inverse: CSIPair; + readonly italic: CSIPair; + readonly reset: CSIPair; + readonly strikethrough: CSIPair; + readonly underline: CSIPair; } - declare interface ForegroundColor { - black: CSIPair; - red: CSIPair; - green: CSIPair; - yellow: CSIPair; - blue: CSIPair; - cyan: CSIPair; - magenta: CSIPair; - white: CSIPair; - - gray: CSIPair; - grey: CSIPair; - - blackBright: CSIPair; - redBright: CSIPair; - greenBright: CSIPair; - yellowBright: CSIPair; - blueBright: CSIPair; - cyanBright: CSIPair; - magentaBright: CSIPair; - whiteBright: CSIPair; + interface ForegroundColor { + readonly black: CSIPair; + readonly red: CSIPair; + readonly green: CSIPair; + readonly yellow: CSIPair; + readonly blue: CSIPair; + readonly cyan: CSIPair; + readonly magenta: CSIPair; + readonly white: CSIPair; + + readonly gray: CSIPair; + readonly grey: CSIPair; + + readonly blackBright: CSIPair; + readonly redBright: CSIPair; + readonly greenBright: CSIPair; + readonly yellowBright: CSIPair; + readonly blueBright: CSIPair; + readonly cyanBright: CSIPair; + readonly magentaBright: CSIPair; + readonly whiteBright: CSIPair; } - declare interface BackgroundColor { - bgBlack: CSIPair; - bgRed: CSIPair; - bgGreen: CSIPair; - bgYellow: CSIPair; - bgBlue: CSIPair; - bgCyan: CSIPair; - bgMagenta: CSIPair; - bgWhite: CSIPair; - - bgGray: CSIPair; - bgGrey: CSIPair; - - bgBlackBright: CSIPair; - bgRedBright: CSIPair; - bgGreenBright: CSIPair; - bgYellowBright: CSIPair; - bgBlueBright: CSIPair; - bgCyanBright: CSIPair; - bgMagentaBright: CSIPair; - bgWhiteBright: CSIPair; + interface BackgroundColor { + readonly bgBlack: CSIPair; + readonly bgRed: CSIPair; + readonly bgGreen: CSIPair; + readonly bgYellow: CSIPair; + readonly bgBlue: CSIPair; + readonly bgCyan: CSIPair; + readonly bgMagenta: CSIPair; + readonly bgWhite: CSIPair; + + readonly bgGray: CSIPair; + readonly bgGrey: CSIPair; + + readonly bgBlackBright: CSIPair; + readonly bgRedBright: CSIPair; + readonly bgGreenBright: CSIPair; + readonly bgYellowBright: CSIPair; + readonly bgBlueBright: CSIPair; + readonly bgCyanBright: CSIPair; + readonly bgMagentaBright: CSIPair; + readonly bgWhiteBright: CSIPair; } } declare const ansiStyles: { - modifier: ansiStyles.Modifier; - color: ansiStyles.ForegroundColor & ansiStyles.ColorBase; - bgColor: ansiStyles.BackgroundColor & ansiStyles.ColorBase; - codes: Map; + readonly modifier: ansiStyles.Modifier; + readonly color: ansiStyles.ForegroundColor & ansiStyles.ColorBase<'\u001B[39m'>; + readonly bgColor: ansiStyles.BackgroundColor & ansiStyles.ColorBase<'\u001B[49m'>; + readonly codes: ReadonlyMap; } & ansiStyles.BackgroundColor & ansiStyles.ForegroundColor & ansiStyles.Modifier; export = ansiStyles; diff --git a/index.test-d.ts b/index.test-d.ts new file mode 100644 index 0000000..74099af --- /dev/null +++ b/index.test-d.ts @@ -0,0 +1,144 @@ +import {expectType, expectError} from 'tsd'; +import colorConvert = require('color-convert'); +import ansiStyles = require('.'); + +declare function keyof(type: T): keyof T; + +type ExpectedColorSpaces = Exclude | 'ansi'; +let expectedColors!: ExpectedColorSpaces; + +expectType>(ansiStyles.codes); + +// - ColorConvert - +// -- Foreground color -- +expectType(keyof(ansiStyles.color.ansi)); +expectType(keyof(ansiStyles.color.ansi256)); +expectType(keyof(ansiStyles.color.ansi16m)); + +expectType(expectedColors); +expectType(expectedColors); +expectType(expectedColors); + +// -- Background color -- +expectType(keyof(ansiStyles.bgColor.ansi)); +expectType(keyof(ansiStyles.bgColor.ansi256)); +expectType(keyof(ansiStyles.bgColor.ansi16m)); + +expectType(expectedColors); +expectType(expectedColors); +expectType(expectedColors); + +// - Static colors - +// -- Namespaced -- +// --- Foreground color --- +expectType(ansiStyles.color.black); +expectType(ansiStyles.color.red); +expectType(ansiStyles.color.green); +expectType(ansiStyles.color.yellow); +expectType(ansiStyles.color.blue); +expectType(ansiStyles.color.cyan); +expectType(ansiStyles.color.magenta); +expectType(ansiStyles.color.white); + +expectType(ansiStyles.color.gray); +expectType(ansiStyles.color.grey); + +expectType(ansiStyles.color.blackBright); +expectType(ansiStyles.color.redBright); +expectType(ansiStyles.color.greenBright); +expectType(ansiStyles.color.yellowBright); +expectType(ansiStyles.color.blueBright); +expectType(ansiStyles.color.cyanBright); +expectType(ansiStyles.color.magentaBright); +expectType(ansiStyles.color.whiteBright); + +expectType<'\x1B[39m'>(ansiStyles.color.close); + +// --- Background color --- +expectType(ansiStyles.bgColor.bgBlack); +expectType(ansiStyles.bgColor.bgRed); +expectType(ansiStyles.bgColor.bgGreen); +expectType(ansiStyles.bgColor.bgYellow); +expectType(ansiStyles.bgColor.bgBlue); +expectType(ansiStyles.bgColor.bgCyan); +expectType(ansiStyles.bgColor.bgMagenta); +expectType(ansiStyles.bgColor.bgWhite); + +expectType(ansiStyles.bgColor.bgGray); +expectType(ansiStyles.bgColor.bgGrey); + +expectType(ansiStyles.bgColor.bgBlackBright); +expectType(ansiStyles.bgColor.bgRedBright); +expectType(ansiStyles.bgColor.bgGreenBright); +expectType(ansiStyles.bgColor.bgYellowBright); +expectType(ansiStyles.bgColor.bgBlueBright); +expectType(ansiStyles.bgColor.bgCyanBright); +expectType(ansiStyles.bgColor.bgMagentaBright); +expectType(ansiStyles.bgColor.bgWhiteBright); + +expectType<'\x1B[49m'>(ansiStyles.bgColor.close); + +// --- Modifiers --- +expectType(ansiStyles.modifier.bold); +expectType(ansiStyles.modifier.dim); +expectType(ansiStyles.modifier.hidden); +expectType(ansiStyles.modifier.inverse); +expectType(ansiStyles.modifier.italic); +expectType(ansiStyles.modifier.reset); +expectType(ansiStyles.modifier.strikethrough); +expectType(ansiStyles.modifier.underline); + +// -- Top level -- +// --- Foreground color --- +expectType(ansiStyles.black); +expectType(ansiStyles.red); +expectType(ansiStyles.green); +expectType(ansiStyles.yellow); +expectType(ansiStyles.blue); +expectType(ansiStyles.cyan); +expectType(ansiStyles.magenta); +expectType(ansiStyles.white); + +expectType(ansiStyles.gray); +expectType(ansiStyles.grey); + +expectType(ansiStyles.blackBright); +expectType(ansiStyles.redBright); +expectType(ansiStyles.greenBright); +expectType(ansiStyles.yellowBright); +expectType(ansiStyles.blueBright); +expectType(ansiStyles.cyanBright); +expectType(ansiStyles.magentaBright); +expectType(ansiStyles.whiteBright); + +// --- Background color --- +expectType(ansiStyles.bgBlack); +expectType(ansiStyles.bgRed); +expectType(ansiStyles.bgGreen); +expectType(ansiStyles.bgYellow); +expectType(ansiStyles.bgBlue); +expectType(ansiStyles.bgCyan); +expectType(ansiStyles.bgMagenta); +expectType(ansiStyles.bgWhite); + +expectType(ansiStyles.bgGray); +expectType(ansiStyles.bgGrey); + +expectType(ansiStyles.bgBlackBright); +expectType(ansiStyles.bgRedBright); +expectType(ansiStyles.bgGreenBright); +expectType(ansiStyles.bgYellowBright); +expectType(ansiStyles.bgBlueBright); +expectType(ansiStyles.bgCyanBright); +expectType(ansiStyles.bgMagentaBright); +expectType(ansiStyles.bgWhiteBright); + +// --- Modifiers --- +expectType(ansiStyles.bold); +expectType(ansiStyles.dim); +expectType(ansiStyles.hidden); +expectType(ansiStyles.inverse); +expectType(ansiStyles.italic); +expectType(ansiStyles.reset); +expectType(ansiStyles.strikethrough); +expectType(ansiStyles.underline); diff --git a/package.json b/package.json index 6ae0d56..2bca51c 100644 --- a/package.json +++ b/package.json @@ -13,11 +13,12 @@ "node": ">=8" }, "scripts": { - "test": "xo && ava", + "test": "xo && ava && tsd", "screenshot": "svg-term --command='node screenshot' --out=screenshot.svg --padding=3 --width=55 --height=3 --at=1000 --no-cursor" }, "files": [ - "index.js" + "index.js", + "index.d.ts" ], "keywords": [ "ansi", @@ -42,11 +43,13 @@ "text" ], "dependencies": { + "@types/color-convert": "^1.9.0", "color-convert": "^2.0.1" }, "devDependencies": { "ava": "^2.3.0", "svg-term-cli": "^2.1.1", + "tsd": "^0.8.0", "xo": "^0.24.0" } } From 6689bcdae0b2e6acdeea8ca2c684b2b04c43b5fc Mon Sep 17 00:00:00 2001 From: ExE Boss <3889017+ExE-Boss@users.noreply.github.com> Date: Sun, 22 Sep 2019 15:00:00 +0200 Subject: [PATCH 3/8] =?UTF-8?q?Address=C2=A0review=C2=A0comments?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- index.d.ts | 150 ++++++++++++++++++++++++------------------------ index.test-d.ts | 11 ++++ package.json | 3 +- 3 files changed, 89 insertions(+), 75 deletions(-) diff --git a/index.d.ts b/index.d.ts index d881306..4c7e61d 100644 --- a/index.d.ts +++ b/index.d.ts @@ -1,122 +1,124 @@ -import {KEYWORD} from 'color-convert/conversions'; +import * as cssColors from 'color-name'; declare namespace ansiStyles { interface ColorConvert { /** - * The RGB color space - * - * @param red (0-255) - * @param green (0-255) - * @param blue (0-255) - */ + The RGB color space + + @param red (0-255) + @param green (0-255) + @param blue (0-255) + */ rgb(red: number, green: number, blue: number): string; /** - * The HSL color space - * - * @param hue (0-360) - * @param saturation (0-100) - * @param lightness (0-100) - */ + The HSL color space + + @param hue (0-360) + @param saturation (0-100) + @param lightness (0-100) + */ hsl(hue: number, saturation: number, lightness: number): string; /** - * The HSV color space - * - * @param hue (0-360) - * @param saturation (0-100) - * @param value (0-100) - */ + The HSV color space + + @param hue (0-360) + @param saturation (0-100) + @param value (0-100) + */ hsv(hue: number, saturation: number, value: number): string; /** - * The HSV color space - * - * @param hue (0-360) - * @param whiteness (0-100) - * @param blackness (0-100) - */ + The HSV color space + + @param hue (0-360) + @param whiteness (0-100) + @param blackness (0-100) + */ hwb(hue: number, whiteness: number, blackness: number): string; /** - * The CMYK color space - * - * @param cyan (0-100) - * @param magenta (0-100) - * @param yellow (0-100) - * @param black (0-100) - */ + The CMYK color space + + @param cyan (0-100) + @param magenta (0-100) + @param yellow (0-100) + @param black (0-100) + */ cmyk(cyan: number, magenta: number, yellow: number, black: number): string; /** - * The XYZ color space - * - * @param x (0-100) - * @param y (0-100) - * @param z (0-100) - */ + The XYZ color space + + @param x (0-100) + @param y (0-100) + @param z (0-100) + */ xyz(x: number, y: number, z: number): string; /** - * The LAB color space - * - * @param x (0-100) - * @param y (0-100) - * @param z (0-100) - */ + The LAB color space + + @param x (0-100) + @param y (0-100) + @param z (0-100) + */ lab(lightness: number, a: number, b: number): string; /** - * The LCH/HCL color space - * - * @param lightness (0-100) - * @param chroma (0-100) - * @param hue (0-360) - */ + The LCH/HCL color space + + @param lightness (0-100) + @param chroma (0-100) + @param hue (0-360) + */ lch(lightness: number, chroma: number, hue: number): string; /** - * The RGB HEX color space - * - * @param hex A hexadecimal string containing RGB data - */ + The RGB HEX color space + + @param hex A hexadecimal string containing RGB data + */ hex(hex: string): string; - keyword(keyword: KEYWORD): string; + /** @param keyword A CSS color name */ + keyword(keyword: keyof typeof cssColors): string; + ansi(ansi: number): string; ansi256(ansi: number): string; /** - * The HCG color space - * - * @param hue (0-360) - * @param chroma (0-100) - * @param gray (0-100) - */ + The HCG color space + + @param hue (0-360) + @param chroma (0-100) + @param gray (0-100) + */ hcg(hue: number, chroma: number, gray: number): string; /** - * The Apple RGB 16-bit color space - * - * @param red (0-65535) - * @param green (0-65535) - * @param blue (0-65535) - */ + The Apple RGB 16-bit color space + + @param red (0-65535) + @param green (0-65535) + @param blue (0-65535) + */ apple(r16: number, g16: number, b16: number): string; /** - * Grayscale color - * - * @param gray (0-100) - */ + Grayscale color + + @param gray (0-100) + */ gray(gray: number): string; } interface CSIPair { - /** The ANSI terminal Control Sequence for setting this style */ + /** The ANSI terminal Control Sequence for starting this style */ readonly open: string; - /** The ANSI terminal Control Sequence for resetting this style */ + /** The ANSI terminal Control Sequence for ending this style */ readonly close: string; } @@ -125,7 +127,7 @@ declare namespace ansiStyles { readonly ansi256: ColorConvert; readonly ansi16m: ColorConvert; - /** The ANSI terminal Control Sequence for resetting this color */ + /** The ANSI terminal Control Sequence for ending this color */ readonly close: Close; } diff --git a/index.test-d.ts b/index.test-d.ts index 74099af..6a9931d 100644 --- a/index.test-d.ts +++ b/index.test-d.ts @@ -1,9 +1,12 @@ import {expectType, expectError} from 'tsd'; +import * as cssColors from 'color-name'; import colorConvert = require('color-convert'); import ansiStyles = require('.'); declare function keyof(type: T): keyof T; +declare function params unknown>(type: T): Parameters +type CSS_COLOR_NAMES = keyof typeof cssColors; type ExpectedColorSpaces = Exclude | 'ansi'; let expectedColors!: ExpectedColorSpaces; @@ -19,6 +22,10 @@ expectType(expectedColors); expectType(expectedColors); expectType(expectedColors); +expectType<[CSS_COLOR_NAMES]>(params(ansiStyles.color.ansi.keyword)); +expectType<[CSS_COLOR_NAMES]>(params(ansiStyles.color.ansi256.keyword)); +expectType<[CSS_COLOR_NAMES]>(params(ansiStyles.color.ansi16m.keyword)); + // -- Background color -- expectType(keyof(ansiStyles.bgColor.ansi)); expectType(keyof(ansiStyles.bgColor.ansi256)); @@ -28,6 +35,10 @@ expectType(expectedColors); expectType(expectedColors); expectType(expectedColors); +expectType<[CSS_COLOR_NAMES]>(params(ansiStyles.bgColor.ansi.keyword)); +expectType<[CSS_COLOR_NAMES]>(params(ansiStyles.bgColor.ansi256.keyword)); +expectType<[CSS_COLOR_NAMES]>(params(ansiStyles.bgColor.ansi16m.keyword)); + // - Static colors - // -- Namespaced -- // --- Foreground color --- diff --git a/package.json b/package.json index 2bca51c..9f6c268 100644 --- a/package.json +++ b/package.json @@ -43,10 +43,11 @@ "text" ], "dependencies": { - "@types/color-convert": "^1.9.0", + "@types/color-name": "^1.1.1", "color-convert": "^2.0.1" }, "devDependencies": { + "@types/color-convert": "^1.9.0", "ava": "^2.3.0", "svg-term-cli": "^2.1.1", "tsd": "^0.8.0", From 78f7ed9881fa15aab85e5f0cd5811dd70e6b2e6e Mon Sep 17 00:00:00 2001 From: Sindre Sorhus Date: Thu, 10 Oct 2019 11:32:41 +0700 Subject: [PATCH 4/8] Update index.d.ts --- index.d.ts | 106 ++++++++++++++++++++++++++++------------------------- 1 file changed, 57 insertions(+), 49 deletions(-) diff --git a/index.d.ts b/index.d.ts index 4c7e61d..88fc431 100644 --- a/index.d.ts +++ b/index.d.ts @@ -3,122 +3,128 @@ import * as cssColors from 'color-name'; declare namespace ansiStyles { interface ColorConvert { /** - The RGB color space + The RGB color space. - @param red (0-255) - @param green (0-255) - @param blue (0-255) + @param red - (0-255). + @param green - (0-255). + @param blue - (0-255). */ rgb(red: number, green: number, blue: number): string; /** - The HSL color space + The HSL color space. - @param hue (0-360) - @param saturation (0-100) - @param lightness (0-100) + @param hue - (0-360). + @param saturation - (0-100). + @param lightness - (0-100). */ hsl(hue: number, saturation: number, lightness: number): string; /** - The HSV color space + The HSV color space. - @param hue (0-360) - @param saturation (0-100) - @param value (0-100) + @param hue - (0-360). + @param saturation - (0-100). + @param value - (0-100). */ hsv(hue: number, saturation: number, value: number): string; /** - The HSV color space + The HSV color space. - @param hue (0-360) - @param whiteness (0-100) - @param blackness (0-100) + @param hue - (0-360). + @param whiteness - (0-100). + @param blackness - (0-100). */ hwb(hue: number, whiteness: number, blackness: number): string; /** - The CMYK color space + The CMYK color space. - @param cyan (0-100) - @param magenta (0-100) - @param yellow (0-100) - @param black (0-100) + @param cyan - (0-100). + @param magenta - (0-100). + @param yellow - (0-100). + @param black - (0-100). */ cmyk(cyan: number, magenta: number, yellow: number, black: number): string; /** - The XYZ color space + The XYZ color space. - @param x (0-100) - @param y (0-100) - @param z (0-100) + @param x - (0-100). + @param y - (0-100). + @param z - (0-100). */ xyz(x: number, y: number, z: number): string; /** - The LAB color space + The LAB color space. - @param x (0-100) - @param y (0-100) - @param z (0-100) + @param x - (0-100). + @param y - (0-100). + @param z - (0-100). */ lab(lightness: number, a: number, b: number): string; /** - The LCH/HCL color space + The LCH/HCL color space. - @param lightness (0-100) - @param chroma (0-100) - @param hue (0-360) + @param lightness - (0-100). + @param chroma - (0-100). + @param hue - (0-360). */ lch(lightness: number, chroma: number, hue: number): string; /** - The RGB HEX color space + The RGB HEX color space. - @param hex A hexadecimal string containing RGB data + @param hex - A hexadecimal string containing RGB data. */ hex(hex: string): string; - /** @param keyword A CSS color name */ + /** + @param keyword - A CSS color name. + */ keyword(keyword: keyof typeof cssColors): string; ansi(ansi: number): string; ansi256(ansi: number): string; /** - The HCG color space + The HCG color space. - @param hue (0-360) - @param chroma (0-100) - @param gray (0-100) + @param hue - (0-360). + @param chroma - (0-100). + @param gray - (0-100). */ hcg(hue: number, chroma: number, gray: number): string; /** - The Apple RGB 16-bit color space + The Apple RGB 16-bit color space. - @param red (0-65535) - @param green (0-65535) - @param blue (0-65535) + @param red - (0-65535). + @param green - (0-65535). + @param blue - (0-65535). */ apple(r16: number, g16: number, b16: number): string; /** - Grayscale color + Grayscale color. - @param gray (0-100) + @param gray - (0-100). */ gray(gray: number): string; } interface CSIPair { - /** The ANSI terminal Control Sequence for starting this style */ + /** + The ANSI terminal control sequence for starting this style. + */ readonly open: string; - /** The ANSI terminal Control Sequence for ending this style */ + /** + The ANSI terminal control sequence for ending this style. + */ readonly close: string; } @@ -127,7 +133,9 @@ declare namespace ansiStyles { readonly ansi256: ColorConvert; readonly ansi16m: ColorConvert; - /** The ANSI terminal Control Sequence for ending this color */ + /** + The ANSI terminal control sequence for ending this color. + */ readonly close: Close; } From ca20c36e86ebfa0ec7b7f551ad88ab016baa97fb Mon Sep 17 00:00:00 2001 From: Sindre Sorhus Date: Thu, 10 Oct 2019 11:35:48 +0700 Subject: [PATCH 5/8] Update package.json --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 9f6c268..4390764 100644 --- a/package.json +++ b/package.json @@ -50,7 +50,7 @@ "@types/color-convert": "^1.9.0", "ava": "^2.3.0", "svg-term-cli": "^2.1.1", - "tsd": "^0.8.0", + "tsd": "^0.9.0", "xo": "^0.24.0" } } From 743ad90058382a220622571f07e9138f8a3a75d9 Mon Sep 17 00:00:00 2001 From: ExE Boss <3889017+ExE-Boss@users.noreply.github.com> Date: Thu, 10 Oct 2019 15:20:00 +0200 Subject: [PATCH 6/8] =?UTF-8?q?docs:=20Add=C2=A0missing=20JSDoc=C2=A0comme?= =?UTF-8?q?nts=20to=C2=A0type=C2=A0definition?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- index.d.ts | 224 ++++++++++++++++++++++++++++++------------------ index.js | 1 + index.test-d.ts | 206 +++++++++++++++++++++++--------------------- 3 files changed, 246 insertions(+), 185 deletions(-) diff --git a/index.d.ts b/index.d.ts index 88fc431..66d19f9 100644 --- a/index.d.ts +++ b/index.d.ts @@ -5,73 +5,73 @@ declare namespace ansiStyles { /** The RGB color space. - @param red - (0-255). - @param green - (0-255). - @param blue - (0-255). + @param red - (`0`-`255`) + @param green - (`0`-`255`) + @param blue - (`0`-`255`) */ rgb(red: number, green: number, blue: number): string; /** The HSL color space. - @param hue - (0-360). - @param saturation - (0-100). - @param lightness - (0-100). + @param hue - (`0`-`360`) + @param saturation - (`0`-`100`) + @param lightness - (`0`-`100`) */ hsl(hue: number, saturation: number, lightness: number): string; /** The HSV color space. - @param hue - (0-360). - @param saturation - (0-100). - @param value - (0-100). + @param hue - (`0`-`360`) + @param saturation - (`0`-`100`) + @param value - (`0`-`100`) */ hsv(hue: number, saturation: number, value: number): string; /** The HSV color space. - @param hue - (0-360). - @param whiteness - (0-100). - @param blackness - (0-100). + @param hue - (`0`-`360`) + @param whiteness - (`0`-`100`) + @param blackness - (`0`-`100`) */ hwb(hue: number, whiteness: number, blackness: number): string; /** The CMYK color space. - @param cyan - (0-100). - @param magenta - (0-100). - @param yellow - (0-100). - @param black - (0-100). + @param cyan - (`0`-`100`) + @param magenta - (`0`-`100`) + @param yellow - (`0`-`100`) + @param black - (`0`-`100`) */ cmyk(cyan: number, magenta: number, yellow: number, black: number): string; /** The XYZ color space. - @param x - (0-100). - @param y - (0-100). - @param z - (0-100). + @param x - (`0`-`100`) + @param y - (`0`-`100`) + @param z - (`0`-`100`) */ xyz(x: number, y: number, z: number): string; /** The LAB color space. - @param x - (0-100). - @param y - (0-100). - @param z - (0-100). + @param x - (`0`-`100`) + @param y - (`0`-`100`) + @param z - (`0`-`100`) */ lab(lightness: number, a: number, b: number): string; /** The LCH/HCL color space. - @param lightness - (0-100). - @param chroma - (0-100). - @param hue - (0-360). + @param lightness - (`0`-`100`) + @param chroma - (`0`-`100`) + @param hue - (`0`-`360`) */ lch(lightness: number, chroma: number, hue: number): string; @@ -87,36 +87,45 @@ declare namespace ansiStyles { */ keyword(keyword: keyof typeof cssColors): string; + /** + Use a [4-bit unsigned number](https://en.wikipedia.org/wiki/ANSI_escape_code#3/4-bit) + to set text color. + */ ansi(ansi: number): string; + + /** + Use an [8-bit unsigned number](https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit) + to set text color. + */ ansi256(ansi: number): string; /** The HCG color space. - @param hue - (0-360). - @param chroma - (0-100). - @param gray - (0-100). + @param hue - (`0`-`360`) + @param chroma - (`0`-`100`) + @param gray - (`0`-`100`) */ hcg(hue: number, chroma: number, gray: number): string; /** The Apple RGB 16-bit color space. - @param red - (0-65535). - @param green - (0-65535). - @param blue - (0-65535). + @param red - (`0`-`65535`) + @param green - (`0`-`65535`) + @param blue - (`0`-`65535`) */ apple(r16: number, g16: number, b16: number): string; /** Grayscale color. - @param gray - (0-100). + @param gray - (`0`-`100`) */ gray(gray: number): string; } - interface CSIPair { + interface CSPair { /** The ANSI terminal control sequence for starting this style. */ @@ -128,7 +137,7 @@ declare namespace ansiStyles { readonly close: string; } - interface ColorBase { + interface ColorBase { readonly ansi: ColorConvert; readonly ansi256: ColorConvert; readonly ansi16m: ColorConvert; @@ -136,71 +145,116 @@ declare namespace ansiStyles { /** The ANSI terminal control sequence for ending this color. */ - readonly close: Close; + readonly close: string; } interface Modifier { - readonly bold: CSIPair; - readonly dim: CSIPair; - readonly hidden: CSIPair; - readonly inverse: CSIPair; - readonly italic: CSIPair; - readonly reset: CSIPair; - readonly strikethrough: CSIPair; - readonly underline: CSIPair; + /** + Resets the current color chain. + */ + readonly reset: CSPair; + + /** + Make text bold. + */ + readonly bold: CSPair; + + /** + Emitting only a small amount of light. + */ + readonly dim: CSPair; + + /** + Make text italic. (Not widely supported) + */ + readonly italic: CSPair; + + /** + Make text underline. (Not widely supported) + */ + readonly underline: CSPair; + + /** + Inverse background and foreground colors. + */ + readonly inverse: CSPair; + + /** + Prints the text, but makes it invisible. + */ + readonly hidden: CSPair; + + /** + Puts a horizontal line through the center of the text. (Not widely supported) + */ + readonly strikethrough: CSPair; } interface ForegroundColor { - readonly black: CSIPair; - readonly red: CSIPair; - readonly green: CSIPair; - readonly yellow: CSIPair; - readonly blue: CSIPair; - readonly cyan: CSIPair; - readonly magenta: CSIPair; - readonly white: CSIPair; - - readonly gray: CSIPair; - readonly grey: CSIPair; - - readonly blackBright: CSIPair; - readonly redBright: CSIPair; - readonly greenBright: CSIPair; - readonly yellowBright: CSIPair; - readonly blueBright: CSIPair; - readonly cyanBright: CSIPair; - readonly magentaBright: CSIPair; - readonly whiteBright: CSIPair; + readonly black: CSPair; + readonly red: CSPair; + readonly green: CSPair; + readonly yellow: CSPair; + readonly blue: CSPair; + readonly cyan: CSPair; + readonly magenta: CSPair; + readonly white: CSPair; + + /** + Alias for `blackBright`. + */ + readonly gray: CSPair; + + /** + Alias for `blackBright`. + */ + readonly grey: CSPair; + + readonly blackBright: CSPair; + readonly redBright: CSPair; + readonly greenBright: CSPair; + readonly yellowBright: CSPair; + readonly blueBright: CSPair; + readonly cyanBright: CSPair; + readonly magentaBright: CSPair; + readonly whiteBright: CSPair; } interface BackgroundColor { - readonly bgBlack: CSIPair; - readonly bgRed: CSIPair; - readonly bgGreen: CSIPair; - readonly bgYellow: CSIPair; - readonly bgBlue: CSIPair; - readonly bgCyan: CSIPair; - readonly bgMagenta: CSIPair; - readonly bgWhite: CSIPair; - - readonly bgGray: CSIPair; - readonly bgGrey: CSIPair; - - readonly bgBlackBright: CSIPair; - readonly bgRedBright: CSIPair; - readonly bgGreenBright: CSIPair; - readonly bgYellowBright: CSIPair; - readonly bgBlueBright: CSIPair; - readonly bgCyanBright: CSIPair; - readonly bgMagentaBright: CSIPair; - readonly bgWhiteBright: CSIPair; + readonly bgBlack: CSPair; + readonly bgRed: CSPair; + readonly bgGreen: CSPair; + readonly bgYellow: CSPair; + readonly bgBlue: CSPair; + readonly bgCyan: CSPair; + readonly bgMagenta: CSPair; + readonly bgWhite: CSPair; + + /** + Alias for `bgBlackBright`. + */ + readonly bgGray: CSPair; + + /** + Alias for `bgBlackBright`. + */ + readonly bgGrey: CSPair; + + readonly bgBlackBright: CSPair; + readonly bgRedBright: CSPair; + readonly bgGreenBright: CSPair; + readonly bgYellowBright: CSPair; + readonly bgBlueBright: CSPair; + readonly bgCyanBright: CSPair; + readonly bgMagentaBright: CSPair; + readonly bgWhiteBright: CSPair; } } declare const ansiStyles: { readonly modifier: ansiStyles.Modifier; - readonly color: ansiStyles.ForegroundColor & ansiStyles.ColorBase<'\u001B[39m'>; - readonly bgColor: ansiStyles.BackgroundColor & ansiStyles.ColorBase<'\u001B[49m'>; + readonly color: ansiStyles.ForegroundColor & ansiStyles.ColorBase; + readonly bgColor: ansiStyles.BackgroundColor & ansiStyles.ColorBase; readonly codes: ReadonlyMap; } & ansiStyles.BackgroundColor & ansiStyles.ForegroundColor & ansiStyles.Modifier; diff --git a/index.js b/index.js index 886101d..19bcb2f 100644 --- a/index.js +++ b/index.js @@ -36,6 +36,7 @@ const setLazyProperty = (object, property, get) => { }); }; +/** @type {typeof import('color-convert')} */ let colorConvert; const makeDynamicStyles = (wrap, targetSpace, identity, isBackground) => { if (colorConvert === undefined) { diff --git a/index.test-d.ts b/index.test-d.ts index 6a9931d..d51dcb7 100644 --- a/index.test-d.ts +++ b/index.test-d.ts @@ -1,5 +1,6 @@ import {expectType, expectError} from 'tsd'; import * as cssColors from 'color-name'; +import { KEYWORD } from 'color-convert/conversions'; import colorConvert = require('color-convert'); import ansiStyles = require('.'); @@ -9,6 +10,11 @@ declare function params unknown>(type: T): Parameter type CSS_COLOR_NAMES = keyof typeof cssColors; type ExpectedColorSpaces = Exclude | 'ansi'; let expectedColors!: ExpectedColorSpaces; +let CSS_COLOR_NAMES!: CSS_COLOR_NAMES; +let KEYWORD!: KEYWORD; + +expectType(CSS_COLOR_NAMES); +expectType(KEYWORD); expectType>(ansiStyles.codes); @@ -42,114 +48,114 @@ expectType<[CSS_COLOR_NAMES]>(params(ansiStyles.bgColor.ansi16m.keyword)); // - Static colors - // -- Namespaced -- // --- Foreground color --- -expectType(ansiStyles.color.black); -expectType(ansiStyles.color.red); -expectType(ansiStyles.color.green); -expectType(ansiStyles.color.yellow); -expectType(ansiStyles.color.blue); -expectType(ansiStyles.color.cyan); -expectType(ansiStyles.color.magenta); -expectType(ansiStyles.color.white); - -expectType(ansiStyles.color.gray); -expectType(ansiStyles.color.grey); - -expectType(ansiStyles.color.blackBright); -expectType(ansiStyles.color.redBright); -expectType(ansiStyles.color.greenBright); -expectType(ansiStyles.color.yellowBright); -expectType(ansiStyles.color.blueBright); -expectType(ansiStyles.color.cyanBright); -expectType(ansiStyles.color.magentaBright); -expectType(ansiStyles.color.whiteBright); - -expectType<'\x1B[39m'>(ansiStyles.color.close); +expectType(ansiStyles.color.black); +expectType(ansiStyles.color.red); +expectType(ansiStyles.color.green); +expectType(ansiStyles.color.yellow); +expectType(ansiStyles.color.blue); +expectType(ansiStyles.color.cyan); +expectType(ansiStyles.color.magenta); +expectType(ansiStyles.color.white); + +expectType(ansiStyles.color.gray); +expectType(ansiStyles.color.grey); + +expectType(ansiStyles.color.blackBright); +expectType(ansiStyles.color.redBright); +expectType(ansiStyles.color.greenBright); +expectType(ansiStyles.color.yellowBright); +expectType(ansiStyles.color.blueBright); +expectType(ansiStyles.color.cyanBright); +expectType(ansiStyles.color.magentaBright); +expectType(ansiStyles.color.whiteBright); + +expectType(ansiStyles.color.close); // --- Background color --- -expectType(ansiStyles.bgColor.bgBlack); -expectType(ansiStyles.bgColor.bgRed); -expectType(ansiStyles.bgColor.bgGreen); -expectType(ansiStyles.bgColor.bgYellow); -expectType(ansiStyles.bgColor.bgBlue); -expectType(ansiStyles.bgColor.bgCyan); -expectType(ansiStyles.bgColor.bgMagenta); -expectType(ansiStyles.bgColor.bgWhite); - -expectType(ansiStyles.bgColor.bgGray); -expectType(ansiStyles.bgColor.bgGrey); - -expectType(ansiStyles.bgColor.bgBlackBright); -expectType(ansiStyles.bgColor.bgRedBright); -expectType(ansiStyles.bgColor.bgGreenBright); -expectType(ansiStyles.bgColor.bgYellowBright); -expectType(ansiStyles.bgColor.bgBlueBright); -expectType(ansiStyles.bgColor.bgCyanBright); -expectType(ansiStyles.bgColor.bgMagentaBright); -expectType(ansiStyles.bgColor.bgWhiteBright); - -expectType<'\x1B[49m'>(ansiStyles.bgColor.close); +expectType(ansiStyles.bgColor.bgBlack); +expectType(ansiStyles.bgColor.bgRed); +expectType(ansiStyles.bgColor.bgGreen); +expectType(ansiStyles.bgColor.bgYellow); +expectType(ansiStyles.bgColor.bgBlue); +expectType(ansiStyles.bgColor.bgCyan); +expectType(ansiStyles.bgColor.bgMagenta); +expectType(ansiStyles.bgColor.bgWhite); + +expectType(ansiStyles.bgColor.bgGray); +expectType(ansiStyles.bgColor.bgGrey); + +expectType(ansiStyles.bgColor.bgBlackBright); +expectType(ansiStyles.bgColor.bgRedBright); +expectType(ansiStyles.bgColor.bgGreenBright); +expectType(ansiStyles.bgColor.bgYellowBright); +expectType(ansiStyles.bgColor.bgBlueBright); +expectType(ansiStyles.bgColor.bgCyanBright); +expectType(ansiStyles.bgColor.bgMagentaBright); +expectType(ansiStyles.bgColor.bgWhiteBright); + +expectType(ansiStyles.bgColor.close); // --- Modifiers --- -expectType(ansiStyles.modifier.bold); -expectType(ansiStyles.modifier.dim); -expectType(ansiStyles.modifier.hidden); -expectType(ansiStyles.modifier.inverse); -expectType(ansiStyles.modifier.italic); -expectType(ansiStyles.modifier.reset); -expectType(ansiStyles.modifier.strikethrough); -expectType(ansiStyles.modifier.underline); +expectType(ansiStyles.modifier.bold); +expectType(ansiStyles.modifier.dim); +expectType(ansiStyles.modifier.hidden); +expectType(ansiStyles.modifier.inverse); +expectType(ansiStyles.modifier.italic); +expectType(ansiStyles.modifier.reset); +expectType(ansiStyles.modifier.strikethrough); +expectType(ansiStyles.modifier.underline); // -- Top level -- // --- Foreground color --- -expectType(ansiStyles.black); -expectType(ansiStyles.red); -expectType(ansiStyles.green); -expectType(ansiStyles.yellow); -expectType(ansiStyles.blue); -expectType(ansiStyles.cyan); -expectType(ansiStyles.magenta); -expectType(ansiStyles.white); - -expectType(ansiStyles.gray); -expectType(ansiStyles.grey); - -expectType(ansiStyles.blackBright); -expectType(ansiStyles.redBright); -expectType(ansiStyles.greenBright); -expectType(ansiStyles.yellowBright); -expectType(ansiStyles.blueBright); -expectType(ansiStyles.cyanBright); -expectType(ansiStyles.magentaBright); -expectType(ansiStyles.whiteBright); +expectType(ansiStyles.black); +expectType(ansiStyles.red); +expectType(ansiStyles.green); +expectType(ansiStyles.yellow); +expectType(ansiStyles.blue); +expectType(ansiStyles.cyan); +expectType(ansiStyles.magenta); +expectType(ansiStyles.white); + +expectType(ansiStyles.gray); +expectType(ansiStyles.grey); + +expectType(ansiStyles.blackBright); +expectType(ansiStyles.redBright); +expectType(ansiStyles.greenBright); +expectType(ansiStyles.yellowBright); +expectType(ansiStyles.blueBright); +expectType(ansiStyles.cyanBright); +expectType(ansiStyles.magentaBright); +expectType(ansiStyles.whiteBright); // --- Background color --- -expectType(ansiStyles.bgBlack); -expectType(ansiStyles.bgRed); -expectType(ansiStyles.bgGreen); -expectType(ansiStyles.bgYellow); -expectType(ansiStyles.bgBlue); -expectType(ansiStyles.bgCyan); -expectType(ansiStyles.bgMagenta); -expectType(ansiStyles.bgWhite); - -expectType(ansiStyles.bgGray); -expectType(ansiStyles.bgGrey); - -expectType(ansiStyles.bgBlackBright); -expectType(ansiStyles.bgRedBright); -expectType(ansiStyles.bgGreenBright); -expectType(ansiStyles.bgYellowBright); -expectType(ansiStyles.bgBlueBright); -expectType(ansiStyles.bgCyanBright); -expectType(ansiStyles.bgMagentaBright); -expectType(ansiStyles.bgWhiteBright); +expectType(ansiStyles.bgBlack); +expectType(ansiStyles.bgRed); +expectType(ansiStyles.bgGreen); +expectType(ansiStyles.bgYellow); +expectType(ansiStyles.bgBlue); +expectType(ansiStyles.bgCyan); +expectType(ansiStyles.bgMagenta); +expectType(ansiStyles.bgWhite); + +expectType(ansiStyles.bgGray); +expectType(ansiStyles.bgGrey); + +expectType(ansiStyles.bgBlackBright); +expectType(ansiStyles.bgRedBright); +expectType(ansiStyles.bgGreenBright); +expectType(ansiStyles.bgYellowBright); +expectType(ansiStyles.bgBlueBright); +expectType(ansiStyles.bgCyanBright); +expectType(ansiStyles.bgMagentaBright); +expectType(ansiStyles.bgWhiteBright); // --- Modifiers --- -expectType(ansiStyles.bold); -expectType(ansiStyles.dim); -expectType(ansiStyles.hidden); -expectType(ansiStyles.inverse); -expectType(ansiStyles.italic); -expectType(ansiStyles.reset); -expectType(ansiStyles.strikethrough); -expectType(ansiStyles.underline); +expectType(ansiStyles.bold); +expectType(ansiStyles.dim); +expectType(ansiStyles.hidden); +expectType(ansiStyles.inverse); +expectType(ansiStyles.italic); +expectType(ansiStyles.reset); +expectType(ansiStyles.strikethrough); +expectType(ansiStyles.underline); From 02af83155a85c2a7f528bd768807677be54390ec Mon Sep 17 00:00:00 2001 From: Sindre Sorhus Date: Fri, 11 Oct 2019 09:07:49 +0700 Subject: [PATCH 7/8] Update index.test-d.ts --- index.test-d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.test-d.ts b/index.test-d.ts index d51dcb7..50ef318 100644 --- a/index.test-d.ts +++ b/index.test-d.ts @@ -1,6 +1,6 @@ import {expectType, expectError} from 'tsd'; import * as cssColors from 'color-name'; -import { KEYWORD } from 'color-convert/conversions'; +import {KEYWORD} from 'color-convert/conversions'; import colorConvert = require('color-convert'); import ansiStyles = require('.'); From 634f224a26fdd730a37af2337bf09742cbdfd4e7 Mon Sep 17 00:00:00 2001 From: Sindre Sorhus Date: Tue, 12 Nov 2019 18:01:32 +0700 Subject: [PATCH 8/8] Update index.d.ts --- index.d.ts | 68 ++---------------------------------------------------- 1 file changed, 2 insertions(+), 66 deletions(-) diff --git a/index.d.ts b/index.d.ts index 66d19f9..be0eaab 100644 --- a/index.d.ts +++ b/index.d.ts @@ -38,43 +38,6 @@ declare namespace ansiStyles { */ hwb(hue: number, whiteness: number, blackness: number): string; - /** - The CMYK color space. - - @param cyan - (`0`-`100`) - @param magenta - (`0`-`100`) - @param yellow - (`0`-`100`) - @param black - (`0`-`100`) - */ - cmyk(cyan: number, magenta: number, yellow: number, black: number): string; - - /** - The XYZ color space. - - @param x - (`0`-`100`) - @param y - (`0`-`100`) - @param z - (`0`-`100`) - */ - xyz(x: number, y: number, z: number): string; - - /** - The LAB color space. - - @param x - (`0`-`100`) - @param y - (`0`-`100`) - @param z - (`0`-`100`) - */ - lab(lightness: number, a: number, b: number): string; - - /** - The LCH/HCL color space. - - @param lightness - (`0`-`100`) - @param chroma - (`0`-`100`) - @param hue - (`0`-`360`) - */ - lch(lightness: number, chroma: number, hue: number): string; - /** The RGB HEX color space. @@ -88,41 +51,14 @@ declare namespace ansiStyles { keyword(keyword: keyof typeof cssColors): string; /** - Use a [4-bit unsigned number](https://en.wikipedia.org/wiki/ANSI_escape_code#3/4-bit) - to set text color. + Use a [4-bit unsigned number](https://en.wikipedia.org/wiki/ANSI_escape_code#3/4-bit) to set text color. */ ansi(ansi: number): string; /** - Use an [8-bit unsigned number](https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit) - to set text color. + Use an [8-bit unsigned number](https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit) to set text color. */ ansi256(ansi: number): string; - - /** - The HCG color space. - - @param hue - (`0`-`360`) - @param chroma - (`0`-`100`) - @param gray - (`0`-`100`) - */ - hcg(hue: number, chroma: number, gray: number): string; - - /** - The Apple RGB 16-bit color space. - - @param red - (`0`-`65535`) - @param green - (`0`-`65535`) - @param blue - (`0`-`65535`) - */ - apple(r16: number, g16: number, b16: number): string; - - /** - Grayscale color. - - @param gray - (`0`-`100`) - */ - gray(gray: number): string; } interface CSPair {