diff --git a/doc/api/util.md b/doc/api/util.md index ae435365b91d16..6a6eaf65e7ef50 100644 --- 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)` @@ -68,7 +68,7 @@ callbackFunction((err, ret) => { }); ``` -## util.debuglog(section) +## `util.debuglog(section)` @@ -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])` @@ -305,7 +305,7 @@ util.formatWithOptions({ colors: true }, 'See object %O', { foo: 42 }); // when printed to a terminal. ``` -## util.getSystemErrorName(err) +## `util.getSystemErrorName(err)` @@ -324,7 +324,7 @@ fs.access('file/that/does/not/exist', (err) => { }); ``` -## util.inherits(constructor, superConstructor) +## `util.inherits(constructor, superConstructor)` @@ -864,7 +864,7 @@ util.inspect.defaultOptions.maxArrayLength = null; console.log(arr); // logs the full array ``` -## util.isDeepStrictEqual(val1, val2) +## `util.isDeepStrictEqual(val1, val2)` @@ -879,7 +879,7 @@ Otherwise, returns `false`. See [`assert.deepStrictEqual()`][] for more information about deep strict equality. -## util.promisify(original) +## `util.promisify(original)` @@ -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` @@ -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` @@ -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]])` @@ -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)` @@ -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)` @@ -1245,7 +1245,7 @@ function foo() { } ``` -### util.types.isArrayBuffer(value) +### `util.types.isArrayBuffer(value)` @@ -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)` @@ -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)` @@ -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)` @@ -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)` @@ -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)` @@ -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)` @@ -1369,7 +1369,7 @@ util.types.isDataView(new Float64Array()); // Returns false See also [`ArrayBuffer.isView()`][]. -### util.types.isDate(value) +### `util.types.isDate(value)` @@ -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)` @@ -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)` @@ -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)` @@ -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)` @@ -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)` @@ -1463,7 +1463,7 @@ const generator = foo(); util.types.isGeneratorObject(generator); // Returns true ``` -### util.types.isInt8Array(value) +### `util.types.isInt8Array(value)` @@ -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)` @@ -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)` @@ -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)` @@ -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)` @@ -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)` @@ -1561,7 +1561,7 @@ import * as ns from './a.js'; util.types.isModuleNamespaceObject(ns); // Returns true ``` -### util.types.isNativeError(value) +### `util.types.isNativeError(value)` @@ -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)` @@ -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)` @@ -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)` @@ -1624,7 +1624,7 @@ util.types.isProxy(target); // Returns false util.types.isProxy(proxy); // Returns true ``` -### util.types.isRegExp(value) +### `util.types.isRegExp(value)` @@ -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)` @@ -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)` @@ -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)` @@ -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)` @@ -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)` @@ -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)` @@ -1740,7 +1740,7 @@ util.types.isTypedArray(new Float64Array()); // Returns true See also [`ArrayBuffer.isView()`][]. -### util.types.isUint8Array(value) +### `util.types.isUint8Array(value)` @@ -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)` @@ -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)` @@ -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)` @@ -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)` @@ -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)` @@ -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)` @@ -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)`