doc,util: use code markup/markdown in headers

PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2026-01-15 12:15:26 +00:00 · 2019-12-24 15:54:49 -08:00
parent d9004dae67
commit ff6e7a0b3e
1 changed files with 81 additions and 81 deletions
--- a/doc/api/util.md
+++ b/doc/api/util.md
@@ -12,7 +12,7 @@ module developers as well. It can be accessed using:
 const util = require('util');
 ```

-## util.callbackify(original)
+## `util.callbackify(original)`
 <!-- YAML
 added: v8.2.0
 -->
@@ -68,7 +68,7 @@ callbackFunction((err, ret) => {
 });
 ```

-## util.debuglog(section)
+## `util.debuglog(section)`
 <!-- YAML
 added: v0.11.3
 -->
@@ -119,7 +119,7 @@ FOO-BAR 3257: hi there, it's foo-bar [2333]
 Multiple comma-separated `section` names may be specified in the `NODE_DEBUG`
 environment variable: `NODE_DEBUG=fs,net,tls`.

-## util.deprecate(fn, msg\[, code\])
+## `util.deprecate(fn, msg[, code])`
 <!-- YAML
 added: v0.8.0
 changes:
@@ -181,7 +181,7 @@ The `--throw-deprecation` command line flag and `process.throwDeprecation`
 property take precedence over `--trace-deprecation` and
 `process.traceDeprecation`.

-## util.format(format\[, ...args\])
+## `util.format(format[, ...args])`
 <!-- YAML
 added: v0.5.3
 changes:
@@ -287,7 +287,7 @@ util.format('%% %s');
 Some input values can have a significant performance overhead that can block the
 event loop. Use this function with care and never in a hot code path.

-## util.formatWithOptions(inspectOptions, format\[, ...args\])
+## `util.formatWithOptions(inspectOptions, format[, ...args])`
 <!-- YAML
 added: v10.0.0
 -->
@@ -305,7 +305,7 @@ util.formatWithOptions({ colors: true }, 'See object %O', { foo: 42 });
 // when printed to a terminal.
 ```

-## util.getSystemErrorName(err)
+## `util.getSystemErrorName(err)`
 <!-- YAML
 added: v9.7.0
 -->
@@ -324,7 +324,7 @@ fs.access('file/that/does/not/exist', (err) => {
 });
 ```

-## util.inherits(constructor, superConstructor)
+## `util.inherits(constructor, superConstructor)`
 <!-- YAML
 added: v0.3.0
 changes:
