From fc0c7286c89492e3cfb9b430ea34b181f27258b6 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Tue, 10 Dec 2019 08:22:34 -0800 Subject: [PATCH] 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 Reviewed-By: Ruben Bridgewater Reviewed-By: Luigi Pinca --- doc/api/console.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/api/console.md b/doc/api/console.md index 45911540446bfd..66fa862de88178 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'`.