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: https://github.com/nodejs/node/pull/27052 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
parent
90e958aa4d
commit
ffd2df063c
@ -638,23 +638,25 @@ via the `util.inspect.styles` and `util.inspect.colors` properties.
|
|||||||
|
|
||||||
The default styles and associated colors are:
|
The default styles and associated colors are:
|
||||||
|
|
||||||
* `number` - `yellow`
|
* `bigint` - `yellow`
|
||||||
* `boolean` - `yellow`
|
* `boolean` - `yellow`
|
||||||
* `string` - `green`
|
|
||||||
* `date` - `magenta`
|
* `date` - `magenta`
|
||||||
* `module` - `underline`
|
* `module` - `underline`
|
||||||
* `regexp` - `red`
|
|
||||||
* `null` - `bold`
|
|
||||||
* `undefined` - `grey`
|
|
||||||
* `special` - `cyan` (only applied to functions at this time)
|
|
||||||
* `name` - (no styling)
|
* `name` - (no styling)
|
||||||
|
* `null` - `bold`
|
||||||
|
* `number` - `yellow`
|
||||||
|
* `regexp` - `red`
|
||||||
|
* `special` - `cyan` (e.g., `Proxies`)
|
||||||
|
* `string` - `green`
|
||||||
|
* `symbol` - `green`
|
||||||
|
* `undefined` - `grey`
|
||||||
|
|
||||||
The predefined color codes are: `white`, `grey`, `black`, `blue`, `cyan`,
|
The predefined color codes are: `white`, `grey`, `black`, `blue`, `cyan`,
|
||||||
`green`, `magenta`, `red` and `yellow`. There are also `bold`, `italic`,
|
`green`, `magenta`, `red` and `yellow`. There are also `bold`, `italic`,
|
||||||
`underline` and `inverse` codes.
|
`underline` and `inverse` codes.
|
||||||
|
|
||||||
Color styling uses ANSI control codes that may not be supported on all
|
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
|
### Custom inspection functions on Objects
|
||||||
|
|
||||||
@ -2191,6 +2193,7 @@ util.log('Timestamped message.');
|
|||||||
[`assert.deepStrictEqual()`]: assert.html#assert_assert_deepstrictequal_actual_expected_message
|
[`assert.deepStrictEqual()`]: assert.html#assert_assert_deepstrictequal_actual_expected_message
|
||||||
[`console.error()`]: console.html#console_console_error_data_args
|
[`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
|
[`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.format()`]: #util_util_format_format_args
|
||||||
[`util.inspect()`]: #util_util_inspect_object_options
|
[`util.inspect()`]: #util_util_inspect_object_options
|
||||||
[`util.promisify()`]: #util_util_promisify_original
|
[`util.promisify()`]: #util_util_promisify_original
|
||||||
|
Loading…
x
Reference in New Issue
Block a user