@ix-xs/node-comfort 1.2.0 → 2.0.0

package/types/src/Color.d.ts

@@ -0,0 +1,294 @@
+export = color;
+/** @type {ColorModule} */
+declare const color: ColorModule;
+declare namespace color {
+    export { StyleName, ColorLevel, ColorStyleProps, ColorStyles, ColorChain, ColorMethods, ColorModule, ColorHelpers, StyleEntry };
+}
+/**
+ * Every named style.
+ */
+type StyleName = "reset" | "bold" | "dim" | "italic" | "underline" | "overline" | "inverse" | "hidden" | "strikethrough" | "black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "blackBright" | "redBright" | "greenBright" | "yellowBright" | "blueBright" | "magentaBright" | "cyanBright" | "whiteBright" | "bgBlack" | "bgRed" | "bgGreen" | "bgYellow" | "bgBlue" | "bgMagenta" | "bgCyan" | "bgWhite" | "bgGray" | "bgGrey" | "bgBlackBright" | "bgRedBright" | "bgGreenBright" | "bgYellowBright" | "bgBlueBright" | "bgMagentaBright" | "bgCyanBright" | "bgWhiteBright";
+/**
+ * How many colors the terminal can show: `0` none, `1` 16, `2` 256, `3` millions.
+ */
+type ColorLevel = 0 | 1 | 2 | 3;
+/**
+ * The named styles. Each one can be called on text or chained with others:
+ * `color.red("x")`, `color.red.bold.underline("x")`.
+ */
+type ColorStyleProps = {
+    /**
+     * Removes all styles.
+     */
+    reset: ColorChain;
+    /**
+     * Bold text.
+     */
+    bold: ColorChain;
+    /**
+     * Faint text.
+     */
+    dim: ColorChain;
+    /**
+     * Italic text, where the terminal supports it.
+     */
+    italic: ColorChain;
+    /**
+     * Underlined text.
+     */
+    underline: ColorChain;
+    /**
+     * Line above the text, where supported.
+     */
+    overline: ColorChain;
+    /**
+     * Swaps text and background colors.
+     */
+    inverse: ColorChain;
+    /**
+     * Invisible text, still copyable.
+     */
+    hidden: ColorChain;
+    /**
+     * Crossed-out text.
+     */
+    strikethrough: ColorChain;
+    /**
+     * Black text.
+     */
+    black: ColorChain;
+    /**
+     * Red text.
+     */
+    red: ColorChain;
+    /**
+     * Green text.
+     */
+    green: ColorChain;
+    /**
+     * Yellow text.
+     */
+    yellow: ColorChain;
+    /**
+     * Blue text.
+     */
+    blue: ColorChain;
+    /**
+     * Magenta text.
+     */
+    magenta: ColorChain;
+    /**
+     * Cyan text.
+     */
+    cyan: ColorChain;
+    /**
+     * White text.
+     */
+    white: ColorChain;
+    /**
+     * Gray text.
+     */
+    gray: ColorChain;
+    /**
+     * Same as `gray`.
+     */
+    grey: ColorChain;
+    /**
+     * Bright black text.
+     */
+    blackBright: ColorChain;
+    /**
+     * Bright red text.
+     */
+    redBright: ColorChain;
+    /**
+     * Bright green text.
+     */
+    greenBright: ColorChain;
+    /**
+     * Bright yellow text.
+     */
+    yellowBright: ColorChain;
+    /**
+     * Bright blue text.
+     */
+    blueBright: ColorChain;
+    /**
+     * Bright magenta text.
+     */
+    magentaBright: ColorChain;
+    /**
+     * Bright cyan text.
+     */
+    cyanBright: ColorChain;
+    /**
+     * Bright white text.
+     */
+    whiteBright: ColorChain;
+    /**
+     * Black background.
+     */
+    bgBlack: ColorChain;
+    /**
+     * Red background.
+     */
+    bgRed: ColorChain;
+    /**
+     * Green background.
+     */
+    bgGreen: ColorChain;
+    /**
+     * Yellow background.
+     */
+    bgYellow: ColorChain;
+    /**
+     * Blue background.
+     */
+    bgBlue: ColorChain;
+    /**
+     * Magenta background.
+     */
+    bgMagenta: ColorChain;
+    /**
+     * Cyan background.
+     */
+    bgCyan: ColorChain;
+    /**
+     * White background.
+     */
+    bgWhite: ColorChain;
+    /**
+     * Gray background.
+     */
+    bgGray: ColorChain;
+    /**
+     * Same as `bgGray`.
+     */
+    bgGrey: ColorChain;
+    /**
+     * Bright black background.
+     */
+    bgBlackBright: ColorChain;
+    /**
+     * Bright red background.
+     */
+    bgRedBright: ColorChain;
+    /**
+     * Bright green background.
+     */
+    bgGreenBright: ColorChain;
+    /**
+     * Bright yellow background.
+     */
+    bgYellowBright: ColorChain;
+    /**
+     * Bright blue background.
+     */
+    bgBlueBright: ColorChain;
+    /**
+     * Bright magenta background.
+     */
+    bgMagentaBright: ColorChain;
+    /**
+     * Bright cyan background.
+     */
+    bgCyanBright: ColorChain;
+    /**
+     * Bright white background.
+     */
+    bgWhiteBright: ColorChain;
+};
+/**
+ * The named styles, read-only.
+ */
+type ColorStyles = Readonly<ColorStyleProps>;
+/**
+ * A style you can call on text, or chain with more styles.
+ */
+type ColorChain = ((...text: unknown[]) => string) & ColorStyles & ColorMethods;
+/**
+ * Custom colors, available on every chain.
+ */
+type ColorMethods = {
+    /**
+     * Text color from red, green and blue (0-255).
+     */
+    rgb: (r: number, g: number, b: number) => ColorChain;
+    /**
+     * Background from red, green and blue (0-255).
+     */
+    bgRgb: (r: number, g: number, b: number) => ColorChain;
+    /**
+     * Text color from a hex code like `"#f80"`.
+     */
+    hex: (hex: string) => ColorChain;
+    /**
+     * Background from a hex code.
+     */
+    bgHex: (hex: string) => ColorChain;
+    /**
+     * Text color from the 256-color palette.
+     */
+    ansi256: (code: number) => ColorChain;
+    /**
+     * Background from the 256-color palette.
+     */
+    bgAnsi256: (code: number) => ColorChain;
+};
+/**
+ * `nc.color`: every style and color, plus a few helpers.
+ */
+type ColorModule = ColorStyles & ColorMethods & ColorHelpers;
+/**
+ * Color helpers.
+ */
+type ColorHelpers = {
+    /**
+     * The current color level. Set it to force one; `0` turns colors off.
+     */
+    level: ColorLevel;
+    /**
+     * Whether colors are being output.
+     */
+    enabled: boolean;
+    /**
+     * A separate instance with its own level, for another stream or for tests.
+     */
+    create: (level?: ColorLevel) => ColorModule;
+    /**
+     * The color level a stream supports, taking `NO_COLOR` and `FORCE_COLOR` into account.
+     */
+    detect: (stream?: NodeJS.WriteStream | {
+        isTTY?: boolean;
+    }) => ColorLevel;
+    /**
+     * Removes colors and other terminal escape codes.
+     */
+    strip: (text: string) => string;
+    /**
+     * How many columns the text takes, ignoring colors and counting emoji and CJK as 2.
+     */
+    width: (text: string) => number;
+    /**
+     * A clickable link in terminals that support it, `"text (url)"` elsewhere.
+     */
+    link: (text: string, url: string) => string;
+    /**
+     * Colors the text along a gradient of hex colors.
+     */
+    gradient: (text: string, colors: string[]) => string;
+};
+/**
+ * A style in a chain: fixed codes, or a color resolved at output time.
+ */
+type StyleEntry = {
+    open: string;
+    close: string;
+} | {
+    rgb: [number, number, number];
+    bg: boolean;
+} | {
+    ansi256: number;
+    bg: boolean;
+};
+//# sourceMappingURL=Color.d.ts.map

