styled-string-builder
Version:
String Styler class based on a builder design pattern
146 lines (145 loc) • 6.31 kB
TypeScript
/**
* @description ANSI escape code for resetting text formatting.
* @summary This constant holds the ANSI escape sequence used to reset all text formatting to default.
* @const AnsiReset
* @memberOf module:StyledString
*/
export declare const AnsiReset = "\u001B[0m";
/**
* @description Standard foreground color codes for ANSI text formatting.
* @summary This object maps color names to their corresponding ANSI color codes for standard foreground colors.
* @const StandardForegroundColors
* @property {number} black - ANSI code for black text (30).
* @property {number} red - ANSI code for red text (31).
* @property {number} green - ANSI code for green text (32).
* @property {number} yellow - ANSI code for yellow text (33).
* @property {number} blue - ANSI code for blue text (34).
* @property {number} magenta - ANSI code for magenta text (35).
* @property {number} cyan - ANSI code for cyan text (36).
* @property {number} white - ANSI code for white text (37).
* @memberOf module:StyledString
*/
export declare const StandardForegroundColors: {
black: number;
red: number;
green: number;
yellow: number;
blue: number;
magenta: number;
cyan: number;
white: number;
};
/**
* @description Bright foreground color codes for ANSI text formatting.
* @summary This object maps color names to their corresponding ANSI color codes for bright foreground colors.
* @const BrightForegroundColors
* @property {number} black - ANSI code for bright black text (90).
* @property {number} red - ANSI code for bright red text (91).
* @property {number} green - ANSI code for bright green text (92).
* @property {number} yellow - ANSI code for bright yellow text (93).
* @property {number} blue - ANSI code for bright blue text (94).
* @property {number} magenta - ANSI code for bright magenta text (95).
* @property {number} cyan - ANSI code for bright cyan text (96).
* @property {number} white - ANSI code for bright white text (97).
* @memberOf module:@StyledString
*/
export declare const BrightForegroundColors: {
brightBlack: number;
brightRed: number;
brightGreen: number;
brightYellow: number;
brightBlue: number;
brightMagenta: number;
brightCyan: number;
brightWhite: number;
};
/**
* @description Standard background color codes for ANSI text formatting.
* @summary This object maps color names to their corresponding ANSI color codes for standard background colors.
* @const StandardBackgroundColors
* @property {number} bgBlack - ANSI code for black background (40).
* @property {number} bgRed - ANSI code for red background (41).
* @property {number} bgGreen - ANSI code for green background (42).
* @property {number} bgYellow - ANSI code for yellow background (43).
* @property {number} bgBlue - ANSI code for blue background (44).
* @property {number} bgMagenta - ANSI code for magenta background (45).
* @property {number} bgCyan - ANSI code for cyan background (46).
* @property {number} bgWhite - ANSI code for white background (47).
* @memberOf module:@StyledString
*/
export declare const StandardBackgroundColors: {
bgBlack: number;
bgRed: number;
bgGreen: number;
bgYellow: number;
bgBlue: number;
bgMagenta: number;
bgCyan: number;
bgWhite: number;
};
/**
* @description Bright background color codes for ANSI text formatting.
* @summary This object maps color names to their corresponding ANSI color codes for bright background colors.
* @const BrightBackgroundColors
* @property {number} bgBrightBlack - ANSI code for bright black background (100).
* @property {number} bgBrightRed - ANSI code for bright red background (101).
* @property {number} bgBrightGreen - ANSI code for bright green background (102).
* @property {number} bgBrightYellow - ANSI code for bright yellow background (103).
* @property {number} bgBrightBlue - ANSI code for bright blue background (104).
* @property {number} bgBrightMagenta - ANSI code for bright magenta background (105).
* @property {number} bgBrightCyan - ANSI code for bright cyan background (106).
* @property {number} bgBrightWhite - ANSI code for bright white background (107).
* @memberOf module:@StyledString
*/
export declare const BrightBackgroundColors: {
bgBrightBlack: number;
bgBrightRed: number;
bgBrightGreen: number;
bgBrightYellow: number;
bgBrightBlue: number;
bgBrightMagenta: number;
bgBrightCyan: number;
bgBrightWhite: number;
};
/**
* @description Text style codes for ANSI text formatting.
* @summary This object maps style names to their corresponding ANSI codes for various text styles.
* @const styles
* @property {number} reset - ANSI code to reset all styles (0).
* @property {number} bold - ANSI code for bold text (1).
* @property {number} dim - ANSI code for dim text (2).
* @property {number} italic - ANSI code for italic text (3).
* @property {number} underline - ANSI code for underlined text (4).
* @property {number} blink - ANSI code for blinking text (5).
* @property {number} inverse - ANSI code for inverse colors (7).
* @property {number} hidden - ANSI code for hidden text (8).
* @property {number} strikethrough - ANSI code for strikethrough text (9).
* @property {number} doubleUnderline - ANSI code for double underlined text (21).
* @property {number} normalColor - ANSI code to reset color to normal (22).
* @property {number} noItalicOrFraktur - ANSI code to turn off italic (23).
* @property {number} noUnderline - ANSI code to turn off underline (24).
* @property {number} noBlink - ANSI code to turn off blink (25).
* @property {number} noInverse - ANSI code to turn off inverse (27).
* @property {number} noHidden - ANSI code to turn off hidden (28).
* @property {number} noStrikethrough - ANSI code to turn off strikethrough (29).
* @memberOf module:@StyledString
*/
export declare const styles: {
reset: number;
bold: number;
dim: number;
italic: number;
underline: number;
blink: number;
inverse: number;
hidden: number;
strikethrough: number;
doubleUnderline: number;
normalColor: number;
noItalicOrFraktur: number;
noUnderline: number;
noBlink: number;
noInverse: number;
noHidden: number;
noStrikethrough: number;
};