Skip to content

Commit d901987

Browse files
aduh95targos
aduh95
authored and
targos
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 5f4377a commit d901987

File tree

2 files changed

+41
-57
lines changed

2 files changed

+41
-57
lines changed

‎doc/api/util.md

Lines changed: 33 additions & 54 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
@@ -2337,8 +2336,8 @@ added: v10.0.0
23372336
* `value` {any}
23382337
* Returns: {boolean}
23392338
2340-
Returns `true` if the value is a built-in [`ArrayBuffer`][] or
2341-
[`SharedArrayBuffer`][] instance.
2339+
Returns `true` if the value is a built-in {ArrayBuffer} or
2340+
{SharedArrayBuffer} instance.
23422341
23432342
See also [`util.types.isArrayBuffer()`][] and
23442343
[`util.types.isSharedArrayBuffer()`][].
@@ -2357,8 +2356,8 @@ added: v10.0.0
23572356
* `value` {any}
23582357
* Returns: {boolean}
23592358
2360-
Returns `true` if the value is an instance of one of the [`ArrayBuffer`][]
2361-
views, such as typed array objects or [`DataView`][]. Equivalent to
2359+
Returns `true` if the value is an instance of one of the {ArrayBuffer}
2360+
views, such as typed array objects or {DataView}. Equivalent to
23622361
[`ArrayBuffer.isView()`][].
23632362
23642363
```js
@@ -2396,8 +2395,8 @@ added: v10.0.0
23962395
* `value` {any}
23972396
* Returns: {boolean}
23982397
2399-
Returns `true` if the value is a built-in [`ArrayBuffer`][] instance.
2400-
This does _not_ include [`SharedArrayBuffer`][] instances. Usually, it is
2398+
Returns `true` if the value is a built-in {ArrayBuffer} instance.
2399+
This does _not_ include {SharedArrayBuffer} instances. Usually, it is
24012400
desirable to test for both; See [`util.types.isAnyArrayBuffer()`][] for that.
24022401
24032402
```js
@@ -2537,7 +2536,7 @@ added: v10.0.0
25372536
* `value` {any}
25382537
* Returns: {boolean}
25392538
2540-
Returns `true` if the value is a built-in [`DataView`][] instance.
2539+
Returns `true` if the value is a built-in {DataView} instance.
25412540
25422541
```js
25432542
const ab = new ArrayBuffer(20);
@@ -2556,7 +2555,7 @@ added: v10.0.0
25562555
* `value` {any}
25572556
* Returns: {boolean}
25582557
2559-
Returns `true` if the value is a built-in [`Date`][] instance.
2558+
Returns `true` if the value is a built-in {Date} instance.
25602559
25612560
```js
25622561
util.types.isDate(new Date()); // Returns true
@@ -2617,7 +2616,7 @@ added: v10.0.0
26172616
* `value` {any}
26182617
* Returns: {boolean}
26192618
2620-
Returns `true` if the value is a built-in [`Float32Array`][] instance.
2619+
Returns `true` if the value is a built-in {Float32Array} instance.
26212620
26222621
```js
26232622
util.types.isFloat32Array(new ArrayBuffer()); // Returns false
@@ -2634,7 +2633,7 @@ added: v10.0.0
26342633
* `value` {any}
26352634
* Returns: {boolean}
26362635
2637-
Returns `true` if the value is a built-in [`Float64Array`][] instance.
2636+
Returns `true` if the value is a built-in {Float64Array} instance.
26382637
26392638
```js
26402639
util.types.isFloat64Array(new ArrayBuffer()); // Returns false
@@ -2691,7 +2690,7 @@ added: v10.0.0
26912690
* `value` {any}
26922691
* Returns: {boolean}
26932692
2694-
Returns `true` if the value is a built-in [`Int8Array`][] instance.
2693+
Returns `true` if the value is a built-in {Int8Array} instance.
26952694
26962695
```js
26972696
util.types.isInt8Array(new ArrayBuffer()); // Returns false
@@ -2708,7 +2707,7 @@ added: v10.0.0
27082707
* `value` {any}
27092708
* Returns: {boolean}
27102709
2711-
Returns `true` if the value is a built-in [`Int16Array`][] instance.
2710+
Returns `true` if the value is a built-in {Int16Array} instance.
27122711
27132712
```js
27142713
util.types.isInt16Array(new ArrayBuffer()); // Returns false
@@ -2725,7 +2724,7 @@ added: v10.0.0
27252724
* `value` {any}
27262725
* Returns: {boolean}
27272726
2728-
Returns `true` if the value is a built-in [`Int32Array`][] instance.
2727+
Returns `true` if the value is a built-in {Int32Array} instance.
27292728
27302729
```js
27312730
util.types.isInt32Array(new ArrayBuffer()); // Returns false
@@ -2753,7 +2752,7 @@ added: v10.0.0
27532752
* `value` {any}
27542753
* Returns: {boolean}
27552754
2756-
Returns `true` if the value is a built-in [`Map`][] instance.
2755+
Returns `true` if the value is a built-in {Map} instance.
27572756
27582757
```js
27592758
util.types.isMap(new Map()); // Returns true
@@ -2769,7 +2768,7 @@ added: v10.0.0
27692768
* Returns: {boolean}
27702769
27712770
Returns `true` if the value is an iterator returned for a built-in
2772-
[`Map`][] instance.
2771+
{Map} instance.
27732772
27742773
```js
27752774
const map = new Map();
@@ -2870,7 +2869,7 @@ added: v10.0.0
28702869
* `value` {any}
28712870
* Returns: {boolean}
28722871
2873-
Returns `true` if the value is a built-in [`Promise`][].
2872+
Returns `true` if the value is a built-in {Promise}.
28742873
28752874
```js
28762875
util.types.isPromise(Promise.resolve(42)); // Returns true
@@ -2885,7 +2884,7 @@ added: v10.0.0
28852884
* `value` {any}
28862885
* Returns: {boolean}
28872886
2888-
Returns `true` if the value is a [`Proxy`][] instance.
2887+
Returns `true` if the value is a {Proxy} instance.
28892888
28902889
```js
28912890
const target = {};
@@ -2919,7 +2918,7 @@ added: v10.0.0
29192918
* `value` {any}
29202919
* Returns: {boolean}
29212920
2922-
Returns `true` if the value is a built-in [`Set`][] instance.
2921+
Returns `true` if the value is a built-in {Set} instance.
29232922
29242923
```js
29252924
util.types.isSet(new Set()); // Returns true
@@ -2935,7 +2934,7 @@ added: v10.0.0
29352934
* Returns: {boolean}
29362935
29372936
Returns `true` if the value is an iterator returned for a built-in
2938-
[`Set`][] instance.
2937+
{Set} instance.
29392938
29402939
```js
29412940
const set = new Set();
@@ -2954,8 +2953,8 @@ added: v10.0.0
29542953
* `value` {any}
29552954
* Returns: {boolean}
29562955
2957-
Returns `true` if the value is a built-in [`SharedArrayBuffer`][] instance.
2958-
This does _not_ include [`ArrayBuffer`][] instances. Usually, it is
2956+
Returns `true` if the value is a built-in {SharedArrayBuffer} instance.
2957+
This does _not_ include {ArrayBuffer} instances. Usually, it is
29592958
desirable to test for both; See [`util.types.isAnyArrayBuffer()`][] for that.
29602959
29612960
```js
@@ -3007,7 +3006,7 @@ added: v10.0.0
30073006
* `value` {any}
30083007
* Returns: {boolean}
30093008
3010-
Returns `true` if the value is a built-in [`TypedArray`][] instance.
3009+
Returns `true` if the value is a built-in {TypedArray} instance.
30113010
30123011
```js
30133012
util.types.isTypedArray(new ArrayBuffer()); // Returns false
@@ -3026,7 +3025,7 @@ added: v10.0.0
30263025
* `value` {any}
30273026
* Returns: {boolean}
30283027
3029-
Returns `true` if the value is a built-in [`Uint8Array`][] instance.
3028+
Returns `true` if the value is a built-in {Uint8Array} instance.
30303029
30313030
```js
30323031
util.types.isUint8Array(new ArrayBuffer()); // Returns false
@@ -3043,7 +3042,7 @@ added: v10.0.0
30433042
* `value` {any}
30443043
* Returns: {boolean}
30453044
3046-
Returns `true` if the value is a built-in [`Uint8ClampedArray`][] instance.
3045+
Returns `true` if the value is a built-in {Uint8ClampedArray} instance.
30473046
30483047
```js
30493048
util.types.isUint8ClampedArray(new ArrayBuffer()); // Returns false
@@ -3060,7 +3059,7 @@ added: v10.0.0
30603059
* `value` {any}
30613060
* Returns: {boolean}
30623061
3063-
Returns `true` if the value is a built-in [`Uint16Array`][] instance.
3062+
Returns `true` if the value is a built-in {Uint16Array} instance.
30643063
30653064
```js
30663065
util.types.isUint16Array(new ArrayBuffer()); // Returns false
@@ -3077,7 +3076,7 @@ added: v10.0.0
30773076
* `value` {any}
30783077
* Returns: {boolean}
30793078
3080-
Returns `true` if the value is a built-in [`Uint32Array`][] instance.
3079+
Returns `true` if the value is a built-in {Uint32Array} instance.
30813080
30823081
```js
30833082
util.types.isUint32Array(new ArrayBuffer()); // Returns false
@@ -3094,7 +3093,7 @@ added: v10.0.0
30943093
* `value` {any}
30953094
* Returns: {boolean}
30963095
3097-
Returns `true` if the value is a built-in [`WeakMap`][] instance.
3096+
Returns `true` if the value is a built-in {WeakMap} instance.
30983097
30993098
```js
31003099
util.types.isWeakMap(new WeakMap()); // Returns true
@@ -3109,7 +3108,7 @@ added: v10.0.0
31093108
* `value` {any}
31103109
* Returns: {boolean}
31113110
3112-
Returns `true` if the value is a built-in [`WeakSet`][] instance.
3111+
Returns `true` if the value is a built-in {WeakSet} instance.
31133112
31143113
```js
31153114
util.types.isWeakSet(new WeakSet()); // Returns true
@@ -3176,31 +3175,11 @@ util.isArray({});
31763175
[`'warning'`]: process.md#event-warning
31773176
[`Array.isArray()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray
31783177
[`ArrayBuffer.isView()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/isView
3179-
[`ArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer
3180-
[`DataView`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView
3181-
[`Date`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date
3182-
[`Float32Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float32Array
3183-
[`Float64Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array
3184-
[`Int16Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int16Array
3185-
[`Int32Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array
3186-
[`Int8Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int8Array
31873178
[`JSON.stringify()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
31883179
[`MIMEparams`]: #class-utilmimeparams
3189-
[`Map`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map
31903180
[`Object.assign()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign
31913181
[`Object.freeze()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/freeze
3192-
[`Promise`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
3193-
[`Proxy`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy
31943182
[`Runtime.ScriptId`]: https://chromedevtools.github.io/devtools-protocol/1-3/Runtime/#type-ScriptId
3195-
[`Set`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
3196-
[`SharedArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer
3197-
[`TypedArray`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
3198-
[`Uint16Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array
3199-
[`Uint32Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint32Array
3200-
[`Uint8Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array
3201-
[`Uint8ClampedArray`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8ClampedArray
3202-
[`WeakMap`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap
3203-
[`WeakSet`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet
32043183
[`assert.deepStrictEqual()`]: assert.md#assertdeepstrictequalactual-expected-message
32053184
[`console.error()`]: console.md#consoleerrordata-args
32063185
[`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)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy