doc: update util colors

This updates the customization of colors for `util.inspect`. A couple entries were missing and this also adds a reference to check for colors. PR-URL: #27052 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com>
nodejs · Apr 2, 2019 · ffd2df063c4671e006eba87a0be33357e54964a6 · ffd2df0
1 parent 90e958a
commit ffd2df063c4671e006eba87a0be33357e54964a6
Unified Split

Showing with 9 additions and 6 deletions.

+9 −6 doc/api/util.md
diff --git a/doc/api/util.md b/doc/api/util.md
@@ -638,23 +638,25 @@ via the `util.inspect.styles` and `util.inspect.colors` properties.
 The default styles and associated colors are:
-  
-* `number` - `yellow`
+  
+* `bigint` - `yellow`
 * `boolean` - `yellow`
-  
-* `string` - `green`
 * `date` - `magenta`
 * `module` - `underline`
-  
-* `regexp` - `red`
+  
+* `name` - (no styling)
 * `null` - `bold`
+  
+* `number` - `yellow`
+  
+* `regexp` - `red`
+  
+* `special` - `cyan` (e.g., `Proxies`)
+  
+* `string` - `green`
+  
+* `symbol` - `green`
 * `undefined` - `grey`
-  
-* `special` - `cyan` (only applied to functions at this time)
-  
-* `name` - (no styling)
 The predefined color codes are: `white`, `grey`, `black`, `blue`, `cyan`,
 `green`, `magenta`, `red` and `yellow`. There are also `bold`, `italic`,
 `underline` and `inverse` codes.
 Color styling uses ANSI control codes that may not be supported on all
-  
-terminals.
+  
+terminals. To verify color support use [`tty.hasColors()`][].
 ### Custom inspection functions on Objects
@@ -2191,6 +2193,7 @@ util.log('Timestamped message.');
 [`assert.deepStrictEqual()`]: assert.html#assert_assert_deepstrictequal_actual_expected_message
 [`console.error()`]: console.html#console_console_error_data_args
 [`target` and `handler`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy#Terminology
+  
+[`tty.hasColors()`]: tty.html#tty_writestream_hascolors_count_env
 [`util.format()`]: #util_util_format_format_args
 [`util.inspect()`]: #util_util_inspect_object_options
 [`util.promisify()`]: #util_util_promisify_original