summaryrefslogtreecommitdiff
path: root/doc/api/console.md
diff options
context:
space:
mode:
authorAnna Henningsen <anna@addaleax.net>2018-03-15 14:09:17 +0100
committerAnna Henningsen <anna@addaleax.net>2018-04-12 23:23:56 +0200
commit57e8793c4393aa3fafd87f289b19078b1918c166 (patch)
treea1076b73991a97ed829cf0da0e5747d611ccec78 /doc/api/console.md
parentce58df58d0360779d16d60ce3bb0e9979ec5fdf4 (diff)
downloadandroid-node-v8-57e8793c4393aa3fafd87f289b19078b1918c166.tar.gz
android-node-v8-57e8793c4393aa3fafd87f289b19078b1918c166.tar.bz2
android-node-v8-57e8793c4393aa3fafd87f289b19078b1918c166.zip
console: add color support
Add a way to tell `Console` instances to either always use, never use or auto-detect color support and inspect objects accordingly. PR-URL: https://github.com/nodejs/node/pull/19372 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/console.md')
-rw-r--r--doc/api/console.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/api/console.md b/doc/api/console.md
index 99c31df242..cce2a4eb6e 100644
--- a/doc/api/console.md
+++ b/doc/api/console.md
@@ -87,7 +87,8 @@ changes:
description: The `ignoreErrors` option was introduced.
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/19372
- description: The `Console` constructor now supports an `options` argument.
+ description: The `Console` constructor now supports an `options` argument,
+ and the `colorMode` option was introduced.
-->
* `options` {Object}
@@ -95,6 +96,11 @@ changes:
* `stderr` {stream.Writable}
* `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
+ and the value returned by `getColorDepth()` on the respective stream.
+ **Default:** `false`
Creates a new `Console` with one or two writable stream instances. `stdout` is a
writable stream to print log or info output. `stderr` is used for warning or