doc: add and unify even more return values

PR-URL: https://github.com/nodejs/node/pull/19955
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>

1 files changed, 70 insertions, 0 deletions

diff --git a/doc/api/util.md b/doc/api/util.md
index 6dd29c620c..0b2de54ff2 100644
--- a/doc/api/util.md
+++ b/doc/api/util.md
@@ -938,6 +938,8 @@ useful for addon developers who prefer to do type checking in JavaScript.
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a built-in [`ArrayBuffer`][] or
 [`SharedArrayBuffer`][] instance.
 
@@ -956,6 +958,8 @@ util.types.isAnyArrayBuffer(new SharedArrayBuffer());  // Returns true
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is an `arguments` object.
 
 For example:
@@ -972,6 +976,8 @@ function foo() {
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a built-in [`ArrayBuffer`][] instance.
 This does *not* include [`SharedArrayBuffer`][] instances. Usually, it is
 desirable to test for both; See [`util.types.isAnyArrayBuffer()`][] for that.
@@ -988,6 +994,8 @@ util.types.isArrayBuffer(new SharedArrayBuffer());  // Returns false
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is an [async function][].
 Note that this only reports back what the JavaScript engine is seeing;
 in particular, the return value may not match the original source code if
@@ -1005,6 +1013,8 @@ util.types.isAsyncFunction(async function foo() {});  // Returns true
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a boolean object, e.g. created
 by `new Boolean()`.
 
@@ -1024,6 +1034,8 @@ util.types.isBooleanObject(Boolean(true)); // Returns false
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a built-in [`DataView`][] instance.
 
 For example:
@@ -1041,6 +1053,8 @@ See also [`ArrayBuffer.isView()`][].
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a built-in [`Date`][] instance.
 
 For example:
@@ -1054,6 +1068,8 @@ util.types.isDate(new Date());  // Returns true
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a native `External` value.
 
 ### util.types.isFloat32Array(value)
@@ -1061,6 +1077,8 @@ Returns `true` if the value is a native `External` value.
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a built-in [`Float32Array`][] instance.
 
 For example:
@@ -1076,6 +1094,8 @@ util.types.isFloat32Array(new Float64Array());  // Returns false
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a built-in [`Float64Array`][] instance.
 
 For example:
@@ -1091,6 +1111,8 @@ util.types.isFloat64Array(new Float64Array());  // Returns true
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a generator function.
 Note that this only reports back what the JavaScript engine is seeing;
 in particular, the return value may not match the original source code if
@@ -1108,6 +1130,8 @@ util.types.isGeneratorFunction(function* foo() {});  // Returns true
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a generator object as returned from a
 built-in generator function.
 Note that this only reports back what the JavaScript engine is seeing;
@@ -1127,6 +1151,8 @@ util.types.isGeneratorObject(generator);  // Returns true
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a built-in [`Int8Array`][] instance.
 
 For example:
@@ -1142,6 +1168,8 @@ util.types.isInt8Array(new Float64Array());  // Returns false
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a built-in [`Int16Array`][] instance.
 
 For example:
@@ -1157,6 +1185,8 @@ util.types.isInt16Array(new Float64Array());  // Returns false
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a built-in [`Int32Array`][] instance.
 
 For example:
@@ -1172,6 +1202,8 @@ util.types.isInt32Array(new Float64Array());  // Returns false
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a built-in [`Map`][] instance.
 
 For example:
@@ -1185,6 +1217,8 @@ util.types.isMap(new Map());  // Returns true
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is an iterator returned for a built-in
 [`Map`][] instance.
 
@@ -1203,6 +1237,8 @@ util.types.isMapIterator(map[Symbol.iterator]());  // Returns true
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is an instance of a built-in [`Error`][] type.
 
 For example:
@@ -1218,6 +1254,8 @@ util.types.isNativeError(new RangeError());  // Returns true
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a number object, e.g. created
 by `new Number()`.
 
@@ -1233,6 +1271,8 @@ util.types.isNumberObject(new Number(0));   // Returns true
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a built-in [`Promise`][].
 
 For example:
@@ -1246,6 +1286,8 @@ util.types.isPromise(Promise.resolve(42));  // Returns true
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a [`Proxy`][] instance.
 
 For example:
@@ -1262,6 +1304,8 @@ util.types.isProxy(proxy);  // Returns true
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a regular expression object.
 
 For example:
@@ -1276,6 +1320,8 @@ util.types.isRegExp(new RegExp('abc'));  // Returns true
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a built-in [`Set`][] instance.
 
 For example:
@@ -1289,6 +1335,8 @@ util.types.isSet(new Set());  // Returns true
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is an iterator returned for a built-in
 [`Set`][] instance.
 
@@ -1307,6 +1355,8 @@ util.types.isSetIterator(set[Symbol.iterator]());  // Returns true
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a built-in [`SharedArrayBuffer`][] instance.
 This does *not* include [`ArrayBuffer`][] instances. Usually, it is
 desirable to test for both; See [`util.types.isAnyArrayBuffer()`][] for that.
@@ -1323,6 +1373,8 @@ util.types.isSharedArrayBuffer(new SharedArrayBuffer());  // Returns true
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a string object, e.g. created
 by `new String()`.
 
@@ -1338,6 +1390,8 @@ util.types.isStringObject(new String('foo'));   // Returns true
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a symbol object, created
 by calling `Object()` on a `Symbol` primitive.
 
@@ -1354,6 +1408,8 @@ util.types.isSymbolObject(Object(symbol));   // Returns true
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a built-in [`TypedArray`][] instance.
 
 For example:
@@ -1371,6 +1427,8 @@ See also [`ArrayBuffer.isView()`][].
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a built-in [`Uint8Array`][] instance.
 
 For example:
@@ -1386,6 +1444,8 @@ util.types.isUint8Array(new Float64Array());  // Returns false
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a built-in [`Uint8ClampedArray`][] instance.
 
 For example:
@@ -1401,6 +1461,8 @@ util.types.isUint8ClampedArray(new Float64Array());  // Returns false
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a built-in [`Uint16Array`][] instance.
 
 For example:
@@ -1416,6 +1478,8 @@ util.types.isUint16Array(new Float64Array());  // Returns false
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a built-in [`Uint32Array`][] instance.
 
 For example:
@@ -1431,6 +1495,8 @@ util.types.isUint32Array(new Float64Array());  // Returns false
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a built-in [`WeakMap`][] instance.
 
 For example:
@@ -1444,6 +1510,8 @@ util.types.isWeakMap(new WeakMap());  // Returns true
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a built-in [`WeakSet`][] instance.
 
 For example:
@@ -1457,6 +1525,8 @@ util.types.isWeakSet(new WeakSet());  // Returns true
 added: REPLACEME
 -->
 
+* Returns: {boolean}
+
 Returns `true` if the value is a built-in [`WebAssembly.Module`][] instance.
 
 For example: