summaryrefslogtreecommitdiff
path: root/doc/api/console.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/console.md')
-rw-r--r--doc/api/console.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/doc/api/console.md b/doc/api/console.md
index 55adfc1e83..72d80ab9e7 100644
--- a/doc/api/console.md
+++ b/doc/api/console.md
@@ -332,6 +332,47 @@ console.log('count:', count);
See [`util.format()`][] for more information.
+### console.table(tabularData[, properties])
+<!-- YAML
+added: REPLACEME
+-->
+
+* `tabularData` {any}
+* `properties` {string[]} Alternate properties for constructing the table.
+
+Try to construct a table with the columns of the properties of `tabularData`
+(or use `properties`) and rows of `tabularData` and logit. Falls back to just
+logging the argument if it can’t be parsed as tabular.
+
+```js
+// These can't be parsed as tabular data
+console.table(Symbol());
+// Symbol()
+
+console.table(undefined);
+// undefined
+```
+
+```js
+console.table([{ a: 1, b: 'Y' }, { a: 'Z', b: 2 }]);
+// ┌─────────┬─────┬─────┐
+// │ (index) │ a │ b │
+// ├─────────┼─────┼─────┤
+// │ 0 │ 1 │ 'Y' │
+// │ 1 │ 'Z' │ 2 │
+// └─────────┴─────┴─────┘
+```
+
+```js
+console.table([{ a: 1, b: 'Y' }, { a: 'Z', b: 2 }], ['a']);
+// ┌─────────┬─────┐
+// │ (index) │ a │
+// ├─────────┼─────┤
+// │ 0 │ 1 │
+// │ 1 │ 'Z' │
+// └─────────┴─────┘
+```
+
### console.time(label)
<!-- YAML
added: v0.1.104