package/types/src/Color.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Color.d.ts","sourceRoot":"","sources":["../../src/Color.js"],"names":[],"mappings":";AA0ZA,0BAA0B;AAC1B,qBADW,WAAW,CACiB;;;;;;;iBA3Y1B,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,WAAW,GAAG,UAAU,GAAG,SAAS,GAAG,QAAQ,GAAG,eAAe,GAC7G,OAAO,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAC9F,aAAa,GAAG,WAAW,GAAG,aAAa,GAAG,cAAc,GAAG,YAAY,GAAG,eAAe,GAAG,YAAY,GAAG,aAAa,GAC5H,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAClH,eAAe,GAAG,aAAa,GAAG,eAAe,GAAG,gBAAgB,GAAG,cAAc,GAAG,iBAAiB,GAAG,cAAc,GAAG,eAAe;;;;kBAKtI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC;;;;;;;;;WAOZ,UAAU;;;;UACV,UAAU;;;;SACV,UAAU;;;;YACV,UAAU;;;;eACV,UAAU;;;;cACV,UAAU;;;;aACV,UAAU;;;;YACV,UAAU;;;;mBACV,UAAU;;;;WACV,UAAU;;;;SACV,UAAU;;;;WACV,UAAU;;;;YACV,UAAU;;;;UACV,UAAU;;;;aACV,UAAU;;;;UACV,UAAU;;;;WACV,UAAU;;;;UACV,UAAU;;;;UACV,UAAU;;;;iBACV,UAAU;;;;eACV,UAAU;;;;iBACV,UAAU;;;;kBACV,UAAU;;;;gBACV,UAAU;;;;mBACV,UAAU;;;;gBACV,UAAU;;;;iBACV,UAAU;;;;aACV,UAAU;;;;WACV,UAAU;;;;aACV,UAAU;;;;cACV,UAAU;;;;YACV,UAAU;;;;eACV,UAAU;;;;YACV,UAAU;;;;aACV,UAAU;;;;YACV,UAAU;;;;YACV,UAAU;;;;mBACV,UAAU;;;;iBACV,UAAU;;;;mBACV,UAAU;;;;oBACV,UAAU;;;;kBACV,UAAU;;;;qBACV,UAAU;;;;kBACV,UAAU;;;;mBACV,UAAU;;;;;mBAKX,QAAQ,CAAC,eAAe,CAAC;;;;kBAMzB,CAAC,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,MAAM,CAAC,GAAG,WAAW,GAAG,YAAY;;;;;;;;SAM5D,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,KAAK,UAAU;;;;WAC/C,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,KAAK,UAAU;;;;SAC/C,CAAC,GAAG,EAAE,MAAM,KAAK,UAAU;;;;WAC3B,CAAC,GAAG,EAAE,MAAM,KAAK,UAAU;;;;aAC3B,CAAC,IAAI,EAAE,MAAM,KAAK,UAAU;;;;eAC5B,CAAC,IAAI,EAAE,MAAM,KAAK,UAAU;;;;;mBAM7B,WAAW,GAAG,YAAY,GAAG,YAAY;;;;;;;;WAMxC,UAAU;;;;aACV,OAAO;;;;YACP,CAAC,KAAK,CAAC,EAAE,UAAU,KAAK,WAAW;;;;YACnC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,WAAW,GAAG;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,KAAK,UAAU;;;;WACjE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM;;;;WACxB,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM;;;;UACxB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,MAAM;;;;cACrC,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,MAAM;;;;;kBAiB3C;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,GAAG,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAAC,EAAE,EAAE,OAAO,CAAA;CAAE,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,OAAO,CAAA;CAAE"}