Skip to content

Commit db0fadd

Browse files
aduh95aduh95
authored
doc: make MDN links to global classes more consistent in util.md
PR-URL: #56922 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent ef30314 commit db0fadd

File tree

2 files changed

+41
-57
lines changed

2 files changed

+41
-57
lines changed

‎doc/api/util.md

+33-54
Original file line numberDiff line numberDiff line change
@@ -695,8 +695,8 @@ changes:
695695
* `object` {any} Any JavaScript primitive or `Object`.
696696
* `options` {Object}
697697
* `showHidden` {boolean} If `true`, `object`'s non-enumerable symbols and
698-
properties are included in the formatted result. [`WeakMap`][] and
699-
[`WeakSet`][] entries are also included as well as user defined prototype
698+
properties are included in the formatted result. {WeakMap} and
699+
{WeakSet} entries are also included as well as user defined prototype
700700
properties (excluding method properties). **Default:** `false`.
701701
* `depth` {number} Specifies the number of times to recurse while formatting
702702
`object`. This is useful for inspecting large objects. To recurse up to
@@ -711,8 +711,7 @@ changes:
711711
* `showProxy` {boolean} If `true`, `Proxy` inspection includes
712712
the [`target` and `handler`][] objects. **Default:** `false`.
713713
* `maxArrayLength` {integer} Specifies the maximum number of `Array`,
714-
[`TypedArray`][], [`Map`][], [`Set`][], [`WeakMap`][],
715-
and [`WeakSet`][] elements to include when formatting.
714+
{TypedArray}, {Map}, {WeakMap}, and {WeakSet} elements to include when formatting.
716715
Set to `null` or `Infinity` to show all elements. Set to `0` or
717716
negative to show no elements. **Default:** `100`.
718717
* `maxStringLength` {integer} Specifies the maximum number of characters to
@@ -843,10 +842,10 @@ console.log(util.inspect(o, { compact: false, depth: 5, breakLength: 80 }));
843842
// single line.
844843
```
845844

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

852851
```js
@@ -2343,8 +2342,8 @@ added: v10.0.0
23432342
* `value` {any}
23442343
* Returns: {boolean}
23452344
2346-
Returns `true` if the value is a built-in [`ArrayBuffer`][] or
2347-
[`SharedArrayBuffer`][] instance.
2345+
Returns `true` if the value is a built-in {ArrayBuffer} or
2346+
{SharedArrayBuffer} instance.
23482347
23492348
See also [`util.types.isArrayBuffer()`][] and
23502349
[`util.types.isSharedArrayBuffer()`][].
@@ -2363,8 +2362,8 @@ added: v10.0.0
23632362
* `value` {any}
23642363
* Returns: {boolean}
23652364
2366-
Returns `true` if the value is an instance of one of the [`ArrayBuffer`][]
2367-
views, such as typed array objects or [`DataView`][]. Equivalent to
2365+
Returns `true` if the value is an instance of one of the {ArrayBuffer}
2366+
views, such as typed array objects or {DataView}. Equivalent to
23682367
[`ArrayBuffer.isView()`][].
23692368
23702369
```js
@@ -2402,8 +2401,8 @@ added: v10.0.0
24022401
* `value` {any}
24032402
* Returns: {boolean}
24042403
2405-
Returns `true` if the value is a built-in [`ArrayBuffer`][] instance.
2406-
This does _not_ include [`SharedArrayBuffer`][] instances. Usually, it is
2404+
Returns `true` if the value is a built-in {ArrayBuffer} instance.
2405+
This does _not_ include {SharedArrayBuffer} instances. Usually, it is
24072406
desirable to test for both; See [`util.types.isAnyArrayBuffer()`][] for that.
24082407
24092408
```js
@@ -2543,7 +2542,7 @@ added: v10.0.0
25432542
* `value` {any}
25442543
* Returns: {boolean}
25452544
2546-
Returns `true` if the value is a built-in [`DataView`][] instance.
2545+
Returns `true` if the value is a built-in {DataView} instance.
25472546
25482547
```js
25492548
const ab = new ArrayBuffer(20);
@@ -2562,7 +2561,7 @@ added: v10.0.0
25622561
* `value` {any}
25632562
* Returns: {boolean}
25642563
2565-
Returns `true` if the value is a built-in [`Date`][] instance.
2564+
Returns `true` if the value is a built-in {Date} instance.
25662565
25672566
```js
25682567
util.types.isDate(new Date()); // Returns true
@@ -2623,7 +2622,7 @@ added: v10.0.0
26232622
* `value` {any}
26242623
* Returns: {boolean}
26252624
2626-
Returns `true` if the value is a built-in [`Float32Array`][] instance.
2625+
Returns `true` if the value is a built-in {Float32Array} instance.
26272626
26282627
```js
26292628
util.types.isFloat32Array(new ArrayBuffer()); // Returns false
@@ -2640,7 +2639,7 @@ added: v10.0.0
26402639
* `value` {any}
26412640
* Returns: {boolean}
26422641
2643-
Returns `true` if the value is a built-in [`Float64Array`][] instance.
2642+
Returns `true` if the value is a built-in {Float64Array} instance.
26442643
26452644
```js
26462645
util.types.isFloat64Array(new ArrayBuffer()); // Returns false
@@ -2697,7 +2696,7 @@ added: v10.0.0
26972696
* `value` {any}
26982697
* Returns: {boolean}
26992698
2700-
Returns `true` if the value is a built-in [`Int8Array`][] instance.
2699+
Returns `true` if the value is a built-in {Int8Array} instance.
27012700
27022701
```js
27032702
util.types.isInt8Array(new ArrayBuffer()); // Returns false
@@ -2714,7 +2713,7 @@ added: v10.0.0
27142713
* `value` {any}
27152714
* Returns: {boolean}
27162715
2717-
Returns `true` if the value is a built-in [`Int16Array`][] instance.
2716+
Returns `true` if the value is a built-in {Int16Array} instance.
27182717
27192718
```js
27202719
util.types.isInt16Array(new ArrayBuffer()); // Returns false
@@ -2731,7 +2730,7 @@ added: v10.0.0
27312730
* `value` {any}
27322731
* Returns: {boolean}
27332732
2734-
Returns `true` if the value is a built-in [`Int32Array`][] instance.
2733+
Returns `true` if the value is a built-in {Int32Array} instance.
27352734
27362735
```js
27372736
util.types.isInt32Array(new ArrayBuffer()); // Returns false
@@ -2759,7 +2758,7 @@ added: v10.0.0
27592758
* `value` {any}
27602759
* Returns: {boolean}
27612760
2762-
Returns `true` if the value is a built-in [`Map`][] instance.
2761+
Returns `true` if the value is a built-in {Map} instance.
27632762
27642763
```js
27652764
util.types.isMap(new Map()); // Returns true
@@ -2775,7 +2774,7 @@ added: v10.0.0
27752774
* Returns: {boolean}
27762775
27772776
Returns `true` if the value is an iterator returned for a built-in
2778-
[`Map`][] instance.
2777+
{Map} instance.
27792778
27802779
```js
27812780
const map = new Map();
@@ -2876,7 +2875,7 @@ added: v10.0.0
28762875
* `value` {any}
28772876
* Returns: {boolean}
28782877
2879-
Returns `true` if the value is a built-in [`Promise`][].
2878+
Returns `true` if the value is a built-in {Promise}.
28802879
28812880
```js
28822881
util.types.isPromise(Promise.resolve(42)); // Returns true
@@ -2891,7 +2890,7 @@ added: v10.0.0
28912890
* `value` {any}
28922891
* Returns: {boolean}
28932892
2894-
Returns `true` if the value is a [`Proxy`][] instance.
2893+
Returns `true` if the value is a {Proxy} instance.
28952894
28962895
```js
28972896
const target = {};
@@ -2925,7 +2924,7 @@ added: v10.0.0
29252924
* `value` {any}
29262925
* Returns: {boolean}
29272926
2928-
Returns `true` if the value is a built-in [`Set`][] instance.
2927+
Returns `true` if the value is a built-in {Set} instance.
29292928
29302929
```js
29312930
util.types.isSet(new Set()); // Returns true
@@ -2941,7 +2940,7 @@ added: v10.0.0
29412940
* Returns: {boolean}
29422941
29432942
Returns `true` if the value is an iterator returned for a built-in
2944-
[`Set`][] instance.
2943+
{Set} instance.
29452944
29462945
```js
29472946
const set = new Set();
@@ -2960,8 +2959,8 @@ added: v10.0.0
29602959
* `value` {any}
29612960
* Returns: {boolean}
29622961
2963-
Returns `true` if the value is a built-in [`SharedArrayBuffer`][] instance.
2964-
This does _not_ include [`ArrayBuffer`][] instances. Usually, it is
2962+
Returns `true` if the value is a built-in {SharedArrayBuffer} instance.
2963+
This does _not_ include {ArrayBuffer} instances. Usually, it is
29652964
desirable to test for both; See [`util.types.isAnyArrayBuffer()`][] for that.
29662965
29672966
```js
@@ -3013,7 +3012,7 @@ added: v10.0.0
30133012
* `value` {any}
30143013
* Returns: {boolean}
30153014
3016-
Returns `true` if the value is a built-in [`TypedArray`][] instance.
3015+
Returns `true` if the value is a built-in {TypedArray} instance.
30173016
30183017
```js
30193018
util.types.isTypedArray(new ArrayBuffer()); // Returns false
@@ -3032,7 +3031,7 @@ added: v10.0.0
30323031
* `value` {any}
30333032
* Returns: {boolean}
30343033
3035-
Returns `true` if the value is a built-in [`Uint8Array`][] instance.
3034+
Returns `true` if the value is a built-in {Uint8Array} instance.
30363035
30373036
```js
30383037
util.types.isUint8Array(new ArrayBuffer()); // Returns false
@@ -3049,7 +3048,7 @@ added: v10.0.0
30493048
* `value` {any}
30503049
* Returns: {boolean}
30513050
3052-
Returns `true` if the value is a built-in [`Uint8ClampedArray`][] instance.
3051+
Returns `true` if the value is a built-in {Uint8ClampedArray} instance.
30533052
30543053
```js
30553054
util.types.isUint8ClampedArray(new ArrayBuffer()); // Returns false
@@ -3066,7 +3065,7 @@ added: v10.0.0
30663065
* `value` {any}
30673066
* Returns: {boolean}
30683067
3069-
Returns `true` if the value is a built-in [`Uint16Array`][] instance.
3068+
Returns `true` if the value is a built-in {Uint16Array} instance.
30703069
30713070
```js
30723071
util.types.isUint16Array(new ArrayBuffer()); // Returns false
@@ -3083,7 +3082,7 @@ added: v10.0.0
30833082
* `value` {any}
30843083
* Returns: {boolean}
30853084
3086-
Returns `true` if the value is a built-in [`Uint32Array`][] instance.
3085+
Returns `true` if the value is a built-in {Uint32Array} instance.
30873086
30883087
```js
30893088
util.types.isUint32Array(new ArrayBuffer()); // Returns false
@@ -3100,7 +3099,7 @@ added: v10.0.0
31003099
* `value` {any}
31013100
* Returns: {boolean}
31023101
3103-
Returns `true` if the value is a built-in [`WeakMap`][] instance.
3102+
Returns `true` if the value is a built-in {WeakMap} instance.
31043103
31053104
```js
31063105
util.types.isWeakMap(new WeakMap()); // Returns true
@@ -3115,7 +3114,7 @@ added: v10.0.0
31153114
* `value` {any}
31163115
* Returns: {boolean}
31173116
3118-
Returns `true` if the value is a built-in [`WeakSet`][] instance.
3117+
Returns `true` if the value is a built-in {WeakSet} instance.
31193118
31203119
```js
31213120
util.types.isWeakSet(new WeakSet()); // Returns true
@@ -3182,31 +3181,11 @@ util.isArray({});
31823181
[`'warning'`]: process.md#event-warning
31833182
[`Array.isArray()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray
31843183
[`ArrayBuffer.isView()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/isView
3185-
[`ArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer
3186-
[`DataView`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView
3187-
[`Date`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date
3188-
[`Float32Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float32Array
3189-
[`Float64Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array
3190-
[`Int16Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int16Array
3191-
[`Int32Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array
3192-
[`Int8Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int8Array
31933184
[`JSON.stringify()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
31943185
[`MIMEparams`]: #class-utilmimeparams
3195-
[`Map`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map
31963186
[`Object.assign()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign
31973187
[`Object.freeze()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/freeze
3198-
[`Promise`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
3199-
[`Proxy`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy
32003188
[`Runtime.ScriptId`]: https://chromedevtools.github.io/devtools-protocol/1-3/Runtime/#type-ScriptId
3201-
[`Set`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
3202-
[`SharedArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer
3203-
[`TypedArray`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
3204-
[`Uint16Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array
3205-
[`Uint32Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint32Array
3206-
[`Uint8Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array
3207-
[`Uint8ClampedArray`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8ClampedArray
3208-
[`WeakMap`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap
3209-
[`WeakSet`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet
32103189
[`assert.deepStrictEqual()`]: assert.md#assertdeepstrictequalactual-expected-message
32113190
[`console.error()`]: console.md#consoleerrordata-args
32123191
[`mime.toString()`]: #mimetostring

‎tools/doc/type-parser.mjs

+8-3
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)