1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: remove "note that" from util.md

Browse Source 
Refs: https://github.com/nodejs/remark-preset-lint-node/pull/16

PR-URL: https://github.com/nodejs/node/pull/28329
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
This commit is contained in:
Rich Trott 2019-06-20 13:34:31 -06:00
parent ea069e81ae
commit e05f7228c8
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/api/util.md
View File

@ -276,10 +276,9 @@ util.format('%% %s');
// Returns: '%% %s' // Returns: '%% %s'
``` ```
Please note that `util.format()` is a synchronous method that is mainly `util.format()` is a synchronous method that is intended as a debugging tool.
intended as a debugging tool. Some input values can have a significant Some input values can have a significant performance overhead that can block the
performance overhead that can block the event loop. Use this function event loop. Use this function with care and never in a hot code path.
with care and never in a hot code path.
## util.formatWithOptions(inspectOptions, format[, ...args]) ## util.formatWithOptions(inspectOptions, format[, ...args])
<!-- YAML <!-- YAML
@ -480,7 +479,7 @@ changes:
to be displayed on a new line. It will also add new lines to text that is 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 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 are united on a single line as long as all properties fit into
`breakLength`. Short array elements are also grouped together. Note that no `breakLength`. Short array elements are also grouped together. No
text will be reduced below 16 characters, no matter the `breakLength` size. text will be reduced below 16 characters, no matter the `breakLength` size.
For more information, see the example below. **Default:** `3`. For more information, see the example below. **Default:** `3`.
* `sorted` {boolean|Function} If set to `true` or a function, all properties * `sorted` {boolean|Function} If set to `true` or a function, all properties
@ -1157,7 +1156,7 @@ added: v10.0.0
* Returns: {boolean} * Returns: {boolean}
Returns `true` if the value is an [async function][]. Returns `true` if the value is an [async function][].
Note that this only reports back what the JavaScript engine is seeing; This only reports back what the JavaScript engine is seeing;
in particular, the return value may not match the original source code if in particular, the return value may not match the original source code if
a transpilation tool was used. a transpilation tool was used.
@ -1320,7 +1319,7 @@ added: v10.0.0
* Returns: {boolean} * Returns: {boolean}
Returns `true` if the value is a generator function. Returns `true` if the value is a generator function.
Note that this only reports back what the JavaScript engine is seeing; This only reports back what the JavaScript engine is seeing;
in particular, the return value may not match the original source code if in particular, the return value may not match the original source code if
a transpilation tool was used. a transpilation tool was used.
@ -1339,7 +1338,7 @@ added: v10.0.0
Returns `true` if the value is a generator object as returned from a Returns `true` if the value is a generator object as returned from a
built-in generator function. built-in generator function.
Note that this only reports back what the JavaScript engine is seeing; This only reports back what the JavaScript engine is seeing;
in particular, the return value may not match the original source code if in particular, the return value may not match the original source code if
a transpilation tool was used. a transpilation tool was used.
@ -1877,7 +1876,7 @@ util.isError({ name: 'Error', message: 'an error occurred' });
// Returns: false // Returns: false
``` ```
Note that this method relies on `Object.prototype.toString()` behavior. It is This method relies on `Object.prototype.toString()` behavior. It is
possible to obtain an incorrect result when the `object` argument manipulates possible to obtain an incorrect result when the `object` argument manipulates
`@@toStringTag`. `@@toStringTag`.