@@ -393,8 +393,8 @@ stream.on('data', (data) => {
 stream.write('With ES6');
 ```

-## util.inspect(object\[, options\])
-## util.inspect(object\[, showHidden\[, depth\[, colors\]\]\])
+## `util.inspect(object[, options])`
+## `util.inspect(object[, showHidden[, depth[, colors]]])`
 <!-- YAML
 added: v0.3.0
 changes:
@@ -805,7 +805,7 @@ util.inspect(obj);
 // Returns: "{ bar: 'baz' }"
 ```

-### util.inspect.custom
+### `util.inspect.custom`
 <!-- YAML
 added: v6.6.0
 changes:
@@ -844,7 +844,7 @@ console.log(password);

 See [Custom inspection functions on Objects][] for more details.

-### util.inspect.defaultOptions
+### `util.inspect.defaultOptions`
 <!-- YAML
 added: v6.4.0
 -->
@@ -864,7 +864,7 @@ util.inspect.defaultOptions.maxArrayLength = null;
 console.log(arr); // logs the full array
 ```

-## util.isDeepStrictEqual(val1, val2)
+## `util.isDeepStrictEqual(val1, val2)`
 <!-- YAML
 added: v9.0.0
 -->
@@ -879,7 +879,7 @@ Otherwise, returns `false`.
 See [`assert.deepStrictEqual()`][] for more information about deep strict
 equality.

-## util.promisify(original)
+## `util.promisify(original)`
 <!-- YAML
 added: v8.0.0
 -->
@@ -992,7 +992,7 @@ doSomething[util.promisify.custom] = (foo) => {
 If `promisify.custom` is defined but is not a function, `promisify()` will
 throw an error.

-### util.promisify.custom
+### `util.promisify.custom`
 <!-- YAML
 added: v8.0.0
 -->
@@ -1000,7 +1000,7 @@ added: v8.0.0
 * {symbol} that can be used to declare custom promisified variants of functions,
 see [Custom promisified functions][].

-## Class: util.TextDecoder
+## Class: `util.TextDecoder`
 <!-- YAML
 added: v8.3.0
 -->
@@ -1083,7 +1083,7 @@ Different Node.js build configurations support different sets of encodings.
 The `'iso-8859-16'` encoding listed in the [WHATWG Encoding Standard][]
 is not supported.

-### new TextDecoder(\[encoding\[, options\]\])
+### `new TextDecoder([encoding[, options]])`
 <!-- YAML
 added: v8.3.0
 changes:
@@ -1108,7 +1108,7 @@ supported encodings or an alias.

 The `TextDecoder` class is also available on the global object.

-### textDecoder.decode(\[input\[, options\]\])
+### `textDecoder.decode([input[, options]])`

 * `input` {ArrayBuffer|DataView|TypedArray} An `ArrayBuffer`, `DataView` or
  `TypedArray` instance containing the encoded data.
@@ -1124,27 +1124,27 @@ internally and emitted after the next call to `textDecoder.decode()`.
 If `textDecoder.fatal` is `true`, decoding errors that occur will result in a
 `TypeError` being thrown.

-### textDecoder.encoding
+### `textDecoder.encoding`

 * {string}

 The encoding supported by the `TextDecoder` instance.

-### textDecoder.fatal
+### `textDecoder.fatal`

 * {boolean}

 The value will be `true` if decoding errors result in a `TypeError` being
 thrown.

-### textDecoder.ignoreBOM
+### `textDecoder.ignoreBOM`

 * {boolean}

 The value will be `true` if the decoding result will include the byte order
 mark.

-## Class: util.TextEncoder
+## Class: `util.TextEncoder`
 <!-- YAML
 added: v8.3.0
 changes:
@@ -1163,7 +1163,7 @@ const uint8array = encoder.encode('this is some data');

 The `TextEncoder` class is also available on the global object.

-### textEncoder.encode(\[input\])
+### `textEncoder.encode([input])`

 * `input` {string} The text to encode. **Default:** an empty string.
 * Returns: {Uint8Array}
@@ -1171,7 +1171,7 @@ The `TextEncoder` class is also available on the global object.
 UTF-8 encodes the `input` string and returns a `Uint8Array` containing the
 encoded bytes.

-### textEncoder.encodeInto(src, dest)
+### `textEncoder.encodeInto(src, dest)`

 * `src` {string} The text to encode.
 * `dest` {Uint8Array} The array to hold the encode result.
@@ -1189,13 +1189,13 @@ const dest = new Uint8Array(10);
 const { read, written } = encoder.encodeInto(src, dest);
 ```

-### textEncoder.encoding
+### `textEncoder.encoding`

 * {string}

 The encoding supported by the `TextEncoder` instance. Always set to `'utf-8'`.

-## util.types
+## `util.types`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1209,7 +1209,7 @@ The result generally does not make any guarantees about what kinds of
 properties or behavior a value exposes in JavaScript. They are primarily
 useful for addon developers who prefer to do type checking in JavaScript.

-### util.types.isAnyArrayBuffer(value)
+### `util.types.isAnyArrayBuffer(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1228,7 +1228,7 @@ util.types.isAnyArrayBuffer(new ArrayBuffer());  // Returns true
 util.types.isAnyArrayBuffer(new SharedArrayBuffer());  // Returns true
 ```

-### util.types.isArgumentsObject(value)
+### `util.types.isArgumentsObject(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1245,7 +1245,7 @@ function foo() {
 }
 ```

-### util.types.isArrayBuffer(value)
+### `util.types.isArrayBuffer(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1262,7 +1262,7 @@ util.types.isArrayBuffer(new ArrayBuffer());  // Returns true
 util.types.isArrayBuffer(new SharedArrayBuffer());  // Returns false
 ```

-### util.types.isAsyncFunction(value)
+### `util.types.isAsyncFunction(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1280,7 +1280,7 @@ util.types.isAsyncFunction(function foo() {});  // Returns false
 util.types.isAsyncFunction(async function foo() {});  // Returns true
 ```

-### util.types.isBigInt64Array(value)
+### `util.types.isBigInt64Array(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1295,7 +1295,7 @@ util.types.isBigInt64Array(new BigInt64Array());   // Returns true
 util.types.isBigInt64Array(new BigUint64Array());  // Returns false
 ```

-### util.types.isBigUint64Array(value)
+### `util.types.isBigUint64Array(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1310,7 +1310,7 @@ util.types.isBigUint64Array(new BigInt64Array());   // Returns false
 util.types.isBigUint64Array(new BigUint64Array());  // Returns true
 ```

-### util.types.isBooleanObject(value)
+### `util.types.isBooleanObject(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1330,7 +1330,7 @@ util.types.isBooleanObject(Boolean(false)); // Returns false
 util.types.isBooleanObject(Boolean(true));  // Returns false
 ```

-### util.types.isBoxedPrimitive(value)
+### `util.types.isBoxedPrimitive(value)`
 <!-- YAML
 added: v10.11.0
 -->
@@ -1351,7 +1351,7 @@ util.types.isBoxedPrimitive(Object(Symbol('foo'))); // Returns true
 util.types.isBoxedPrimitive(Object(BigInt(5))); // Returns true
 ```

-### util.types.isDataView(value)
+### `util.types.isDataView(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1369,7 +1369,7 @@ util.types.isDataView(new Float64Array());  // Returns false

 See also [`ArrayBuffer.isView()`][].

-### util.types.isDate(value)
+### `util.types.isDate(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1383,7 +1383,7 @@ Returns `true` if the value is a built-in [`Date`][] instance.
 util.types.isDate(new Date());  // Returns true
 ```

-### util.types.isExternal(value)
+### `util.types.isExternal(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1393,7 +1393,7 @@ added: v10.0.0

 Returns `true` if the value is a native `External` value.

-### util.types.isFloat32Array(value)
+### `util.types.isFloat32Array(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1409,7 +1409,7 @@ util.types.isFloat32Array(new Float32Array());  // Returns true
 util.types.isFloat32Array(new Float64Array());  // Returns false
 ```

-### util.types.isFloat64Array(value)
+### `util.types.isFloat64Array(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1425,7 +1425,7 @@ util.types.isFloat64Array(new Uint8Array());  // Returns false
 util.types.isFloat64Array(new Float64Array());  // Returns true
 ```

-### util.types.isGeneratorFunction(value)
+### `util.types.isGeneratorFunction(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1443,7 +1443,7 @@ util.types.isGeneratorFunction(function foo() {});  // Returns false
 util.types.isGeneratorFunction(function* foo() {});  // Returns true
 ```

-### util.types.isGeneratorObject(value)
+### `util.types.isGeneratorObject(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1463,7 +1463,7 @@ const generator = foo();
 util.types.isGeneratorObject(generator);  // Returns true
 ```

-### util.types.isInt8Array(value)
+### `util.types.isInt8Array(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1479,7 +1479,7 @@ util.types.isInt8Array(new Int8Array());  // Returns true
 util.types.isInt8Array(new Float64Array());  // Returns false
 ```

-### util.types.isInt16Array(value)
+### `util.types.isInt16Array(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1495,7 +1495,7 @@ util.types.isInt16Array(new Int16Array());  // Returns true
 util.types.isInt16Array(new Float64Array());  // Returns false
 ```

-### util.types.isInt32Array(value)
+### `util.types.isInt32Array(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1511,7 +1511,7 @@ util.types.isInt32Array(new Int32Array());  // Returns true
 util.types.isInt32Array(new Float64Array());  // Returns false
 ```

-### util.types.isMap(value)
+### `util.types.isMap(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1525,7 +1525,7 @@ Returns `true` if the value is a built-in [`Map`][] instance.
 util.types.isMap(new Map());  // Returns true
 ```

-### util.types.isMapIterator(value)
+### `util.types.isMapIterator(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1544,7 +1544,7 @@ util.types.isMapIterator(map.entries());  // Returns true
 util.types.isMapIterator(map[Symbol.iterator]());  // Returns true
 ```

-### util.types.isModuleNamespaceObject(value)
+### `util.types.isModuleNamespaceObject(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1561,7 +1561,7 @@ import * as ns from './a.js';
 util.types.isModuleNamespaceObject(ns);  // Returns true
 ```

-### util.types.isNativeError(value)
+### `util.types.isNativeError(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1577,7 +1577,7 @@ util.types.isNativeError(new TypeError());  // Returns true
 util.types.isNativeError(new RangeError());  // Returns true
 ```

-### util.types.isNumberObject(value)
+### `util.types.isNumberObject(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1593,7 +1593,7 @@ util.types.isNumberObject(0);  // Returns false
 util.types.isNumberObject(new Number(0));   // Returns true
 ```

-### util.types.isPromise(value)
+### `util.types.isPromise(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1607,7 +1607,7 @@ Returns `true` if the value is a built-in [`Promise`][].
 util.types.isPromise(Promise.resolve(42));  // Returns true
 ```

-### util.types.isProxy(value)
+### `util.types.isProxy(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1624,7 +1624,7 @@ util.types.isProxy(target);  // Returns false
 util.types.isProxy(proxy);  // Returns true
 ```

-### util.types.isRegExp(value)
+### `util.types.isRegExp(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1639,7 +1639,7 @@ util.types.isRegExp(/abc/);  // Returns true
 util.types.isRegExp(new RegExp('abc'));  // Returns true
 ```

-### util.types.isSet(value)
+### `util.types.isSet(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1653,7 +1653,7 @@ Returns `true` if the value is a built-in [`Set`][] instance.
 util.types.isSet(new Set());  // Returns true
 ```

-### util.types.isSetIterator(value)
+### `util.types.isSetIterator(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1672,7 +1672,7 @@ util.types.isSetIterator(set.entries());  // Returns true
 util.types.isSetIterator(set[Symbol.iterator]());  // Returns true
 ```

-### util.types.isSharedArrayBuffer(value)
+### `util.types.isSharedArrayBuffer(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1689,7 +1689,7 @@ util.types.isSharedArrayBuffer(new ArrayBuffer());  // Returns false
 util.types.isSharedArrayBuffer(new SharedArrayBuffer());  // Returns true
 ```

-### util.types.isStringObject(value)
+### `util.types.isStringObject(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1705,7 +1705,7 @@ util.types.isStringObject('foo');  // Returns false
 util.types.isStringObject(new String('foo'));   // Returns true
 ```

-### util.types.isSymbolObject(value)
+### `util.types.isSymbolObject(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1722,7 +1722,7 @@ util.types.isSymbolObject(symbol);  // Returns false
 util.types.isSymbolObject(Object(symbol));   // Returns true
 ```

-### util.types.isTypedArray(value)
+### `util.types.isTypedArray(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1740,7 +1740,7 @@ util.types.isTypedArray(new Float64Array());  // Returns true

 See also [`ArrayBuffer.isView()`][].

-### util.types.isUint8Array(value)
+### `util.types.isUint8Array(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1756,7 +1756,7 @@ util.types.isUint8Array(new Uint8Array());  // Returns true
 util.types.isUint8Array(new Float64Array());  // Returns false
 ```

-### util.types.isUint8ClampedArray(value)
+### `util.types.isUint8ClampedArray(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1772,7 +1772,7 @@ util.types.isUint8ClampedArray(new Uint8ClampedArray());  // Returns true
 util.types.isUint8ClampedArray(new Float64Array());  // Returns false
 ```

-### util.types.isUint16Array(value)
+### `util.types.isUint16Array(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1788,7 +1788,7 @@ util.types.isUint16Array(new Uint16Array());  // Returns true
 util.types.isUint16Array(new Float64Array());  // Returns false
 ```

-### util.types.isUint32Array(value)
+### `util.types.isUint32Array(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1804,7 +1804,7 @@ util.types.isUint32Array(new Uint32Array());  // Returns true
 util.types.isUint32Array(new Float64Array());  // Returns false
 ```

-### util.types.isWeakMap(value)
+### `util.types.isWeakMap(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1818,7 +1818,7 @@ Returns `true` if the value is a built-in [`WeakMap`][] instance.
 util.types.isWeakMap(new WeakMap());  // Returns true
 ```

-### util.types.isWeakSet(value)
+### `util.types.isWeakSet(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1832,7 +1832,7 @@ Returns `true` if the value is a built-in [`WeakSet`][] instance.
 util.types.isWeakSet(new WeakSet());  // Returns true
 ```

-### util.types.isWebAssemblyCompiledModule(value)
+### `util.types.isWebAssemblyCompiledModule(value)`
 <!-- YAML
 added: v10.0.0
 -->
@@ -1852,7 +1852,7 @@ util.types.isWebAssemblyCompiledModule(module);  // Returns true
 The following APIs are deprecated and should no longer be used. Existing
 applications and modules should be updated to find alternative approaches.

-### util.\_extend(target, source)
+### `util._extend(target, source)`
 <!-- YAML
 added: v0.7.5
 deprecated: v6.0.0
@@ -1869,7 +1869,7 @@ Node.js modules. The community found and used it anyway.
 It is deprecated and should not be used in new code. JavaScript comes with very
 similar built-in functionality through [`Object.assign()`][].

-### util.isArray(object)
+### `util.isArray(object)`
 <!-- YAML
 added: v0.6.0
 deprecated: v4.0.0
@@ -1895,7 +1895,7 @@ util.isArray({});
 // Returns: false
 ```

-### util.isBoolean(object)
+### `util.isBoolean(object)`
 <!-- YAML
 added: v0.11.5
 deprecated: v4.0.0
@@ -1919,7 +1919,7 @@ util.isBoolean(false);
 // Returns: true
 ```

-### util.isBuffer(object)
+### `util.isBuffer(object)`
 <!-- YAML
 added: v0.11.5
 deprecated: v4.0.0
@@ -1943,7 +1943,7 @@ util.isBuffer(Buffer.from('hello world'));
 // Returns: true
 ```

-### util.isDate(object)
+### `util.isDate(object)`
 <!-- YAML
 added: v0.6.0
 deprecated: v4.0.0
@@ -1967,7 +1967,7 @@ util.isDate({});
 // Returns: false
 ```

-### util.isError(object)
+### `util.isError(object)`
 <!-- YAML
 added: v0.6.0
 deprecated: v4.0.0
@@ -2007,7 +2007,7 @@ util.isError(obj);
 // Returns: true
 ```

-### util.isFunction(object)
+### `util.isFunction(object)`
 <!-- YAML
 added: v0.11.5
 deprecated: v4.0.0
@@ -2035,7 +2035,7 @@ util.isFunction(Bar);
 // Returns: true
 ```

-### util.isNull(object)
+### `util.isNull(object)`
 <!-- YAML
 added: v0.11.5
 deprecated: v4.0.0
@@ -2060,7 +2060,7 @@ util.isNull(null);
 // Returns: true
 ```

-### util.isNullOrUndefined(object)
+### `util.isNullOrUndefined(object)`
 <!-- YAML
 added: v0.11.5
 deprecated: v4.0.0
@@ -2086,7 +2086,7 @@ util.isNullOrUndefined(null);
 // Returns: true
 ```

-### util.isNumber(object)
+### `util.isNumber(object)`
 <!-- YAML
 added: v0.11.5
 deprecated: v4.0.0
@@ -2112,7 +2112,7 @@ util.isNumber(NaN);
 // Returns: true
 ```

-### util.isObject(object)
+### `util.isObject(object)`
 <!-- YAML
 added: v0.11.5
 deprecated: v4.0.0
@@ -2141,7 +2141,7 @@ util.isObject(() => {});
 // Returns: false
 ```

-### util.isPrimitive(object)
+### `util.isPrimitive(object)`
 <!-- YAML
 added: v0.11.5
 deprecated: v4.0.0
@@ -2180,7 +2180,7 @@ util.isPrimitive(new Date());
 // Returns: false
 ```

-### util.isRegExp(object)
+### `util.isRegExp(object)`
 <!-- YAML
 added: v0.6.0
 deprecated: v4.0.0
@@ -2204,7 +2204,7 @@ util.isRegExp({});
 // Returns: false
 ```

-### util.isString(object)
+### `util.isString(object)`
 <!-- YAML
 added: v0.11.5
 deprecated: v4.0.0
@@ -2230,7 +2230,7 @@ util.isString(5);
 // Returns: false
 ```

-### util.isSymbol(object)
+### `util.isSymbol(object)`
 <!-- YAML
 added: v0.11.5
 deprecated: v4.0.0
@@ -2254,7 +2254,7 @@ util.isSymbol(Symbol('foo'));
 // Returns: true
 ```

-### util.isUndefined(object)
+### `util.isUndefined(object)`
 <!-- YAML
 added: v0.11.5
 deprecated: v4.0.0
@@ -2279,7 +2279,7 @@ util.isUndefined(null);
 // Returns: false
 ```

-### util.log(string)
+### `util.log(string)`
 <!-- YAML
 added: v0.3.0
 deprecated: v6.0.0