Skip to content

doc, util, console: clarify ambiguous docs #14027

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
nattelog wants to merge 2 commits into from
Closed

doc, util, console: clarify ambiguous docs #14027

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b687f17
doc, util, console: clarify ambiguous docs
nattelog Jul 1, 2017
5f01b7b
doc: combine mentions on excessive arguments
nattelog Jul 1, 2017
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
doc: combine mentions on excessive arguments 
Rephrased how excessive arguments to the format string are concatenated.

Fixes: #13908
  • Loading branch information
@nattelog
nattelog committed Jul 1, 2017
commit 5f01b7b0e22bd7573e1a7a4671d4bd75bfba5c43
16 changes: 5 additions & 11 deletions doc/api/util.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,22 +177,16 @@ util.format('%s:%s', 'foo');
// Returns: 'foo:%s'
```

If there are more arguments passed to the `util.format()` method than the
number of placeholders, the extra arguments are coerced into strings (for
objects and symbols, `util.inspect()` is used) then concatenated to the
returned string, each delimited by a space.
If there are more arguments passed to the `util.format()` method than the number
of placeholders, the extra arguments are coerced into strings then concatenated
to the returned string, each delimited by a space. Excessive arguments whose
`typeof` is `'object'` or `'symbol'` (except `null`) will be transformed by
`util.inspect()`.

```js
util.format('%s:%s', 'foo', 'bar', 'baz'); // 'foo:bar baz'
```

Any non-object and non-symbol excessive argument will **not** have
`util.inspect()` called on them.

```js
util.format('%s', 'foo', () => true); // 'foo () => true'
```

If the first argument is not a string then `util.format()` returns
a string that is the concatenation of all arguments separated by spaces.
Each argument is converted to a string using `util.inspect()`.
Expand Down