styleText
external fun styleText(format: ForegroundColors, text: String, options: StyleTextOptions = definedExternally): String(source)
external fun styleText(format: BackgroundColors, text: String, options: StyleTextOptions = definedExternally): String(source)
external fun styleText(format: Modifiers, text: String, options: StyleTextOptions = definedExternally): String(source)
external fun styleText(format: Array<Any>, text: String, options: StyleTextOptions = definedExternally): String(source)
This function returns a formatted text considering the format
passed for printing in a terminal. It is aware of the terminal's capabilities and acts according to the configuration set via NO_COLOR
, NODE_DISABLE_COLORS
and FORCE_COLOR
environment variables.
import { styleText } from 'node:util';
import { stderr } from 'node:process';
const successMessage = styleText('green', 'Success!');
console.log(successMessage);
const errorMessage = styleText(
'red',
'Error! Error!',
// Validate if process.stderr has TTY
{ stream: stderr },
);
console.error(errorMessage);
Content copied to clipboard
util.inspect.colors
also provides text formats such as italic
, and underline
and you can combine both:
console.log(
util.styleText(['underline', 'italic'], 'My italic underlined message'),
);
Content copied to clipboard
When passing an array of formats, the order of the format applied is left to right so the following style might overwrite the previous one.
console.log(
util.styleText(['red', 'green'], 'text'), // green
);
Content copied to clipboard
The special format value none
applies no additional styling to the text.
The full list of formats can be found in modifiers.
Since
v20.12.0
Parameters
format
A text format or an Array of text formats defined in util.inspect.colors
.
text
The text to to be formatted.