Skip to content

Commit 38d16b9

Browse files
committed
doc: make MDN links to global classes more consistent in util.md
PR-URL: #56922 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
1 parent b145947 commit 38d16b9

File tree

2 files changed

+42
-59
lines changed

2 files changed

+42
-59
lines changed

doc/api/util.md

Lines changed: 34 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -691,8 +691,8 @@ changes:
691691
* `object` {any} Any JavaScript primitive or `Object`.
692692
* `options` {Object}
693693
* `showHidden` {boolean} If `true`, `object`'s non-enumerable symbols and
694-
properties are included in the formatted result. [`WeakMap`][] and
695-
[`WeakSet`][] entries are also included as well as user defined prototype
694+
properties are included in the formatted result. {WeakMap} and
695+
{WeakSet} entries are also included as well as user defined prototype
696696
properties (excluding method properties). **Default:** `false`.
697697
* `depth` {number} Specifies the number of times to recurse while formatting
698698
`object`. This is useful for inspecting large objects. To recurse up to
@@ -707,8 +707,7 @@ changes:
707707
* `showProxy` {boolean} If `true`, `Proxy` inspection includes
708708
the [`target` and `handler`][] objects. **Default:** `false`.
709709
* `maxArrayLength` {integer} Specifies the maximum number of `Array`,
710-
[`TypedArray`][], [`Map`][], [`Set`][], [`WeakMap`][],
711-
and [`WeakSet`][] elements to include when formatting.
710+
{TypedArray}, {Map}, {WeakMap}, and {WeakSet} elements to include when formatting.
712711
Set to `null` or `Infinity` to show all elements. Set to `0` or
713712
negative to show no elements. **Default:** `100`.
714713
* `maxStringLength` {integer} Specifies the maximum number of characters to
@@ -839,10 +838,10 @@ console.log(util.inspect(o, { compact: false, depth: 5, breakLength: 80 }));
839838
// single line.
840839
```
841840

842-
The `showHidden` option allows [`WeakMap`][] and [`WeakSet`][] entries to be
841+
The `showHidden` option allows {WeakMap} and {WeakSet} entries to be
843842
inspected. If there are more entries than `maxArrayLength`, there is no
844843
guarantee which entries are displayed. That means retrieving the same
845-
[`WeakSet`][] entries twice may result in different output. Furthermore, entries
844+
{WeakSet} entries twice may result in different output. Furthermore, entries
846845
with no remaining strong references may be garbage collected at any time.
847846

848847
```js
@@ -2335,8 +2334,8 @@ added: v10.0.0
23352334
* `value` {any}
23362335
* Returns: {boolean}
23372336
2338-
Returns `true` if the value is a built-in [`ArrayBuffer`][] or
2339-
[`SharedArrayBuffer`][] instance.
2337+
Returns `true` if the value is a built-in {ArrayBuffer} or
2338+
{SharedArrayBuffer} instance.
23402339
23412340
See also [`util.types.isArrayBuffer()`][] and
23422341
[`util.types.isSharedArrayBuffer()`][].
@@ -2355,8 +2354,8 @@ added: v10.0.0
23552354
* `value` {any}
23562355
* Returns: {boolean}
23572356
2358-
Returns `true` if the value is an instance of one of the [`ArrayBuffer`][]
2359-
views, such as typed array objects or [`DataView`][]. Equivalent to
2357+
Returns `true` if the value is an instance of one of the {ArrayBuffer}
2358+
views, such as typed array objects or {DataView}. Equivalent to
23602359
[`ArrayBuffer.isView()`][].
23612360
23622361
```js
@@ -2394,8 +2393,8 @@ added: v10.0.0
23942393
* `value` {any}
23952394
* Returns: {boolean}
23962395
2397-
Returns `true` if the value is a built-in [`ArrayBuffer`][] instance.
2398-
This does _not_ include [`SharedArrayBuffer`][] instances. Usually, it is
2396+
Returns `true` if the value is a built-in {ArrayBuffer} instance.
2397+
This does _not_ include {SharedArrayBuffer} instances. Usually, it is
23992398
desirable to test for both; See [`util.types.isAnyArrayBuffer()`][] for that.
24002399
24012400
```js
@@ -2535,7 +2534,7 @@ added: v10.0.0
25352534
* `value` {any}
25362535
* Returns: {boolean}
25372536
2538-
Returns `true` if the value is a built-in [`DataView`][] instance.
2537+
Returns `true` if the value is a built-in {DataView} instance.
25392538
25402539
```js
25412540
const ab = new ArrayBuffer(20);
@@ -2554,7 +2553,7 @@ added: v10.0.0
25542553
* `value` {any}
25552554
* Returns: {boolean}
25562555
2557-
Returns `true` if the value is a built-in [`Date`][] instance.
2556+
Returns `true` if the value is a built-in {Date} instance.
25582557
25592558
```js
25602559
util.types.isDate(new Date()); // Returns true
@@ -2615,7 +2614,7 @@ added: v10.0.0
26152614
* `value` {any}
26162615
* Returns: {boolean}
26172616
2618-
Returns `true` if the value is a built-in [`Float32Array`][] instance.
2617+
Returns `true` if the value is a built-in {Float32Array} instance.
26192618
26202619
```js
26212620
util.types.isFloat32Array(new ArrayBuffer()); // Returns false
@@ -2632,7 +2631,7 @@ added: v10.0.0
26322631
* `value` {any}
26332632
* Returns: {boolean}
26342633
2635-
Returns `true` if the value is a built-in [`Float64Array`][] instance.
2634+
Returns `true` if the value is a built-in {Float64Array} instance.
26362635
26372636
```js
26382637
util.types.isFloat64Array(new ArrayBuffer()); // Returns false
@@ -2689,7 +2688,7 @@ added: v10.0.0
26892688
* `value` {any}
26902689
* Returns: {boolean}
26912690
2692-
Returns `true` if the value is a built-in [`Int8Array`][] instance.
2691+
Returns `true` if the value is a built-in {Int8Array} instance.
26932692
26942693
```js
26952694
util.types.isInt8Array(new ArrayBuffer()); // Returns false
@@ -2706,7 +2705,7 @@ added: v10.0.0
27062705
* `value` {any}
27072706
* Returns: {boolean}
27082707
2709-
Returns `true` if the value is a built-in [`Int16Array`][] instance.
2708+
Returns `true` if the value is a built-in {Int16Array} instance.
27102709
27112710
```js
27122711
util.types.isInt16Array(new ArrayBuffer()); // Returns false
@@ -2723,7 +2722,7 @@ added: v10.0.0
27232722
* `value` {any}
27242723
* Returns: {boolean}
27252724
2726-
Returns `true` if the value is a built-in [`Int32Array`][] instance.
2725+
Returns `true` if the value is a built-in {Int32Array} instance.
27272726
27282727
```js
27292728
util.types.isInt32Array(new ArrayBuffer()); // Returns false
@@ -2751,7 +2750,7 @@ added: v10.0.0
27512750
* `value` {any}
27522751
* Returns: {boolean}
27532752
2754-
Returns `true` if the value is a built-in [`Map`][] instance.
2753+
Returns `true` if the value is a built-in {Map} instance.
27552754
27562755
```js
27572756
util.types.isMap(new Map()); // Returns true
@@ -2767,7 +2766,7 @@ added: v10.0.0
27672766
* Returns: {boolean}
27682767
27692768
Returns `true` if the value is an iterator returned for a built-in
2770-
[`Map`][] instance.
2769+
{Map} instance.
27712770
27722771
```js
27732772
const map = new Map();
@@ -2868,7 +2867,7 @@ added: v10.0.0
28682867
* `value` {any}
28692868
* Returns: {boolean}
28702869
2871-
Returns `true` if the value is a built-in [`Promise`][].
2870+
Returns `true` if the value is a built-in {Promise}.
28722871
28732872
```js
28742873
util.types.isPromise(Promise.resolve(42)); // Returns true
@@ -2883,7 +2882,7 @@ added: v10.0.0
28832882
* `value` {any}
28842883
* Returns: {boolean}
28852884
2886-
Returns `true` if the value is a [`Proxy`][] instance.
2885+
Returns `true` if the value is a {Proxy} instance.
28872886
28882887
```js
28892888
const target = {};
@@ -2917,7 +2916,7 @@ added: v10.0.0
29172916
* `value` {any}
29182917
* Returns: {boolean}
29192918
2920-
Returns `true` if the value is a built-in [`Set`][] instance.
2919+
Returns `true` if the value is a built-in {Set} instance.
29212920
29222921
```js
29232922
util.types.isSet(new Set()); // Returns true
@@ -2933,7 +2932,7 @@ added: v10.0.0
29332932
* Returns: {boolean}
29342933
29352934
Returns `true` if the value is an iterator returned for a built-in
2936-
[`Set`][] instance.
2935+
{Set} instance.
29372936
29382937
```js
29392938
const set = new Set();
@@ -2952,8 +2951,8 @@ added: v10.0.0
29522951
* `value` {any}
29532952
* Returns: {boolean}
29542953
2955-
Returns `true` if the value is a built-in [`SharedArrayBuffer`][] instance.
2956-
This does _not_ include [`ArrayBuffer`][] instances. Usually, it is
2954+
Returns `true` if the value is a built-in {SharedArrayBuffer} instance.
2955+
This does _not_ include {ArrayBuffer} instances. Usually, it is
29572956
desirable to test for both; See [`util.types.isAnyArrayBuffer()`][] for that.
29582957
29592958
```js
@@ -3005,7 +3004,7 @@ added: v10.0.0
30053004
* `value` {any}
30063005
* Returns: {boolean}
30073006
3008-
Returns `true` if the value is a built-in [`TypedArray`][] instance.
3007+
Returns `true` if the value is a built-in {TypedArray} instance.
30093008
30103009
```js
30113010
util.types.isTypedArray(new ArrayBuffer()); // Returns false
@@ -3024,7 +3023,7 @@ added: v10.0.0
30243023
* `value` {any}
30253024
* Returns: {boolean}
30263025
3027-
Returns `true` if the value is a built-in [`Uint8Array`][] instance.
3026+
Returns `true` if the value is a built-in {Uint8Array} instance.
30283027
30293028
```js
30303029
util.types.isUint8Array(new ArrayBuffer()); // Returns false
@@ -3041,7 +3040,7 @@ added: v10.0.0
30413040
* `value` {any}
30423041
* Returns: {boolean}
30433042
3044-
Returns `true` if the value is a built-in [`Uint8ClampedArray`][] instance.
3043+
Returns `true` if the value is a built-in {Uint8ClampedArray} instance.
30453044
30463045
```js
30473046
util.types.isUint8ClampedArray(new ArrayBuffer()); // Returns false
@@ -3058,7 +3057,7 @@ added: v10.0.0
30583057
* `value` {any}
30593058
* Returns: {boolean}
30603059
3061-
Returns `true` if the value is a built-in [`Uint16Array`][] instance.
3060+
Returns `true` if the value is a built-in {Uint16Array} instance.
30623061
30633062
```js
30643063
util.types.isUint16Array(new ArrayBuffer()); // Returns false
@@ -3075,7 +3074,7 @@ added: v10.0.0
30753074
* `value` {any}
30763075
* Returns: {boolean}
30773076
3078-
Returns `true` if the value is a built-in [`Uint32Array`][] instance.
3077+
Returns `true` if the value is a built-in {Uint32Array} instance.
30793078
30803079
```js
30813080
util.types.isUint32Array(new ArrayBuffer()); // Returns false
@@ -3092,7 +3091,7 @@ added: v10.0.0
30923091
* `value` {any}
30933092
* Returns: {boolean}
30943093
3095-
Returns `true` if the value is a built-in [`WeakMap`][] instance.
3094+
Returns `true` if the value is a built-in {WeakMap} instance.
30963095
30973096
```js
30983097
util.types.isWeakMap(new WeakMap()); // Returns true
@@ -3107,7 +3106,7 @@ added: v10.0.0
31073106
* `value` {any}
31083107
* Returns: {boolean}
31093108
3110-
Returns `true` if the value is a built-in [`WeakSet`][] instance.
3109+
Returns `true` if the value is a built-in {WeakSet} instance.
31113110
31123111
```js
31133112
util.types.isWeakSet(new WeakSet()); // Returns true
@@ -3250,7 +3249,7 @@ deprecated: v4.0.0
32503249
* `object` {any}
32513250
* Returns: {boolean}
32523251
3253-
Returns `true` if the given `object` is an [`Error`][]. Otherwise, returns
3252+
Returns `true` if the given `object` is an {Error}. Otherwise, returns
32543253
`false`.
32553254
32563255
```js
@@ -3592,33 +3591,12 @@ util.log('Timestamped message.');
35923591
[`'warning'`]: process.md#event-warning
35933592
[`Array.isArray()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray
35943593
[`ArrayBuffer.isView()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/isView
3595-
[`ArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer
35963594
[`Buffer.isBuffer()`]: buffer.md#static-method-bufferisbufferobj
3597-
[`DataView`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView
3598-
[`Date`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date
3599-
[`Error`]: errors.md#class-error
3600-
[`Float32Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float32Array
3601-
[`Float64Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array
3602-
[`Int16Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int16Array
3603-
[`Int32Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array
3604-
[`Int8Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int8Array
36053595
[`JSON.stringify()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
36063596
[`MIMEparams`]: #class-utilmimeparams
3607-
[`Map`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map
36083597
[`Object.assign()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign
36093598
[`Object.freeze()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/freeze
3610-
[`Promise`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
3611-
[`Proxy`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy
36123599
[`Runtime.ScriptId`]: https://chromedevtools.github.io/devtools-protocol/1-3/Runtime/#type-ScriptId
3613-
[`Set`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
3614-
[`SharedArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer
3615-
[`TypedArray`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
3616-
[`Uint16Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array
3617-
[`Uint32Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint32Array
3618-
[`Uint8Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array
3619-
[`Uint8ClampedArray`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8ClampedArray
3620-
[`WeakMap`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap
3621-
[`WeakSet`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet
36223600
[`assert.deepStrictEqual()`]: assert.md#assertdeepstrictequalactual-expected-message
36233601
[`console.error()`]: console.md#consoleerrordata-args
36243602
[`mime.toString()`]: #mimetostring

tools/doc/type-parser.mjs

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,14 @@ const jsPrimitives = {
1414
const jsGlobalObjectsUrl = `${jsDocPrefix}Reference/Global_Objects/`;
1515
const jsGlobalTypes = [
1616
'AggregateError', 'Array', 'ArrayBuffer', 'DataView', 'Date', 'Error',
17-
'EvalError', 'Function', 'Map', 'Object', 'Promise', 'Proxy', 'RangeError',
18-
'ReferenceError', 'RegExp', 'Set', 'SharedArrayBuffer', 'SyntaxError',
19-
'TypeError', 'TypedArray', 'URIError', 'Uint8Array',
17+
'EvalError', 'Function', 'Map', 'NaN', 'Object', 'Promise', 'Proxy', 'RangeError',
18+
'ReferenceError', 'RegExp', 'Set', 'SharedArrayBuffer', 'SyntaxError', 'Symbol',
19+
'TypeError', 'URIError', 'WeakMap', 'WeakSet',
20+
21+
'TypedArray',
22+
'Float32Array', 'Float64Array',
23+
'Int8Array', 'Int16Array', 'Int32Array',
24+
'Uint8Array', 'Uint8ClampedArray', 'Uint16Array', 'Uint32Array',
2025
];
2126

2227
const customTypesMap = {

0 commit comments

Comments
 (0)