doc: add colorText

nodejs · Jun 14, 2022 · 9da85fe · 9da85fe
1 parent 7cd400f
commit 9da85fe
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/doc/api/util.md b/doc/api/util.md
@@ -71,6 +71,25 @@ callbackFunction((err, ret) => {
 });
 ```
 
+## `util.colorText(format, text)`
+
+<!-- YAML
+added: v18.3.0
+-->
+
+* `format` {string} `format` one of the color format from `util.inspect.colors`
+* `text` {string} The text you would like to color
+* Returns: {string} colored text string
+
+Takes `format` and `text` and retuns the colored text form
+
+```js
+const util = require('node:util');
+
+console.log(util.colorText('red', 'This text shall be in red color'));
+// ^ '\u001b[31mThis text shall be in red color\u001b[39m'
+```
+
 ## `util.debuglog(section[, callback])`
 
 <!-- YAML