Skip to content

util: change inspect compact default #27109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
BridgeAR wants to merge 6 commits into from
Closed

util: change inspect compact default #27109

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2a69b0f
util: improve inspect edge cases
BridgeAR Apr 5, 2019
3b0b59b
util: change inspect compact and breakLength default
BridgeAR Apr 5, 2019
fe71ce1
fixup! util: change inspect compact and breakLength default
BridgeAR Apr 5, 2019
be24b74
fixup! util: change inspect compact and breakLength default
BridgeAR Apr 6, 2019
6f971cc
fixup! util: improve inspect edge cases
BridgeAR Apr 6, 2019
2bc1293
fixup! util: change inspect compact and breakLength default
BridgeAR Apr 7, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fixup! util: change inspect compact and breakLength default
  • Loading branch information
@BridgeAR
BridgeAR committed Apr 6, 2019
commit be24b748e1be584c7b7c73cdbb7c31f74574b67f
13 changes: 9 additions & 4 deletions doc/api/util.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,10 @@ stream.write('With ES6');
<!-- YAML
added: v0.3.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/27109
description: The `compact` options default is changed to `3` and the
`breakLength` options default is changed to `80`.
- version: v11.11.0
pr-url: https://github.com/nodejs/node/pull/26269
description: The `compact` option accepts numbers for a new output mode.
Expand Down Expand Up @@ -463,16 +467,17 @@ changes:
[`TypedArray`][], [`WeakMap`][] and [`WeakSet`][] elements to include when
formatting. Set to `null` or `Infinity` to show all elements. Set to `0` or
negative to show no elements. **Default:** `100`.
* `breakLength` {integer} The length at which an object's keys are split
across multiple lines. Set to `Infinity` to format an object as a single
line. **Default:** `60` for legacy compatibility.
* `breakLength` {integer} The length at which input values are split across
multiple lines. Set to `Infinity` to format the input as a single line
(in combination with `compact` set to `true` or any number besides `0`).
**Default:** `80`.
* `compact` {boolean|integer} Setting this to `false` causes each object key
to be displayed on a new line. It will also add new lines to text that is
longer than `breakLength`. If set to a number, the most `n` inner elements
are united on a single line as long as all properties fit into
`breakLength`. Short array elements are also grouped together. Note that no
text will be reduced below 16 characters, no matter the `breakLength` size.
For more information, see the example below. **Default:** `true`.
For more information, see the example below. **Default:** `3`.
* `sorted` {boolean|Function} If set to `true` or a function, all properties
of an object, and `Set` and `Map` entries are sorted in the resulting
string. If set to `true` the [default sort][] is used. If set to a function,
Expand Down