function styleText
Jump to headingstyleText(format: ,text: string,): string
Stability: 1.1 - Active development
This function returns a formatted text considering the format
passed.
import { styleText } from 'node:util';
const errorMessage = styleText('red', 'Error! Error!');
console.log(errorMessage);
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'),
);
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
);
The full list of formats can be found in modifiers.
Parameters Jump to heading
Jump to headingformat:
A text format or an Array of text formats defined in util.inspect.colors
.
Jump to headingtext: string
The text to to be formatted.
Return Type Jump to heading
string