diff options
| author | Rich Trott <rtrott@gmail.com> | 2019-12-10 19:22:34 +0300 |
|---|---|---|
| committer | Myles Borins <mylesborins@google.com> | 2019-12-13 18:50:40 +0300 |
| commit | 8bf0da6c93251ecc22504a7d6f3d8fc029a644a8 (patch) | |
| tree | d59af842030ff6fb301efa78dc1a344ea91e6aca /doc/api | |
| parent | eb6e32c2fc34764d2679abd56d3ae515d484a38f (diff) | |
doc: edit colorMode information
Add information about what it means when colorMode is set to false.
PR-URL: https://github.com/nodejs/node/pull/30887
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/console.md | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/api/console.md b/doc/api/console.md index 45b8dad9978..00072793adb 100644 --- a/doc/api/console.md +++ b/doc/api/console.md @@ -99,8 +99,9 @@ changes: * `ignoreErrors` {boolean} Ignore errors when writing to the underlying streams. **Default:** `true`. * `colorMode` {boolean|string} Set color support for this `Console` instance. - Setting to `true` enables coloring while inspecting values, setting to - `'auto'` will make color support depend on the value of the `isTTY` property + Setting to `true` enables coloring while inspecting values. Setting to + `false` disables coloring while inspecting values. Setting to + `'auto'` makes color support depend on the value of the `isTTY` property and the value returned by `getColorDepth()` on the respective stream. This option can not be used, if `inspectOptions.colors` is set as well. **Default:** `'auto'`. |