{
  "type": "module",
  "source": "doc/api/util.md",
  "modules": [
    {
      "textRaw": "Util",
      "name": "util",
      "introduced_in": "v0.10.0",
      "type": "module",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "<p>The <code>node:util</code> module supports the needs of Node.js internal APIs. Many of the\nutilities are useful for application and module developers as well. To access\nit:</p>\n<pre><code class=\"language-mjs\">import util from 'node:util';\n</code></pre>\n<pre><code class=\"language-cjs\">const util = require('node:util');\n</code></pre>",
      "methods": [
        {
          "textRaw": "`util.callbackify(original)`",
          "name": "callbackify",
          "type": "method",
          "meta": {
            "added": [
              "v8.2.0"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`original` {Function} An `async` function",
                  "name": "original",
                  "type": "Function",
                  "desc": "An `async` function"
                }
              ],
              "return": {
                "textRaw": "Returns: {Function} a callback style function",
                "name": "return",
                "type": "Function",
                "desc": "a callback style function"
              }
            }
          ],
          "desc": "<p>Takes an <code>async</code> function (or a function that returns a <code>Promise</code>) and returns a\nfunction following the error-first callback style, i.e. taking\nan <code>(err, value) => ...</code> callback as the last argument. In the callback, the\nfirst argument will be the rejection reason (or <code>null</code> if the <code>Promise</code>\nresolved), and the second argument will be the resolved value.</p>\n<pre><code class=\"language-mjs\">import { callbackify } from 'node:util';\n\nasync function fn() {\n  return 'hello world';\n}\nconst callbackFunction = callbackify(fn);\n\ncallbackFunction((err, ret) => {\n  if (err) throw err;\n  console.log(ret);\n});\n</code></pre>\n<pre><code class=\"language-cjs\">const { callbackify } = require('node:util');\n\nasync function fn() {\n  return 'hello world';\n}\nconst callbackFunction = callbackify(fn);\n\ncallbackFunction((err, ret) => {\n  if (err) throw err;\n  console.log(ret);\n});\n</code></pre>\n<p>Will print:</p>\n<pre><code class=\"language-text\">hello world\n</code></pre>\n<p>The callback is executed asynchronously, and will have a limited stack trace.\nIf the callback throws, the process will emit an <a href=\"process.html#event-uncaughtexception\"><code>'uncaughtException'</code></a>\nevent, and if not handled will exit.</p>\n<p>Since <code>null</code> has a special meaning as the first argument to a callback, if a\nwrapped function rejects a <code>Promise</code> with a falsy value as a reason, the value\nis wrapped in an <code>Error</code> with the original value stored in a field named\n<code>reason</code>.</p>\n<pre><code class=\"language-mjs\">import util from 'node:util';\n\nfunction fn() {\n  return Promise.reject(null);\n}\nconst callbackFunction = util.callbackify(fn);\n\ncallbackFunction((err, ret) => {\n  // When the Promise was rejected with `null` it is wrapped with an Error and\n  // the original value is stored in `reason`.\n  err &#x26;&#x26; Object.hasOwn(err, 'reason') &#x26;&#x26; err.reason === null;  // true\n});\n</code></pre>\n<pre><code class=\"language-cjs\">const util = require('node:util');\n\nfunction fn() {\n  return Promise.reject(null);\n}\nconst callbackFunction = util.callbackify(fn);\n\ncallbackFunction((err, ret) => {\n  // When the Promise was rejected with `null` it is wrapped with an Error and\n  // the original value is stored in `reason`.\n  err &#x26;&#x26; Object.hasOwn(err, 'reason') &#x26;&#x26; err.reason === null;  // true\n});\n</code></pre>"
        },
        {
          "textRaw": "`util.convertProcessSignalToExitCode(signal)`",
          "name": "convertProcessSignalToExitCode",
          "type": "method",
          "meta": {
            "added": [
              "v25.4.0",
              "v24.14.0"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`signal` {string} A signal name (e.g. `'SIGTERM'`)",
                  "name": "signal",
                  "type": "string",
                  "desc": "A signal name (e.g. `'SIGTERM'`)"
                }
              ],
              "return": {
                "textRaw": "Returns: {number} The exit code corresponding to `signal`",
                "name": "return",
                "type": "number",
                "desc": "The exit code corresponding to `signal`"
              }
            }
          ],
          "desc": "<p>The <code>util.convertProcessSignalToExitCode()</code> method converts a signal name to its\ncorresponding POSIX exit code. Following the POSIX standard, the exit code\nfor a process terminated by a signal is calculated as <code>128 + signal number</code>.</p>\n<p>If <code>signal</code> is not a valid signal name, then an error will be thrown. See\n<a href=\"https://man7.org/linux/man-pages/man7/signal.7.html\"><code>signal(7)</code></a> for a list of valid signals.</p>\n<pre><code class=\"language-mjs\">import { convertProcessSignalToExitCode } from 'node:util';\n\nconsole.log(convertProcessSignalToExitCode('SIGTERM')); // 143 (128 + 15)\nconsole.log(convertProcessSignalToExitCode('SIGKILL')); // 137 (128 + 9)\n</code></pre>\n<pre><code class=\"language-cjs\">const { convertProcessSignalToExitCode } = require('node:util');\n\nconsole.log(convertProcessSignalToExitCode('SIGTERM')); // 143 (128 + 15)\nconsole.log(convertProcessSignalToExitCode('SIGKILL')); // 137 (128 + 9)\n</code></pre>\n<p>This is particularly useful when working with processes to determine\nthe exit code based on the signal that terminated the process.</p>"
        },
        {
          "textRaw": "`util.debuglog(section[, callback])`",
          "name": "debuglog",
          "type": "method",
          "meta": {
            "added": [
              "v0.11.3"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`section` {string} A string identifying the portion of the application for which the `debuglog` function is being created.",
                  "name": "section",
                  "type": "string",
                  "desc": "A string identifying the portion of the application for which the `debuglog` function is being created."
                },
                {
                  "textRaw": "`callback` {Function} A callback invoked the first time the logging function is called with a function argument that is a more optimized logging function.",
                  "name": "callback",
                  "type": "Function",
                  "desc": "A callback invoked the first time the logging function is called with a function argument that is a more optimized logging function.",
                  "optional": true
                }
              ],
              "return": {
                "textRaw": "Returns: {Function} The logging function",
                "name": "return",
                "type": "Function",
                "desc": "The logging function"
              }
            }
          ],
          "desc": "<p>The <code>util.debuglog()</code> method is used to create a function that conditionally\nwrites debug messages to <code>stderr</code> based on the existence of the <code>NODE_DEBUG</code>\nenvironment variable. If the <code>section</code> name appears within the value of that\nenvironment variable, then the returned function operates similar to\n<a href=\"console.html#consoleerrordata-args\"><code>console.error()</code></a>. If not, then the returned function is a no-op.</p>\n<pre><code class=\"language-mjs\">import { debuglog } from 'node:util';\nconst log = debuglog('foo');\n\nlog('hello from foo [%d]', 123);\n</code></pre>\n<pre><code class=\"language-cjs\">const { debuglog } = require('node:util');\nconst log = debuglog('foo');\n\nlog('hello from foo [%d]', 123);\n</code></pre>\n<p>If this program is run with <code>NODE_DEBUG=foo</code> in the environment, then\nit will output something like:</p>\n<pre><code class=\"language-console\">FOO 3245: hello from foo [123]\n</code></pre>\n<p>where <code>3245</code> is the process id. If it is not run with that\nenvironment variable set, then it will not print anything.</p>\n<p>The <code>section</code> supports wildcard also:</p>\n<pre><code class=\"language-mjs\">import { debuglog } from 'node:util';\nconst log = debuglog('foo-bar');\n\nlog('hi there, it\\'s foo-bar [%d]', 2333);\n</code></pre>\n<pre><code class=\"language-cjs\">const { debuglog } = require('node:util');\nconst log = debuglog('foo-bar');\n\nlog('hi there, it\\'s foo-bar [%d]', 2333);\n</code></pre>\n<p>if it is run with <code>NODE_DEBUG=foo*</code> in the environment, then it will output\nsomething like:</p>\n<pre><code class=\"language-console\">FOO-BAR 3257: hi there, it's foo-bar [2333]\n</code></pre>\n<p>Multiple comma-separated <code>section</code> names may be specified in the <code>NODE_DEBUG</code>\nenvironment variable: <code>NODE_DEBUG=fs,net,tls</code>.</p>\n<p>The optional <code>callback</code> argument can be used to replace the logging function\nwith a different function that doesn't have any initialization or\nunnecessary wrapping.</p>\n<pre><code class=\"language-mjs\">import { debuglog } from 'node:util';\nlet log = debuglog('internals', (debug) => {\n  // Replace with a logging function that optimizes out\n  // testing if the section is enabled\n  log = debug;\n});\n</code></pre>\n<pre><code class=\"language-cjs\">const { debuglog } = require('node:util');\nlet log = debuglog('internals', (debug) => {\n  // Replace with a logging function that optimizes out\n  // testing if the section is enabled\n  log = debug;\n});\n</code></pre>",
          "modules": [
            {
              "textRaw": "`debuglog().enabled`",
              "name": "`debuglog().enabled`",
              "type": "module",
              "meta": {
                "added": [
                  "v14.9.0"
                ],
                "changes": []
              },
              "desc": "<ul>\n<li>Type: <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#boolean_type\"><code>&#x3C;boolean></code></a></li>\n</ul>\n<p>The <code>util.debuglog().enabled</code> getter is used to create a test that can be used\nin conditionals based on the existence of the <code>NODE_DEBUG</code> environment variable.\nIf the <code>section</code> name appears within the value of that environment variable,\nthen the returned value will be <code>true</code>. If not, then the returned value will be\n<code>false</code>.</p>\n<pre><code class=\"language-mjs\">import { debuglog } from 'node:util';\nconst enabled = debuglog('foo').enabled;\nif (enabled) {\n  console.log('hello from foo [%d]', 123);\n}\n</code></pre>\n<pre><code class=\"language-cjs\">const { debuglog } = require('node:util');\nconst enabled = debuglog('foo').enabled;\nif (enabled) {\n  console.log('hello from foo [%d]', 123);\n}\n</code></pre>\n<p>If this program is run with <code>NODE_DEBUG=foo</code> in the environment, then it will\noutput something like:</p>\n<pre><code class=\"language-console\">hello from foo [123]\n</code></pre>",
              "displayName": "`debuglog().enabled`"
            }
          ]
        },
        {
          "textRaw": "`util.debug(section)`",
          "name": "debug",
          "type": "method",
          "meta": {
            "added": [
              "v14.9.0"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "name": "section"
                }
              ]
            }
          ],
          "desc": "<p>Alias for <code>util.debuglog</code>. Usage allows for readability of that doesn't imply\nlogging when only using <code>util.debuglog().enabled</code>.</p>"
        },
        {
          "textRaw": "`util.deprecate(fn, msg[, code[, options]])`",
          "name": "deprecate",
          "type": "method",
          "meta": {
            "added": [
              "v0.8.0"
            ],
            "changes": [
              {
                "version": [
                  "v25.2.0",
                  "v24.12.0"
                ],
                "pr-url": "https://github.com/nodejs/node/pull/59982",
                "description": "Add options object with modifyPrototype to conditionally modify the prototype of the deprecated object."
              },
              {
                "version": "v10.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/16393",
                "description": "Deprecation warnings are only emitted once for each code."
              }
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`fn` {Function} The function that is being deprecated.",
                  "name": "fn",
                  "type": "Function",
                  "desc": "The function that is being deprecated."
                },
                {
                  "textRaw": "`msg` {string} A warning message to display when the deprecated function is invoked.",
                  "name": "msg",
                  "type": "string",
                  "desc": "A warning message to display when the deprecated function is invoked."
                },
                {
                  "textRaw": "`code` {string} A deprecation code. See the list of deprecated APIs for a list of codes.",
                  "name": "code",
                  "type": "string",
                  "desc": "A deprecation code. See the list of deprecated APIs for a list of codes.",
                  "optional": true
                },
                {
                  "textRaw": "`options` {Object}",
                  "name": "options",
                  "type": "Object",
                  "options": [
                    {
                      "textRaw": "`modifyPrototype` {boolean} When false do not change the prototype of object while emitting the deprecation warning. **Default:** `true`.",
                      "name": "modifyPrototype",
                      "type": "boolean",
                      "default": "`true`",
                      "desc": "When false do not change the prototype of object while emitting the deprecation warning."
                    }
                  ],
                  "optional": true
                }
              ],
              "return": {
                "textRaw": "Returns: {Function} The deprecated function wrapped to emit a warning.",
                "name": "return",
                "type": "Function",
                "desc": "The deprecated function wrapped to emit a warning."
              }
            }
          ],
          "desc": "<p>The <code>util.deprecate()</code> method wraps <code>fn</code> (which may be a function or class) in\nsuch a way that it is marked as deprecated.</p>\n<pre><code class=\"language-mjs\">import { deprecate } from 'node:util';\n\nexport const obsoleteFunction = deprecate(() => {\n  // Do something here.\n}, 'obsoleteFunction() is deprecated. Use newShinyFunction() instead.');\n</code></pre>\n<pre><code class=\"language-cjs\">const { deprecate } = require('node:util');\n\nexports.obsoleteFunction = deprecate(() => {\n  // Do something here.\n}, 'obsoleteFunction() is deprecated. Use newShinyFunction() instead.');\n</code></pre>\n<p>When called, <code>util.deprecate()</code> will return a function that will emit a\n<code>DeprecationWarning</code> using the <a href=\"process.html#event-warning\"><code>'warning'</code></a> event. The warning will\nbe emitted and printed to <code>stderr</code> the first time the returned function is\ncalled. After the warning is emitted, the wrapped function is called without\nemitting a warning.</p>\n<p>If the same optional <code>code</code> is supplied in multiple calls to <code>util.deprecate()</code>,\nthe warning will be emitted only once for that <code>code</code>.</p>\n<pre><code class=\"language-mjs\">import { deprecate } from 'node:util';\n\nconst fn1 = deprecate(\n  () => 'a value',\n  'deprecation message',\n  'DEP0001',\n);\nconst fn2 = deprecate(\n  () => 'a  different value',\n  'other dep message',\n  'DEP0001',\n);\nfn1(); // Emits a deprecation warning with code DEP0001\nfn2(); // Does not emit a deprecation warning because it has the same code\n</code></pre>\n<pre><code class=\"language-cjs\">const { deprecate } = require('node:util');\n\nconst fn1 = deprecate(\n  function() {\n    return 'a value';\n  },\n  'deprecation message',\n  'DEP0001',\n);\nconst fn2 = deprecate(\n  function() {\n    return 'a  different value';\n  },\n  'other dep message',\n  'DEP0001',\n);\nfn1(); // Emits a deprecation warning with code DEP0001\nfn2(); // Does not emit a deprecation warning because it has the same code\n</code></pre>\n<p>If either the <code>--no-deprecation</code> or <code>--no-warnings</code> command-line flags are\nused, or if the <code>process.noDeprecation</code> property is set to <code>true</code> <em>prior</em> to\nthe first deprecation warning, the <code>util.deprecate()</code> method does nothing.</p>\n<p>If the <code>--trace-deprecation</code> or <code>--trace-warnings</code> command-line flags are set,\nor the <code>process.traceDeprecation</code> property is set to <code>true</code>, a warning and a\nstack trace are printed to <code>stderr</code> the first time the deprecated function is\ncalled.</p>\n<p>If the <code>--throw-deprecation</code> command-line flag is set, or the\n<code>process.throwDeprecation</code> property is set to <code>true</code>, then an exception will be\nthrown when the deprecated function is called.</p>\n<p>The <code>--throw-deprecation</code> command-line flag and <code>process.throwDeprecation</code>\nproperty take precedence over <code>--trace-deprecation</code> and\n<code>process.traceDeprecation</code>.</p>"
        },
        {
          "textRaw": "`util.diff(actual, expected)`",
          "name": "diff",
          "type": "method",
          "meta": {
            "added": [
              "v23.11.0",
              "v22.15.0"
            ],
            "changes": []
          },
          "stability": 1,
          "stabilityText": "Experimental",
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`actual` {Array|string} The first value to compare",
                  "name": "actual",
                  "type": "Array|string",
                  "desc": "The first value to compare"
                },
                {
                  "textRaw": "`expected` {Array|string} The second value to compare",
                  "name": "expected",
                  "type": "Array|string",
                  "desc": "The second value to compare"
                }
              ],
              "return": {
                "textRaw": "Returns: {Array} An array of difference entries. Each entry is an array with two elements:",
                "name": "return",
                "type": "Array",
                "desc": "An array of difference entries. Each entry is an array with two elements:",
                "options": [
                  {
                    "textRaw": "`0` {number} Operation code: `-1` for delete, `0` for no-op/unchanged, `1` for insert",
                    "name": "0",
                    "type": "number",
                    "desc": "Operation code: `-1` for delete, `0` for no-op/unchanged, `1` for insert"
                  },
                  {
                    "textRaw": "`1` {string} The value associated with the operation",
                    "name": "1",
                    "type": "string",
                    "desc": "The value associated with the operation"
                  }
                ]
              }
            }
          ],
          "desc": "<p><a href=\"#utildiffactual-expected\"><code>util.diff()</code></a> compares two string or array values and returns an array of difference entries.\nIt uses the Myers diff algorithm to compute minimal differences, which is the same algorithm\nused internally by assertion error messages.</p>\n<p>If the values are equal, an empty array is returned.</p>\n<pre><code class=\"language-js\">const { diff } = require('node:util');\n\n// Comparing strings\nconst actualString = '12345678';\nconst expectedString = '12!!5!7!';\nconsole.log(diff(actualString, expectedString));\n// [\n//   [0, '1'],\n//   [0, '2'],\n//   [1, '3'],\n//   [1, '4'],\n//   [-1, '!'],\n//   [-1, '!'],\n//   [0, '5'],\n//   [1, '6'],\n//   [-1, '!'],\n//   [0, '7'],\n//   [1, '8'],\n//   [-1, '!'],\n// ]\n// Comparing arrays\nconst actualArray = ['1', '2', '3'];\nconst expectedArray = ['1', '3', '4'];\nconsole.log(diff(actualArray, expectedArray));\n// [\n//   [0, '1'],\n//   [1, '2'],\n//   [0, '3'],\n//   [-1, '4'],\n// ]\n// Equal values return empty array\nconsole.log(diff('same', 'same'));\n// []\n</code></pre>"
        },
        {
          "textRaw": "`util.format(format[, ...args])`",
          "name": "format",
          "type": "method",
          "meta": {
            "added": [
              "v0.5.3"
            ],
            "changes": [
              {
                "version": "v12.11.0",
                "pr-url": "https://github.com/nodejs/node/pull/29606",
                "description": "The `%c` specifier is ignored now."
              },
              {
                "version": "v12.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/23162",
                "description": "The `format` argument is now only taken as such if it actually contains format specifiers."
              },
              {
                "version": "v12.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/23162",
                "description": "If the `format` argument is not a format string, the output string's formatting is no longer dependent on the type of the first argument. This change removes previously present quotes from strings that were being output when the first argument was not a string."
              },
              {
                "version": "v11.4.0",
                "pr-url": "https://github.com/nodejs/node/pull/23708",
                "description": "The `%d`, `%f`, and `%i` specifiers now support Symbols properly."
              },
              {
                "version": "v11.4.0",
                "pr-url": "https://github.com/nodejs/node/pull/24806",
                "description": "The `%o` specifier's `depth` has default depth of 4 again."
              },
              {
                "version": "v11.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/17907",
                "description": "The `%o` specifier's `depth` option will now fall back to the default depth."
              },
              {
                "version": "v10.12.0",
                "pr-url": "https://github.com/nodejs/node/pull/22097",
                "description": "The `%d` and `%i` specifiers now support BigInt."
              },
              {
                "version": "v8.4.0",
                "pr-url": "https://github.com/nodejs/node/pull/14558",
                "description": "The `%o` and `%O` specifiers are supported now."
              }
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`format` {string} A `printf`-like format string.",
                  "name": "format",
                  "type": "string",
                  "desc": "A `printf`-like format string."
                },
                {
                  "name": "...args",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>The <code>util.format()</code> method returns a formatted string using the first argument\nas a <code>printf</code>-like format string which can contain zero or more format\nspecifiers. Each specifier is replaced with the converted value from the\ncorresponding argument. Supported specifiers are:</p>\n<ul>\n<li><code>%s</code>: <code>String</code> will be used to convert all values except <code>BigInt</code>, <code>Object</code>\nand <code>-0</code>. <code>BigInt</code> values will be represented with an <code>n</code> and Objects that\nhave neither a user defined <code>toString</code> function nor <code>Symbol.toPrimitive</code> function are inspected using <code>util.inspect()</code>\nwith options <code>{ depth: 0, colors: false, compact: 3 }</code>.</li>\n<li><code>%d</code>: <code>Number</code> will be used to convert all values except <code>BigInt</code> and\n<code>Symbol</code>.</li>\n<li><code>%i</code>: <code>parseInt(value, 10)</code> is used for all values except <code>BigInt</code> and\n<code>Symbol</code>.</li>\n<li><code>%f</code>: <code>parseFloat(value)</code> is used for all values except <code>Symbol</code>.</li>\n<li><code>%j</code>: JSON. Replaced with the string <code>'[Circular]'</code> if the argument contains\ncircular references.</li>\n<li><code>%o</code>: <code>Object</code>. A string representation of an object with generic JavaScript\nobject formatting. Similar to <code>util.inspect()</code> with options\n<code>{ showHidden: true, showProxy: true }</code>. This will show the full object\nincluding non-enumerable properties and proxies.</li>\n<li><code>%O</code>: <code>Object</code>. A string representation of an object with generic JavaScript\nobject formatting. Similar to <code>util.inspect()</code> without options. This will show\nthe full object not including non-enumerable properties and proxies.</li>\n<li><code>%c</code>: <code>CSS</code>. This specifier is ignored and will skip any CSS passed in.</li>\n<li><code>%%</code>: single percent sign (<code>'%'</code>). This does not consume an argument.</li>\n<li>Returns: <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#string_type\"><code>&#x3C;string></code></a> The formatted string</li>\n</ul>\n<p>If a specifier does not have a corresponding argument, it is not replaced:</p>\n<pre><code class=\"language-js\">util.format('%s:%s', 'foo');\n// Returns: 'foo:%s'\n</code></pre>\n<p>Values that are not part of the format string are formatted using\n<code>util.inspect()</code> if their type is not <code>string</code>.</p>\n<p>If there are more arguments passed to the <code>util.format()</code> method than the\nnumber of specifiers, the extra arguments are concatenated to the returned\nstring, separated by spaces:</p>\n<pre><code class=\"language-js\">util.format('%s:%s', 'foo', 'bar', 'baz');\n// Returns: 'foo:bar baz'\n</code></pre>\n<p>If the first argument does not contain a valid format specifier, <code>util.format()</code>\nreturns a string that is the concatenation of all arguments separated by spaces:</p>\n<pre><code class=\"language-js\">util.format(1, 2, 3);\n// Returns: '1 2 3'\n</code></pre>\n<p>If only one argument is passed to <code>util.format()</code>, it is returned as it is\nwithout any formatting:</p>\n<pre><code class=\"language-js\">util.format('%% %s');\n// Returns: '%% %s'\n</code></pre>\n<p><code>util.format()</code> is a synchronous method that is intended as a debugging tool.\nSome input values can have a significant performance overhead that can block the\nevent loop. Use this function with care and never in a hot code path.</p>"
        },
        {
          "textRaw": "`util.formatWithOptions(inspectOptions, format[, ...args])`",
          "name": "formatWithOptions",
          "type": "method",
          "meta": {
            "added": [
              "v10.0.0"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`inspectOptions` {Object}",
                  "name": "inspectOptions",
                  "type": "Object"
                },
                {
                  "textRaw": "`format` {string}",
                  "name": "format",
                  "type": "string"
                },
                {
                  "name": "...args",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>This function is identical to <a href=\"#utilformatformat-args\"><code>util.format()</code></a>, except in that it takes\nan <code>inspectOptions</code> argument which specifies options that are passed along to\n<a href=\"#utilinspectobject-options\"><code>util.inspect()</code></a>.</p>\n<pre><code class=\"language-js\">util.formatWithOptions({ colors: true }, 'See object %O', { foo: 42 });\n// Returns 'See object { foo: 42 }', where `42` is colored as a number\n// when printed to a terminal.\n</code></pre>"
        },
        {
          "textRaw": "`util.getCallSites([frameCount][, options])`",
          "name": "getCallSites",
          "type": "method",
          "meta": {
            "added": [
              "v22.9.0"
            ],
            "changes": [
              {
                "version": [
                  "v23.7.0",
                  "v22.14.0"
                ],
                "pr-url": "https://github.com/nodejs/node/pull/56584",
                "description": "Property `column` is deprecated in favor of `columnNumber`."
              },
              {
                "version": [
                  "v23.7.0",
                  "v22.14.0"
                ],
                "pr-url": "https://github.com/nodejs/node/pull/56551",
                "description": "Property `CallSite.scriptId` is exposed."
              },
              {
                "version": [
                  "v23.3.0",
                  "v22.12.0"
                ],
                "pr-url": "https://github.com/nodejs/node/pull/55626",
                "description": "The API is renamed from `util.getCallSite` to `util.getCallSites()`."
              }
            ]
          },
          "stability": 1.1,
          "stabilityText": "Active development",
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`frameCount` {integer} Optional number of frames to capture as call site objects. **Default:** `10`. Allowable range is between 1 and 200.",
                  "name": "frameCount",
                  "type": "integer",
                  "default": "`10`. Allowable range is between 1 and 200",
                  "desc": "Optional number of frames to capture as call site objects.",
                  "optional": true
                },
                {
                  "textRaw": "`options` {Object} Optional",
                  "name": "options",
                  "type": "Object",
                  "desc": "Optional",
                  "options": [
                    {
                      "textRaw": "`sourceMap` {boolean} Reconstruct the original location in the stacktrace from the source-map. Enabled by default with the flag `--enable-source-maps`.",
                      "name": "sourceMap",
                      "type": "boolean",
                      "desc": "Reconstruct the original location in the stacktrace from the source-map. Enabled by default with the flag `--enable-source-maps`."
                    }
                  ],
                  "optional": true
                }
              ],
              "return": {
                "textRaw": "Returns: {Object}[] An array of call site objects",
                "name": "return",
                "type": "Object",
                "desc": "[] An array of call site objects",
                "options": [
                  {
                    "textRaw": "`functionName` {string} Returns the name of the function associated with this call site.",
                    "name": "functionName",
                    "type": "string",
                    "desc": "Returns the name of the function associated with this call site."
                  },
                  {
                    "textRaw": "`scriptName` {string} Returns the name of the resource that contains the script for the function for this call site.",
                    "name": "scriptName",
                    "type": "string",
                    "desc": "Returns the name of the resource that contains the script for the function for this call site."
                  },
                  {
                    "textRaw": "`scriptId` {string} Returns the unique id of the script, as in Chrome DevTools protocol `Runtime.ScriptId`.",
                    "name": "scriptId",
                    "type": "string",
                    "desc": "Returns the unique id of the script, as in Chrome DevTools protocol `Runtime.ScriptId`."
                  },
                  {
                    "textRaw": "`lineNumber` {number} Returns the JavaScript script line number (1-based).",
                    "name": "lineNumber",
                    "type": "number",
                    "desc": "Returns the JavaScript script line number (1-based)."
                  },
                  {
                    "textRaw": "`columnNumber` {number} Returns the JavaScript script column number (1-based).",
                    "name": "columnNumber",
                    "type": "number",
                    "desc": "Returns the JavaScript script column number (1-based)."
                  }
                ]
              }
            }
          ],
          "desc": "<p>Returns an array of call site objects containing the stack of\nthe caller function.</p>\n<p>Unlike accessing an <code>error.stack</code>, the result returned from this API is not\ninterfered with <code>Error.prepareStackTrace</code>.</p>\n<pre><code class=\"language-mjs\">import { getCallSites } from 'node:util';\n\nfunction exampleFunction() {\n  const callSites = getCallSites();\n\n  console.log('Call Sites:');\n  callSites.forEach((callSite, index) => {\n    console.log(`CallSite ${index + 1}:`);\n    console.log(`Function Name: ${callSite.functionName}`);\n    console.log(`Script Name: ${callSite.scriptName}`);\n    console.log(`Line Number: ${callSite.lineNumber}`);\n    console.log(`Column Number: ${callSite.columnNumber}`);\n  });\n  // CallSite 1:\n  // Function Name: exampleFunction\n  // Script Name: /home/example.js\n  // Line Number: 5\n  // Column Number: 26\n\n  // CallSite 2:\n  // Function Name: anotherFunction\n  // Script Name: /home/example.js\n  // Line Number: 22\n  // Column Number: 3\n\n  // ...\n}\n\n// A function to simulate another stack layer\nfunction anotherFunction() {\n  exampleFunction();\n}\n\nanotherFunction();\n</code></pre>\n<pre><code class=\"language-cjs\">const { getCallSites } = require('node:util');\n\nfunction exampleFunction() {\n  const callSites = getCallSites();\n\n  console.log('Call Sites:');\n  callSites.forEach((callSite, index) => {\n    console.log(`CallSite ${index + 1}:`);\n    console.log(`Function Name: ${callSite.functionName}`);\n    console.log(`Script Name: ${callSite.scriptName}`);\n    console.log(`Line Number: ${callSite.lineNumber}`);\n    console.log(`Column Number: ${callSite.columnNumber}`);\n  });\n  // CallSite 1:\n  // Function Name: exampleFunction\n  // Script Name: /home/example.js\n  // Line Number: 5\n  // Column Number: 26\n\n  // CallSite 2:\n  // Function Name: anotherFunction\n  // Script Name: /home/example.js\n  // Line Number: 22\n  // Column Number: 3\n\n  // ...\n}\n\n// A function to simulate another stack layer\nfunction anotherFunction() {\n  exampleFunction();\n}\n\nanotherFunction();\n</code></pre>\n<p>It is possible to reconstruct the original locations by setting the option <code>sourceMap</code> to <code>true</code>.\nIf the source map is not available, the original location will be the same as the current location.\nWhen the <code>--enable-source-maps</code> flag is enabled,<code>sourceMap</code> will be true by default.</p>\n<pre><code class=\"language-ts\">import { getCallSites } from 'node:util';\n\ninterface Foo {\n  foo: string;\n}\n\nconst callSites = getCallSites({ sourceMap: true });\n\n// With sourceMap:\n// Function Name: ''\n// Script Name: example.js\n// Line Number: 7\n// Column Number: 26\n\n// Without sourceMap:\n// Function Name: ''\n// Script Name: example.js\n// Line Number: 2\n// Column Number: 26\n</code></pre>\n<pre><code class=\"language-cjs\">const { getCallSites } = require('node:util');\n\nconst callSites = getCallSites({ sourceMap: true });\n\n// With sourceMap:\n// Function Name: ''\n// Script Name: example.js\n// Line Number: 7\n// Column Number: 26\n\n// Without sourceMap:\n// Function Name: ''\n// Script Name: example.js\n// Line Number: 2\n// Column Number: 26\n</code></pre>"
        },
        {
          "textRaw": "`util.getSystemErrorName(err)`",
          "name": "getSystemErrorName",
          "type": "method",
          "meta": {
            "added": [
              "v9.7.0"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`err` {number}",
                  "name": "err",
                  "type": "number"
                }
              ],
              "return": {
                "textRaw": "Returns: {string}",
                "name": "return",
                "type": "string"
              }
            }
          ],
          "desc": "<p>Returns the string name for a numeric error code that comes from a Node.js API.\nThe mapping between error codes and error names is platform-dependent.\nSee <a href=\"errors.html#common-system-errors\">Common System Errors</a> for the names of common errors.</p>\n<pre><code class=\"language-js\">fs.access('file/that/does/not/exist', (err) => {\n  const name = util.getSystemErrorName(err.errno);\n  console.error(name);  // ENOENT\n});\n</code></pre>"
        },
        {
          "textRaw": "`util.getSystemErrorMap()`",
          "name": "getSystemErrorMap",
          "type": "method",
          "meta": {
            "added": [
              "v16.0.0",
              "v14.17.0"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [],
              "return": {
                "textRaw": "Returns: {Map}",
                "name": "return",
                "type": "Map"
              }
            }
          ],
          "desc": "<p>Returns a Map of all system error codes available from the Node.js API.\nThe mapping between error codes and error names is platform-dependent.\nSee <a href=\"errors.html#common-system-errors\">Common System Errors</a> for the names of common errors.</p>\n<pre><code class=\"language-js\">fs.access('file/that/does/not/exist', (err) => {\n  const errorMap = util.getSystemErrorMap();\n  const name = errorMap.get(err.errno);\n  console.error(name);  // ENOENT\n});\n</code></pre>"
        },
        {
          "textRaw": "`util.getSystemErrorMessage(err)`",
          "name": "getSystemErrorMessage",
          "type": "method",
          "meta": {
            "added": [
              "v23.1.0",
              "v22.12.0"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`err` {number}",
                  "name": "err",
                  "type": "number"
                }
              ],
              "return": {
                "textRaw": "Returns: {string}",
                "name": "return",
                "type": "string"
              }
            }
          ],
          "desc": "<p>Returns the string message for a numeric error code that comes from a Node.js\nAPI.\nThe mapping between error codes and string messages is platform-dependent.</p>\n<pre><code class=\"language-js\">fs.access('file/that/does/not/exist', (err) => {\n  const message = util.getSystemErrorMessage(err.errno);\n  console.error(message);  // No such file or directory\n});\n</code></pre>"
        },
        {
          "textRaw": "`util.setTraceSigInt(enable)`",
          "name": "setTraceSigInt",
          "type": "method",
          "meta": {
            "added": [
              "v24.6.0",
              "v22.19.0"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`enable` {boolean}",
                  "name": "enable",
                  "type": "boolean"
                }
              ]
            }
          ],
          "desc": "<p>Enable or disable printing a stack trace on <code>SIGINT</code>. The API is only available on the main thread.</p>"
        },
        {
          "textRaw": "`util.inherits(constructor, superConstructor)`",
          "name": "inherits",
          "type": "method",
          "meta": {
            "added": [
              "v0.3.0"
            ],
            "changes": [
              {
                "version": "v5.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/3455",
                "description": "The `constructor` parameter can refer to an ES6 class now."
              }
            ]
          },
          "stability": 3,
          "stabilityText": "Legacy: Use ES2015 class syntax and `extends` keyword instead.",
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`constructor` {Function}",
                  "name": "constructor",
                  "type": "Function"
                },
                {
                  "textRaw": "`superConstructor` {Function}",
                  "name": "superConstructor",
                  "type": "Function"
                }
              ]
            }
          ],
          "desc": "<p>Usage of <code>util.inherits()</code> is discouraged. Please use the ES6 <code>class</code> and\n<code>extends</code> keywords to get language level inheritance support. Also note\nthat the two styles are <a href=\"https://github.com/nodejs/node/issues/4179\">semantically incompatible</a>.</p>\n<p>Inherit the prototype methods from one <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/constructor\">constructor</a> into another. The\nprototype of <code>constructor</code> will be set to a new object created from\n<code>superConstructor</code>.</p>\n<p>This mainly adds some input validation on top of\n<code>Object.setPrototypeOf(constructor.prototype, superConstructor.prototype)</code>.\nAs an additional convenience, <code>superConstructor</code> will be accessible\nthrough the <code>constructor.super_</code> property.</p>\n<pre><code class=\"language-js\">const util = require('node:util');\nconst EventEmitter = require('node:events');\n\nfunction MyStream() {\n  EventEmitter.call(this);\n}\n\nutil.inherits(MyStream, EventEmitter);\n\nMyStream.prototype.write = function(data) {\n  this.emit('data', data);\n};\n\nconst stream = new MyStream();\n\nconsole.log(stream instanceof EventEmitter); // true\nconsole.log(MyStream.super_ === EventEmitter); // true\n\nstream.on('data', (data) => {\n  console.log(`Received data: \"${data}\"`);\n});\nstream.write('It works!'); // Received data: \"It works!\"\n</code></pre>\n<p>ES6 example using <code>class</code> and <code>extends</code>:</p>\n<pre><code class=\"language-mjs\">import EventEmitter from 'node:events';\n\nclass MyStream extends EventEmitter {\n  write(data) {\n    this.emit('data', data);\n  }\n}\n\nconst stream = new MyStream();\n\nstream.on('data', (data) => {\n  console.log(`Received data: \"${data}\"`);\n});\nstream.write('With ES6');\n</code></pre>\n<pre><code class=\"language-cjs\">const EventEmitter = require('node:events');\n\nclass MyStream extends EventEmitter {\n  write(data) {\n    this.emit('data', data);\n  }\n}\n\nconst stream = new MyStream();\n\nstream.on('data', (data) => {\n  console.log(`Received data: \"${data}\"`);\n});\nstream.write('With ES6');\n</code></pre>"
        },
        {
          "textRaw": "`util.inspect(object[, options])`",
          "name": "inspect",
          "type": "method",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "`util.inspect(object[, showHidden[, depth[, colors]]])`",
          "name": "inspect",
          "type": "method",
          "meta": {
            "added": [
              "v0.3.0"
            ],
            "changes": [
              {
                "version": [
                  "v25.0.0"
                ],
                "pr-url": "https://github.com/nodejs/node/pull/59710",
                "description": "The util.inspect.styles.regexp style is now a method that is invoked for coloring the stringified regular expression."
              },
              {
                "version": [
                  "v17.3.0",
                  "v16.14.0"
                ],
                "pr-url": "https://github.com/nodejs/node/pull/41003",
                "description": "The `numericSeparator` option is supported now."
              },
              {
                "version": "v16.18.0",
                "pr-url": "https://github.com/nodejs/node/pull/43576",
                "description": "add support for `maxArrayLength` when inspecting `Set` and `Map`."
              },
              {
                "version": [
                  "v14.6.0",
                  "v12.19.0"
                ],
                "pr-url": "https://github.com/nodejs/node/pull/33690",
                "description": "If `object` is from a different `vm.Context` now, a custom inspection function on it will not receive context-specific arguments anymore."
              },
              {
                "version": [
                  "v13.13.0",
                  "v12.17.0"
                ],
                "pr-url": "https://github.com/nodejs/node/pull/32392",
                "description": "The `maxStringLength` option is supported now."
              },
              {
                "version": [
                  "v13.5.0",
                  "v12.16.0"
                ],
                "pr-url": "https://github.com/nodejs/node/pull/30768",
                "description": "User defined prototype properties are inspected in case `showHidden` is `true`."
              },
              {
                "version": "v13.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/27685",
                "description": "Circular references now include a marker to the reference."
              },
              {
                "version": "v12.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/27109",
                "description": "The `compact` options default is changed to `3` and the `breakLength` options default is changed to `80`."
              },
              {
                "version": "v12.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/24971",
                "description": "Internal properties no longer appear in the context argument of a custom inspection function."
              },
              {
                "version": "v11.11.0",
                "pr-url": "https://github.com/nodejs/node/pull/26269",
                "description": "The `compact` option accepts numbers for a new output mode."
              },
              {
                "version": "v11.7.0",
                "pr-url": "https://github.com/nodejs/node/pull/25006",
                "description": "ArrayBuffers now also show their binary contents."
              },
              {
                "version": "v11.5.0",
                "pr-url": "https://github.com/nodejs/node/pull/24852",
                "description": "The `getters` option is supported now."
              },
              {
                "version": "v11.4.0",
                "pr-url": "https://github.com/nodejs/node/pull/24326",
                "description": "The `depth` default changed back to `2`."
              },
              {
                "version": "v11.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/22846",
                "description": "The `depth` default changed to `20`."
              },
              {
                "version": "v11.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/22756",
                "description": "The inspection output is now limited to about 128 MiB. Data above that size will not be fully inspected."
              },
              {
                "version": "v10.12.0",
                "pr-url": "https://github.com/nodejs/node/pull/22788",
                "description": "The `sorted` option is supported now."
              },
              {
                "version": "v10.6.0",
                "pr-url": "https://github.com/nodejs/node/pull/20725",
                "description": "Inspecting linked lists and similar objects is now possible up to the maximum call stack size."
              },
              {
                "version": "v10.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/19259",
                "description": "The `WeakMap` and `WeakSet` entries can now be inspected as well."
              },
              {
                "version": "v9.9.0",
                "pr-url": "https://github.com/nodejs/node/pull/17576",
                "description": "The `compact` option is supported now."
              },
              {
                "version": "v6.6.0",
                "pr-url": "https://github.com/nodejs/node/pull/8174",
                "description": "Custom inspection functions can now return `this`."
              },
              {
                "version": "v6.3.0",
                "pr-url": "https://github.com/nodejs/node/pull/7499",
                "description": "The `breakLength` option is supported now."
              },
              {
                "version": "v6.1.0",
                "pr-url": "https://github.com/nodejs/node/pull/6334",
                "description": "The `maxArrayLength` option is supported now; in particular, long arrays are truncated by default."
              },
              {
                "version": "v6.1.0",
                "pr-url": "https://github.com/nodejs/node/pull/6465",
                "description": "The `showProxy` option is supported now."
              }
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`object` {any} Any JavaScript primitive or `Object`.",
                  "name": "object",
                  "type": "any",
                  "desc": "Any JavaScript primitive or `Object`."
                },
                {
                  "textRaw": "`showHidden` {boolean} If `true`, `object`'s non-enumerable symbols and properties are included in the formatted result. {WeakMap} and {WeakSet} entries are also included as well as user defined prototype properties (excluding method properties). **Default:** `false`.",
                  "name": "showHidden",
                  "type": "boolean",
                  "default": "`false`",
                  "desc": "If `true`, `object`'s non-enumerable symbols and properties are included in the formatted result. {WeakMap} and {WeakSet} entries are also included as well as user defined prototype properties (excluding method properties).",
                  "optional": true
                },
                {
                  "textRaw": "`depth` {number} Specifies the number of times to recurse while formatting `object`. This is useful for inspecting large objects. To recurse up to the maximum call stack size pass `Infinity` or `null`. **Default:** `2`.",
                  "name": "depth",
                  "type": "number",
                  "default": "`2`",
                  "desc": "Specifies the number of times to recurse while formatting `object`. This is useful for inspecting large objects. To recurse up to the maximum call stack size pass `Infinity` or `null`.",
                  "optional": true
                },
                {
                  "textRaw": "`colors` {boolean} If `true`, the output is styled with ANSI color codes. Colors are customizable. See Customizing `util.inspect` colors. **Default:** `false`.",
                  "name": "colors",
                  "type": "boolean",
                  "default": "`false`",
                  "desc": "If `true`, the output is styled with ANSI color codes. Colors are customizable. See Customizing `util.inspect` colors.",
                  "optional": true
                }
              ],
              "return": {
                "textRaw": "Returns: {string} The representation of `object`.",
                "name": "return",
                "type": "string",
                "desc": "The representation of `object`."
              }
            }
          ],
          "desc": "<p>The <code>util.inspect()</code> method returns a string representation of <code>object</code> that is\nintended for debugging. The output of <code>util.inspect</code> may change at any time\nand should not be depended upon programmatically. Additional <code>options</code> may be\npassed that alter the result.\n<code>util.inspect()</code> will use the constructor's name and/or <code>Symbol.toStringTag</code>\nproperty to make an identifiable tag for an inspected value.</p>\n<pre><code class=\"language-js\">class Foo {\n  get [Symbol.toStringTag]() {\n    return 'bar';\n  }\n}\n\nclass Bar {}\n\nconst baz = Object.create(null, { [Symbol.toStringTag]: { value: 'foo' } });\n\nutil.inspect(new Foo()); // 'Foo [bar] {}'\nutil.inspect(new Bar()); // 'Bar {}'\nutil.inspect(baz);       // '[foo] {}'\n</code></pre>\n<p>Circular references point to their anchor by using a reference index:</p>\n<pre><code class=\"language-mjs\">import { inspect } from 'node:util';\n\nconst obj = {};\nobj.a = [obj];\nobj.b = {};\nobj.b.inner = obj.b;\nobj.b.obj = obj;\n\nconsole.log(inspect(obj));\n// &#x3C;ref *1> {\n//   a: [ [Circular *1] ],\n//   b: &#x3C;ref *2> { inner: [Circular *2], obj: [Circular *1] }\n// }\n</code></pre>\n<pre><code class=\"language-cjs\">const { inspect } = require('node:util');\n\nconst obj = {};\nobj.a = [obj];\nobj.b = {};\nobj.b.inner = obj.b;\nobj.b.obj = obj;\n\nconsole.log(inspect(obj));\n// &#x3C;ref *1> {\n//   a: [ [Circular *1] ],\n//   b: &#x3C;ref *2> { inner: [Circular *2], obj: [Circular *1] }\n// }\n</code></pre>\n<p>The following example inspects all properties of the <code>util</code> object:</p>\n<pre><code class=\"language-mjs\">import util from 'node:util';\n\nconsole.log(util.inspect(util, { showHidden: true, depth: null }));\n</code></pre>\n<pre><code class=\"language-cjs\">const util = require('node:util');\n\nconsole.log(util.inspect(util, { showHidden: true, depth: null }));\n</code></pre>\n<p>The following example highlights the effect of the <code>compact</code> option:</p>\n<pre><code class=\"language-mjs\">import { inspect } from 'node:util';\n\nconst o = {\n  a: [1, 2, [[\n    'Lorem ipsum dolor sit amet,\\nconsectetur adipiscing elit, sed do ' +\n      'eiusmod \\ntempor incididunt ut labore et dolore magna aliqua.',\n    'test',\n    'foo']], 4],\n  b: new Map([['za', 1], ['zb', 'test']]),\n};\nconsole.log(inspect(o, { compact: true, depth: 5, breakLength: 80 }));\n\n// { a:\n//   [ 1,\n//     2,\n//     [ [ 'Lorem ipsum dolor sit amet,\\nconsectetur [...]', // A long line\n//           'test',\n//           'foo' ] ],\n//     4 ],\n//   b: Map(2) { 'za' => 1, 'zb' => 'test' } }\n\n// Setting `compact` to false or an integer creates more reader friendly output.\nconsole.log(inspect(o, { compact: false, depth: 5, breakLength: 80 }));\n\n// {\n//   a: [\n//     1,\n//     2,\n//     [\n//       [\n//         'Lorem ipsum dolor sit amet,\\n' +\n//           'consectetur adipiscing elit, sed do eiusmod \\n' +\n//           'tempor incididunt ut labore et dolore magna aliqua.',\n//         'test',\n//         'foo'\n//       ]\n//     ],\n//     4\n//   ],\n//   b: Map(2) {\n//     'za' => 1,\n//     'zb' => 'test'\n//   }\n// }\n\n// Setting `breakLength` to e.g. 150 will print the \"Lorem ipsum\" text in a\n// single line.\n</code></pre>\n<pre><code class=\"language-cjs\">const { inspect } = require('node:util');\n\nconst o = {\n  a: [1, 2, [[\n    'Lorem ipsum dolor sit amet,\\nconsectetur adipiscing elit, sed do ' +\n      'eiusmod \\ntempor incididunt ut labore et dolore magna aliqua.',\n    'test',\n    'foo']], 4],\n  b: new Map([['za', 1], ['zb', 'test']]),\n};\nconsole.log(inspect(o, { compact: true, depth: 5, breakLength: 80 }));\n\n// { a:\n//   [ 1,\n//     2,\n//     [ [ 'Lorem ipsum dolor sit amet,\\nconsectetur [...]', // A long line\n//           'test',\n//           'foo' ] ],\n//     4 ],\n//   b: Map(2) { 'za' => 1, 'zb' => 'test' } }\n\n// Setting `compact` to false or an integer creates more reader friendly output.\nconsole.log(inspect(o, { compact: false, depth: 5, breakLength: 80 }));\n\n// {\n//   a: [\n//     1,\n//     2,\n//     [\n//       [\n//         'Lorem ipsum dolor sit amet,\\n' +\n//           'consectetur adipiscing elit, sed do eiusmod \\n' +\n//           'tempor incididunt ut labore et dolore magna aliqua.',\n//         'test',\n//         'foo'\n//       ]\n//     ],\n//     4\n//   ],\n//   b: Map(2) {\n//     'za' => 1,\n//     'zb' => 'test'\n//   }\n// }\n\n// Setting `breakLength` to e.g. 150 will print the \"Lorem ipsum\" text in a\n// single line.\n</code></pre>\n<p>The <code>showHidden</code> option allows <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/WeakMap\"><code>&#x3C;WeakMap></code></a> and <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/WeakSet\"><code>&#x3C;WeakSet></code></a> entries to be\ninspected. If there are more entries than <code>maxArrayLength</code>, there is no\nguarantee which entries are displayed. That means retrieving the same\n<a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/WeakSet\"><code>&#x3C;WeakSet></code></a> entries twice may result in different output. Furthermore, entries\nwith no remaining strong references may be garbage collected at any time.</p>\n<pre><code class=\"language-mjs\">import { inspect } from 'node:util';\n\nconst obj = { a: 1 };\nconst obj2 = { b: 2 };\nconst weakSet = new WeakSet([obj, obj2]);\n\nconsole.log(inspect(weakSet, { showHidden: true }));\n// WeakSet { { a: 1 }, { b: 2 } }\n</code></pre>\n<pre><code class=\"language-cjs\">const { inspect } = require('node:util');\n\nconst obj = { a: 1 };\nconst obj2 = { b: 2 };\nconst weakSet = new WeakSet([obj, obj2]);\n\nconsole.log(inspect(weakSet, { showHidden: true }));\n// WeakSet { { a: 1 }, { b: 2 } }\n</code></pre>\n<p>The <code>sorted</code> option ensures that an object's property insertion order does not\nimpact the result of <code>util.inspect()</code>.</p>\n<pre><code class=\"language-mjs\">import { inspect } from 'node:util';\nimport assert from 'node:assert';\n\nconst o1 = {\n  b: [2, 3, 1],\n  a: '`a` comes before `b`',\n  c: new Set([2, 3, 1]),\n};\nconsole.log(inspect(o1, { sorted: true }));\n// { a: '`a` comes before `b`', b: [ 2, 3, 1 ], c: Set(3) { 1, 2, 3 } }\nconsole.log(inspect(o1, { sorted: (a, b) => b.localeCompare(a) }));\n// { c: Set(3) { 3, 2, 1 }, b: [ 2, 3, 1 ], a: '`a` comes before `b`' }\n\nconst o2 = {\n  c: new Set([2, 1, 3]),\n  a: '`a` comes before `b`',\n  b: [2, 3, 1],\n};\nassert.strict.equal(\n  inspect(o1, { sorted: true }),\n  inspect(o2, { sorted: true }),\n);\n</code></pre>\n<pre><code class=\"language-cjs\">const { inspect } = require('node:util');\nconst assert = require('node:assert');\n\nconst o1 = {\n  b: [2, 3, 1],\n  a: '`a` comes before `b`',\n  c: new Set([2, 3, 1]),\n};\nconsole.log(inspect(o1, { sorted: true }));\n// { a: '`a` comes before `b`', b: [ 2, 3, 1 ], c: Set(3) { 1, 2, 3 } }\nconsole.log(inspect(o1, { sorted: (a, b) => b.localeCompare(a) }));\n// { c: Set(3) { 3, 2, 1 }, b: [ 2, 3, 1 ], a: '`a` comes before `b`' }\n\nconst o2 = {\n  c: new Set([2, 1, 3]),\n  a: '`a` comes before `b`',\n  b: [2, 3, 1],\n};\nassert.strict.equal(\n  inspect(o1, { sorted: true }),\n  inspect(o2, { sorted: true }),\n);\n</code></pre>\n<p>The <code>numericSeparator</code> option adds an underscore every three digits to all\nnumbers.</p>\n<pre><code class=\"language-mjs\">import { inspect } from 'node:util';\n\nconst thousand = 1000;\nconst million = 1000000;\nconst bigNumber = 123456789n;\nconst bigDecimal = 1234.12345;\n\nconsole.log(inspect(thousand, { numericSeparator: true }));\n// 1_000\nconsole.log(inspect(million, { numericSeparator: true }));\n// 1_000_000\nconsole.log(inspect(bigNumber, { numericSeparator: true }));\n// 123_456_789n\nconsole.log(inspect(bigDecimal, { numericSeparator: true }));\n// 1_234.123_45\n</code></pre>\n<pre><code class=\"language-cjs\">const { inspect } = require('node:util');\n\nconst thousand = 1000;\nconst million = 1000000;\nconst bigNumber = 123456789n;\nconst bigDecimal = 1234.12345;\n\nconsole.log(inspect(thousand, { numericSeparator: true }));\n// 1_000\nconsole.log(inspect(million, { numericSeparator: true }));\n// 1_000_000\nconsole.log(inspect(bigNumber, { numericSeparator: true }));\n// 123_456_789n\nconsole.log(inspect(bigDecimal, { numericSeparator: true }));\n// 1_234.123_45\n</code></pre>\n<p><code>util.inspect()</code> is a synchronous method intended for debugging. Its maximum\noutput length is approximately 128 MiB. Inputs that result in longer output will\nbe truncated.</p>",
          "miscs": [
            {
              "textRaw": "Customizing `util.inspect` colors",
              "name": "Customizing `util.inspect` colors",
              "type": "misc",
              "desc": "<p>Color output (if enabled) of <code>util.inspect</code> is customizable globally\nvia the <code>util.inspect.styles</code> and <code>util.inspect.colors</code> properties.</p>\n<p><code>util.inspect.styles</code> is a map associating a style name to a color from\n<code>util.inspect.colors</code>.</p>\n<p>The default styles and associated colors are:</p>\n<ul>\n<li><code>bigint</code>: <code>yellow</code></li>\n<li><code>boolean</code>: <code>yellow</code></li>\n<li><code>date</code>: <code>magenta</code></li>\n<li><code>module</code>: <code>underline</code></li>\n<li><code>name</code>: (no styling)</li>\n<li><code>null</code>: <code>bold</code></li>\n<li><code>number</code>: <code>yellow</code></li>\n<li><code>regexp</code>: A method that colors character classes, groups, assertions, and\nother parts for improved readability. To customize the coloring, change the\n<code>colors</code> property. It is set to\n<code>['red', 'green', 'yellow', 'cyan', 'magenta']</code> by default and may be\nadjusted as needed. The array is repetitively iterated through depending on\nthe \"depth\".</li>\n<li><code>special</code>: <code>cyan</code> (e.g., <code>Proxies</code>)</li>\n<li><code>string</code>: <code>green</code></li>\n<li><code>symbol</code>: <code>green</code></li>\n<li><code>undefined</code>: <code>grey</code></li>\n</ul>\n<p>Color styling uses ANSI control codes that may not be supported on all\nterminals. To verify color support use <a href=\"tty.html#writestreamhascolorscount-env\"><code>tty.hasColors()</code></a>.</p>\n<p>Predefined control codes are listed below (grouped as \"Modifiers\", \"Foreground\ncolors\", and \"Background colors\").</p>",
              "miscs": [
                {
                  "textRaw": "Complex custom coloring",
                  "name": "complex_custom_coloring",
                  "type": "misc",
                  "desc": "<p>It is possible to define a method as style. It receives the stringified value\nof the input. It is invoked in case coloring is active and the type is\ninspected.</p>\n<p>Example: <code>util.inspect.styles.regexp(value)</code></p>\n<ul>\n<li><code>value</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#string_type\"><code>&#x3C;string></code></a> The string representation of the input type.</li>\n<li>Returns: <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#string_type\"><code>&#x3C;string></code></a> The adjusted representation of <code>object</code>.</li>\n</ul>",
                  "displayName": "Complex custom coloring"
                },
                {
                  "textRaw": "Modifiers",
                  "name": "modifiers",
                  "type": "misc",
                  "desc": "<p>Modifier support varies throughout different terminals. They will mostly be\nignored, if not supported.</p>\n<ul>\n<li><code>reset</code> - Resets all (color) modifiers to their defaults</li>\n<li><strong>bold</strong> - Make text bold</li>\n<li><em>italic</em> - Make text italic</li>\n<li><span style=\"border-bottom: 1px solid;\">underline</span> - Make text underlined</li>\n<li><del>strikethrough</del> - Puts a horizontal line through the center of the text\n(Alias: <code>strikeThrough</code>, <code>crossedout</code>, <code>crossedOut</code>)</li>\n<li><code>hidden</code> - Prints the text, but makes it invisible (Alias: conceal)</li>\n<li><span style=\"opacity: 0.5;\">dim</span> - Decreased color intensity (Alias:\n<code>faint</code>)</li>\n<li><span style=\"border-top: 1px solid;\">overlined</span> - Make text overlined</li>\n<li>blink - Hides and shows the text in an interval</li>\n<li><span style=\"filter: invert(100%);\">inverse</span> - Swap foreground and\nbackground colors (Alias: <code>swapcolors</code>, <code>swapColors</code>)</li>\n<li><span style=\"border-bottom: 1px double;\">doubleunderline</span> - Make text\ndouble underlined (Alias: <code>doubleUnderline</code>)</li>\n<li><span style=\"border: 1px solid;\">framed</span> - Draw a frame around the text</li>\n</ul>",
                  "displayName": "Modifiers"
                },
                {
                  "textRaw": "Foreground colors",
                  "name": "foreground_colors",
                  "type": "misc",
                  "desc": "<ul>\n<li><code>black</code></li>\n<li><code>red</code></li>\n<li><code>green</code></li>\n<li><code>yellow</code></li>\n<li><code>blue</code></li>\n<li><code>magenta</code></li>\n<li><code>cyan</code></li>\n<li><code>white</code></li>\n<li><code>gray</code> (alias: <code>grey</code>, <code>blackBright</code>)</li>\n<li><code>redBright</code></li>\n<li><code>greenBright</code></li>\n<li><code>yellowBright</code></li>\n<li><code>blueBright</code></li>\n<li><code>magentaBright</code></li>\n<li><code>cyanBright</code></li>\n<li><code>whiteBright</code></li>\n</ul>",
                  "displayName": "Foreground colors"
                },
                {
                  "textRaw": "Background colors",
                  "name": "background_colors",
                  "type": "misc",
                  "desc": "<ul>\n<li><code>bgBlack</code></li>\n<li><code>bgRed</code></li>\n<li><code>bgGreen</code></li>\n<li><code>bgYellow</code></li>\n<li><code>bgBlue</code></li>\n<li><code>bgMagenta</code></li>\n<li><code>bgCyan</code></li>\n<li><code>bgWhite</code></li>\n<li><code>bgGray</code> (alias: <code>bgGrey</code>, <code>bgBlackBright</code>)</li>\n<li><code>bgRedBright</code></li>\n<li><code>bgGreenBright</code></li>\n<li><code>bgYellowBright</code></li>\n<li><code>bgBlueBright</code></li>\n<li><code>bgMagentaBright</code></li>\n<li><code>bgCyanBright</code></li>\n<li><code>bgWhiteBright</code></li>\n</ul>",
                  "displayName": "Background colors"
                }
              ]
            },
            {
              "textRaw": "Custom inspection functions on objects",
              "name": "Custom inspection functions on objects",
              "type": "misc",
              "meta": {
                "added": [
                  "v0.1.97"
                ],
                "changes": [
                  {
                    "version": [
                      "v17.3.0",
                      "v16.14.0"
                    ],
                    "pr-url": "https://github.com/nodejs/node/pull/41019",
                    "description": "The inspect argument is added for more interoperability."
                  }
                ]
              },
              "desc": "<p>Objects may also define their own\n<a href=\"#utilinspectcustom\"><code>[util.inspect.custom](depth, opts, inspect)</code></a> function,\nwhich <code>util.inspect()</code> will invoke and use the result of when inspecting\nthe object.</p>\n<pre><code class=\"language-mjs\">import { inspect } from 'node:util';\n\nclass Box {\n  constructor(value) {\n    this.value = value;\n  }\n\n  [inspect.custom](depth, options, inspect) {\n    if (depth &#x3C; 0) {\n      return options.stylize('[Box]', 'special');\n    }\n\n    const newOptions = Object.assign({}, options, {\n      depth: options.depth === null ? null : options.depth - 1,\n    });\n\n    // Five space padding because that's the size of \"Box&#x3C; \".\n    const padding = ' '.repeat(5);\n    const inner = inspect(this.value, newOptions)\n                  .replace(/\\n/g, `\\n${padding}`);\n    return `${options.stylize('Box', 'special')}&#x3C; ${inner} >`;\n  }\n}\n\nconst box = new Box(true);\n\nconsole.log(inspect(box));\n// \"Box&#x3C; true >\"\n</code></pre>\n<pre><code class=\"language-cjs\">const { inspect } = require('node:util');\n\nclass Box {\n  constructor(value) {\n    this.value = value;\n  }\n\n  [inspect.custom](depth, options, inspect) {\n    if (depth &#x3C; 0) {\n      return options.stylize('[Box]', 'special');\n    }\n\n    const newOptions = Object.assign({}, options, {\n      depth: options.depth === null ? null : options.depth - 1,\n    });\n\n    // Five space padding because that's the size of \"Box&#x3C; \".\n    const padding = ' '.repeat(5);\n    const inner = inspect(this.value, newOptions)\n                  .replace(/\\n/g, `\\n${padding}`);\n    return `${options.stylize('Box', 'special')}&#x3C; ${inner} >`;\n  }\n}\n\nconst box = new Box(true);\n\nconsole.log(inspect(box));\n// \"Box&#x3C; true >\"\n</code></pre>\n<p>Custom <code>[util.inspect.custom](depth, opts, inspect)</code> functions typically return\na string but may return a value of any type that will be formatted accordingly\nby <code>util.inspect()</code>.</p>\n<pre><code class=\"language-mjs\">import { inspect } from 'node:util';\n\nconst obj = { foo: 'this will not show up in the inspect() output' };\nobj[inspect.custom] = (depth) => {\n  return { bar: 'baz' };\n};\n\nconsole.log(inspect(obj));\n// \"{ bar: 'baz' }\"\n</code></pre>\n<pre><code class=\"language-cjs\">const { inspect } = require('node:util');\n\nconst obj = { foo: 'this will not show up in the inspect() output' };\nobj[inspect.custom] = (depth) => {\n  return { bar: 'baz' };\n};\n\nconsole.log(inspect(obj));\n// \"{ bar: 'baz' }\"\n</code></pre>"
            }
          ],
          "properties": [
            {
              "textRaw": "Type: {symbol} that can be used to declare custom inspect functions.",
              "name": "custom",
              "type": "symbol",
              "meta": {
                "added": [
                  "v6.6.0"
                ],
                "changes": [
                  {
                    "version": "v10.12.0",
                    "pr-url": "https://github.com/nodejs/node/pull/20857",
                    "description": "This is now defined as a shared symbol."
                  }
                ]
              },
              "desc": "<p>In addition to being accessible through <code>util.inspect.custom</code>, this\nsymbol is <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/for\">registered globally</a> and can be\naccessed in any environment as <code>Symbol.for('nodejs.util.inspect.custom')</code>.</p>\n<p>Using this allows code to be written in a portable fashion, so that the custom\ninspect function is used in a Node.js environment and ignored in the browser.\nThe <code>util.inspect()</code> function itself is passed as third argument to the custom\ninspect function to allow further portability.</p>\n<pre><code class=\"language-js\">const customInspectSymbol = Symbol.for('nodejs.util.inspect.custom');\n\nclass Password {\n  constructor(value) {\n    this.value = value;\n  }\n\n  toString() {\n    return 'xxxxxxxx';\n  }\n\n  [customInspectSymbol](depth, inspectOptions, inspect) {\n    return `Password &#x3C;${this.toString()}>`;\n  }\n}\n\nconst password = new Password('r0sebud');\nconsole.log(password);\n// Prints Password &#x3C;xxxxxxxx>\n</code></pre>\n<p>See <a href=\"#custom-inspection-functions-on-objects\">Custom inspection functions on Objects</a> for more details.</p>",
              "shortDesc": "that can be used to declare custom inspect functions."
            },
            {
              "textRaw": "`util.inspect.defaultOptions`",
              "name": "defaultOptions",
              "type": "property",
              "meta": {
                "added": [
                  "v6.4.0"
                ],
                "changes": []
              },
              "desc": "<p>The <code>defaultOptions</code> value allows customization of the default options used by\n<code>util.inspect</code>. This is useful for functions like <code>console.log</code> or\n<code>util.format</code> which implicitly call into <code>util.inspect</code>. It shall be set to an\nobject containing one or more valid <a href=\"#utilinspectobject-options\"><code>util.inspect()</code></a> options. Setting\noption properties directly is also supported.</p>\n<pre><code class=\"language-mjs\">import { inspect } from 'node:util';\nconst arr = Array(156).fill(0);\n\nconsole.log(arr); // Logs the truncated array\ninspect.defaultOptions.maxArrayLength = null;\nconsole.log(arr); // logs the full array\n</code></pre>\n<pre><code class=\"language-cjs\">const { inspect } = require('node:util');\nconst arr = Array(156).fill(0);\n\nconsole.log(arr); // Logs the truncated array\ninspect.defaultOptions.maxArrayLength = null;\nconsole.log(arr); // logs the full array\n</code></pre>"
            }
          ]
        },
        {
          "textRaw": "`util.isDeepStrictEqual(val1, val2[, options])`",
          "name": "isDeepStrictEqual",
          "type": "method",
          "meta": {
            "added": [
              "v9.0.0"
            ],
            "changes": [
              {
                "version": "v24.9.0",
                "pr-url": "https://github.com/nodejs/node/pull/59762",
                "description": "Added `options` parameter to allow skipping prototype comparison."
              }
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`val1` {any}",
                  "name": "val1",
                  "type": "any"
                },
                {
                  "textRaw": "`val2` {any}",
                  "name": "val2",
                  "type": "any"
                },
                {
                  "name": "options",
                  "optional": true
                }
              ],
              "return": {
                "textRaw": "Returns: {boolean}",
                "name": "return",
                "type": "boolean"
              }
            }
          ],
          "desc": "<p>Returns <code>true</code> if there is deep strict equality between <code>val1</code> and <code>val2</code>.\nOtherwise, returns <code>false</code>.</p>\n<p>By default, deep strict equality includes comparison of object prototypes and\nconstructors. When <code>skipPrototype</code> is <code>true</code>, objects with\ndifferent prototypes or constructors can still be considered equal if their\nenumerable properties are deeply strictly equal.</p>\n<pre><code class=\"language-js\">const util = require('node:util');\n\nclass Foo {\n  constructor(a) {\n    this.a = a;\n  }\n}\n\nclass Bar {\n  constructor(a) {\n    this.a = a;\n  }\n}\n\nconst foo = new Foo(1);\nconst bar = new Bar(1);\n\n// Different constructors, same properties\nconsole.log(util.isDeepStrictEqual(foo, bar));\n// false\n\nconsole.log(util.isDeepStrictEqual(foo, bar, true));\n// true\n</code></pre>\n<p>See <a href=\"assert.html#assertdeepstrictequalactual-expected-message\"><code>assert.deepStrictEqual()</code></a> for more information about deep strict\nequality.</p>"
        },
        {
          "textRaw": "`util.parseArgs([config])`",
          "name": "parseArgs",
          "type": "method",
          "meta": {
            "added": [
              "v18.3.0",
              "v16.17.0"
            ],
            "changes": [
              {
                "version": [
                  "v22.4.0",
                  "v20.16.0"
                ],
                "pr-url": "https://github.com/nodejs/node/pull/53107",
                "description": "add support for allowing negative options in input `config`."
              },
              {
                "version": [
                  "v20.0.0"
                ],
                "pr-url": "https://github.com/nodejs/node/pull/46718",
                "description": "The API is no longer experimental."
              },
              {
                "version": [
                  "v18.11.0",
                  "v16.19.0"
                ],
                "pr-url": "https://github.com/nodejs/node/pull/44631",
                "description": "Add support for default values in input `config`."
              },
              {
                "version": [
                  "v18.7.0",
                  "v16.17.0"
                ],
                "pr-url": "https://github.com/nodejs/node/pull/43459",
                "description": "add support for returning detailed parse information using `tokens` in input `config` and returned properties."
              }
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`config` {Object} Used to provide arguments for parsing and to configure the parser. `config` supports the following properties:",
                  "name": "config",
                  "type": "Object",
                  "desc": "Used to provide arguments for parsing and to configure the parser. `config` supports the following properties:",
                  "options": [
                    {
                      "textRaw": "`args` {string}[] array of argument strings. **Default:** `process.argv` with `execPath` and `filename` removed.",
                      "name": "args",
                      "type": "string",
                      "default": "`process.argv` with `execPath` and `filename` removed",
                      "desc": "[] array of argument strings."
                    },
                    {
                      "textRaw": "`options` {Object} Used to describe arguments known to the parser. Keys of `options` are the long names of options and values are an {Object} accepting the following properties:",
                      "name": "options",
                      "type": "Object",
                      "desc": "Used to describe arguments known to the parser. Keys of `options` are the long names of options and values are an {Object} accepting the following properties:",
                      "options": [
                        {
                          "textRaw": "`type` {string} Type of argument, which must be either `boolean` or `string`.",
                          "name": "type",
                          "type": "string",
                          "desc": "Type of argument, which must be either `boolean` or `string`."
                        },
                        {
                          "textRaw": "`multiple` {boolean} Whether this option can be provided multiple times. If `true`, all values will be collected in an array. If `false`, values for the option are last-wins. **Default:** `false`.",
                          "name": "multiple",
                          "type": "boolean",
                          "default": "`false`",
                          "desc": "Whether this option can be provided multiple times. If `true`, all values will be collected in an array. If `false`, values for the option are last-wins."
                        },
                        {
                          "textRaw": "`short` {string} A single character alias for the option.",
                          "name": "short",
                          "type": "string",
                          "desc": "A single character alias for the option."
                        },
                        {
                          "textRaw": "`default` {string|boolean|string}[] | {boolean}[] The value to assign to the option if it does not appear in the arguments to be parsed. The value must match the type specified by the `type` property. If `multiple` is `true`, it must be an array. No default value is applied when the option does appear in the arguments to be parsed, even if the provided value is falsy.",
                          "name": "default",
                          "type": "string|boolean|string",
                          "desc": "[] | {boolean}[] The value to assign to the option if it does not appear in the arguments to be parsed. The value must match the type specified by the `type` property. If `multiple` is `true`, it must be an array. No default value is applied when the option does appear in the arguments to be parsed, even if the provided value is falsy."
                        }
                      ]
                    },
                    {
                      "textRaw": "`strict` {boolean} Should an error be thrown when unknown arguments are encountered, or when arguments are passed that do not match the `type` configured in `options`. **Default:** `true`.",
                      "name": "strict",
                      "type": "boolean",
                      "default": "`true`",
                      "desc": "Should an error be thrown when unknown arguments are encountered, or when arguments are passed that do not match the `type` configured in `options`."
                    },
                    {
                      "textRaw": "`allowPositionals` {boolean} Whether this command accepts positional arguments. **Default:** `false` if `strict` is `true`, otherwise `true`.",
                      "name": "allowPositionals",
                      "type": "boolean",
                      "default": "`false` if `strict` is `true`, otherwise `true`",
                      "desc": "Whether this command accepts positional arguments."
                    },
                    {
                      "textRaw": "`allowNegative` {boolean} If `true`, allows explicitly setting boolean options to `false` by prefixing the option name with `--no-`. **Default:** `false`.",
                      "name": "allowNegative",
                      "type": "boolean",
                      "default": "`false`",
                      "desc": "If `true`, allows explicitly setting boolean options to `false` by prefixing the option name with `--no-`."
                    },
                    {
                      "textRaw": "`tokens` {boolean} Return the parsed tokens. This is useful for extending the built-in behavior, from adding additional checks through to reprocessing the tokens in different ways. **Default:** `false`.",
                      "name": "tokens",
                      "type": "boolean",
                      "default": "`false`",
                      "desc": "Return the parsed tokens. This is useful for extending the built-in behavior, from adding additional checks through to reprocessing the tokens in different ways."
                    }
                  ],
                  "optional": true
                }
              ],
              "return": {
                "textRaw": "Returns: {Object} The parsed command line arguments:",
                "name": "return",
                "type": "Object",
                "desc": "The parsed command line arguments:",
                "options": [
                  {
                    "textRaw": "`values` {Object} A mapping of parsed option names with their {string} or {boolean} values.",
                    "name": "values",
                    "type": "Object",
                    "desc": "A mapping of parsed option names with their {string} or {boolean} values."
                  },
                  {
                    "textRaw": "`positionals` {string}[] Positional arguments.",
                    "name": "positionals",
                    "type": "string",
                    "desc": "[] Positional arguments."
                  },
                  {
                    "textRaw": "`tokens` {Object}[] | {undefined} See parseArgs tokens section. Only returned if `config` includes `tokens: true`.",
                    "name": "tokens",
                    "type": "Object",
                    "desc": "[] | {undefined} See parseArgs tokens section. Only returned if `config` includes `tokens: true`."
                  }
                ]
              }
            }
          ],
          "desc": "<p>Provides a higher level API for command-line argument parsing than interacting\nwith <code>process.argv</code> directly. Takes a specification for the expected arguments\nand returns a structured object with the parsed options and positionals.</p>\n<pre><code class=\"language-mjs\">import { parseArgs } from 'node:util';\nconst args = ['-f', '--bar', 'b'];\nconst options = {\n  foo: {\n    type: 'boolean',\n    short: 'f',\n  },\n  bar: {\n    type: 'string',\n  },\n};\nconst {\n  values,\n  positionals,\n} = parseArgs({ args, options });\nconsole.log(values, positionals);\n// Prints: [Object: null prototype] { foo: true, bar: 'b' } []\n</code></pre>\n<pre><code class=\"language-cjs\">const { parseArgs } = require('node:util');\nconst args = ['-f', '--bar', 'b'];\nconst options = {\n  foo: {\n    type: 'boolean',\n    short: 'f',\n  },\n  bar: {\n    type: 'string',\n  },\n};\nconst {\n  values,\n  positionals,\n} = parseArgs({ args, options });\nconsole.log(values, positionals);\n// Prints: [Object: null prototype] { foo: true, bar: 'b' } []\n</code></pre>",
          "modules": [
            {
              "textRaw": "`parseArgs` `tokens`",
              "name": "`parseargs`_`tokens`",
              "type": "module",
              "desc": "<p>Detailed parse information is available for adding custom behaviors by\nspecifying <code>tokens: true</code> in the configuration.\nThe returned tokens have properties describing:</p>\n<ul>\n<li>all tokens\n<ul>\n<li><code>kind</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#string_type\"><code>&#x3C;string></code></a> One of 'option', 'positional', or 'option-terminator'.</li>\n<li><code>index</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#number_type\"><code>&#x3C;number></code></a> Index of element in <code>args</code> containing token. So the\nsource argument for a token is <code>args[token.index]</code>.</li>\n</ul>\n</li>\n<li>option tokens\n<ul>\n<li><code>name</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#string_type\"><code>&#x3C;string></code></a> Long name of option.</li>\n<li><code>rawName</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#string_type\"><code>&#x3C;string></code></a> How option used in args, like <code>-f</code> of <code>--foo</code>.</li>\n<li><code>value</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#string_type\"><code>&#x3C;string></code></a> | <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#undefined_type\"><code>&#x3C;undefined></code></a> Option value specified in args.\nUndefined for boolean options.</li>\n<li><code>inlineValue</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#boolean_type\"><code>&#x3C;boolean></code></a> | <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#undefined_type\"><code>&#x3C;undefined></code></a> Whether option value specified inline,\nlike <code>--foo=bar</code>.</li>\n</ul>\n</li>\n<li>positional tokens\n<ul>\n<li><code>value</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#string_type\"><code>&#x3C;string></code></a> The value of the positional argument in args (i.e. <code>args[index]</code>).</li>\n</ul>\n</li>\n<li>option-terminator token</li>\n</ul>\n<p>The returned tokens are in the order encountered in the input args. Options\nthat appear more than once in args produce a token for each use. Short option\ngroups like <code>-xy</code> expand to a token for each option. So <code>-xxx</code> produces\nthree tokens.</p>\n<p>For example, to add support for a negated option like <code>--no-color</code> (which\n<code>allowNegative</code> supports when the option is of <code>boolean</code> type), the returned\ntokens can be reprocessed to change the value stored for the negated option.</p>\n<pre><code class=\"language-mjs\">import { parseArgs } from 'node:util';\n\nconst options = {\n  'color': { type: 'boolean' },\n  'no-color': { type: 'boolean' },\n  'logfile': { type: 'string' },\n  'no-logfile': { type: 'boolean' },\n};\nconst { values, tokens } = parseArgs({ options, tokens: true });\n\n// Reprocess the option tokens and overwrite the returned values.\ntokens\n  .filter((token) => token.kind === 'option')\n  .forEach((token) => {\n    if (token.name.startsWith('no-')) {\n      // Store foo:false for --no-foo\n      const positiveName = token.name.slice(3);\n      values[positiveName] = false;\n      delete values[token.name];\n    } else {\n      // Resave value so last one wins if both --foo and --no-foo.\n      values[token.name] = token.value ?? true;\n    }\n  });\n\nconst color = values.color;\nconst logfile = values.logfile ?? 'default.log';\n\nconsole.log({ logfile, color });\n</code></pre>\n<pre><code class=\"language-cjs\">const { parseArgs } = require('node:util');\n\nconst options = {\n  'color': { type: 'boolean' },\n  'no-color': { type: 'boolean' },\n  'logfile': { type: 'string' },\n  'no-logfile': { type: 'boolean' },\n};\nconst { values, tokens } = parseArgs({ options, tokens: true });\n\n// Reprocess the option tokens and overwrite the returned values.\ntokens\n  .filter((token) => token.kind === 'option')\n  .forEach((token) => {\n    if (token.name.startsWith('no-')) {\n      // Store foo:false for --no-foo\n      const positiveName = token.name.slice(3);\n      values[positiveName] = false;\n      delete values[token.name];\n    } else {\n      // Resave value so last one wins if both --foo and --no-foo.\n      values[token.name] = token.value ?? true;\n    }\n  });\n\nconst color = values.color;\nconst logfile = values.logfile ?? 'default.log';\n\nconsole.log({ logfile, color });\n</code></pre>\n<p>Example usage showing negated options, and when an option is used\nmultiple ways then last one wins.</p>\n<pre><code class=\"language-console\">$ node negate.js\n{ logfile: 'default.log', color: undefined }\n$ node negate.js --no-logfile --no-color\n{ logfile: false, color: false }\n$ node negate.js --logfile=test.log --color\n{ logfile: 'test.log', color: true }\n$ node negate.js --no-logfile --logfile=test.log --color --no-color\n{ logfile: 'test.log', color: false }\n</code></pre>",
              "displayName": "`parseArgs` `tokens`"
            }
          ]
        },
        {
          "textRaw": "`util.parseEnv(content)`",
          "name": "parseEnv",
          "type": "method",
          "meta": {
            "added": [
              "v21.7.0",
              "v20.12.0"
            ],
            "changes": [
              {
                "version": [
                  "v24.10.0",
                  "v22.21.0"
                ],
                "pr-url": "https://github.com/nodejs/node/pull/59925",
                "description": "This API is no longer experimental."
              }
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`content` {string}",
                  "name": "content",
                  "type": "string"
                }
              ]
            }
          ],
          "desc": "<p>The raw contents of a <code>.env</code> file.</p>\n<ul>\n<li>Returns: <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object\"><code>&#x3C;Object></code></a></li>\n</ul>\n<p>Given an example <code>.env</code> file:</p>\n<pre><code class=\"language-cjs\">const { parseEnv } = require('node:util');\n\nparseEnv('HELLO=world\\nHELLO=oh my\\n');\n// Returns: { HELLO: 'oh my' }\n</code></pre>\n<pre><code class=\"language-mjs\">import { parseEnv } from 'node:util';\n\nparseEnv('HELLO=world\\nHELLO=oh my\\n');\n// Returns: { HELLO: 'oh my' }\n</code></pre>"
        },
        {
          "textRaw": "`util.promisify(original)`",
          "name": "promisify",
          "type": "method",
          "meta": {
            "added": [
              "v8.0.0"
            ],
            "changes": [
              {
                "version": "v20.8.0",
                "pr-url": "https://github.com/nodejs/node/pull/49647",
                "description": "Calling `promisify` on a function that returns a `Promise` is deprecated."
              }
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`original` {Function}",
                  "name": "original",
                  "type": "Function"
                }
              ],
              "return": {
                "textRaw": "Returns: {Function}",
                "name": "return",
                "type": "Function"
              }
            }
          ],
          "desc": "<p>Takes a function following the common error-first callback style, i.e. taking\nan <code>(err, value) => ...</code> callback as the last argument, and returns a version\nthat returns promises.</p>\n<pre><code class=\"language-mjs\">import { promisify } from 'node:util';\nimport { stat } from 'node:fs';\n\nconst promisifiedStat = promisify(stat);\npromisifiedStat('.').then((stats) => {\n  // Do something with `stats`\n}).catch((error) => {\n  // Handle the error.\n});\n</code></pre>\n<pre><code class=\"language-cjs\">const { promisify } = require('node:util');\nconst { stat } = require('node:fs');\n\nconst promisifiedStat = promisify(stat);\npromisifiedStat('.').then((stats) => {\n  // Do something with `stats`\n}).catch((error) => {\n  // Handle the error.\n});\n</code></pre>\n<p>Or, equivalently using <code>async function</code>s:</p>\n<pre><code class=\"language-mjs\">import { promisify } from 'node:util';\nimport { stat } from 'node:fs';\n\nconst promisifiedStat = promisify(stat);\n\nasync function callStat() {\n  const stats = await promisifiedStat('.');\n  console.log(`This directory is owned by ${stats.uid}`);\n}\n\ncallStat();\n</code></pre>\n<pre><code class=\"language-cjs\">const { promisify } = require('node:util');\nconst { stat } = require('node:fs');\n\nconst promisifiedStat = promisify(stat);\n\nasync function callStat() {\n  const stats = await promisifiedStat('.');\n  console.log(`This directory is owned by ${stats.uid}`);\n}\n\ncallStat();\n</code></pre>\n<p>If there is an <code>original[util.promisify.custom]</code> property present, <code>promisify</code>\nwill return its value, see <a href=\"#custom-promisified-functions\">Custom promisified functions</a>.</p>\n<p><code>promisify()</code> assumes that <code>original</code> is a function taking a callback as its\nfinal argument in all cases. If <code>original</code> is not a function, <code>promisify()</code>\nwill throw an error. If <code>original</code> is a function but its last argument is not\nan error-first callback, it will still be passed an error-first\ncallback as its last argument.</p>\n<p>Using <code>promisify()</code> on class methods or other methods that use <code>this</code> may not\nwork as expected unless handled specially:</p>\n<pre><code class=\"language-mjs\">import { promisify } from 'node:util';\n\nclass Foo {\n  constructor() {\n    this.a = 42;\n  }\n\n  bar(callback) {\n    callback(null, this.a);\n  }\n}\n\nconst foo = new Foo();\n\nconst naiveBar = promisify(foo.bar);\n// TypeError: Cannot read properties of undefined (reading 'a')\n// naiveBar().then(a => console.log(a));\n\nnaiveBar.call(foo).then((a) => console.log(a)); // '42'\n\nconst bindBar = naiveBar.bind(foo);\nbindBar().then((a) => console.log(a)); // '42'\n</code></pre>\n<pre><code class=\"language-cjs\">const { promisify } = require('node:util');\n\nclass Foo {\n  constructor() {\n    this.a = 42;\n  }\n\n  bar(callback) {\n    callback(null, this.a);\n  }\n}\n\nconst foo = new Foo();\n\nconst naiveBar = promisify(foo.bar);\n// TypeError: Cannot read properties of undefined (reading 'a')\n// naiveBar().then(a => console.log(a));\n\nnaiveBar.call(foo).then((a) => console.log(a)); // '42'\n\nconst bindBar = naiveBar.bind(foo);\nbindBar().then((a) => console.log(a)); // '42'\n</code></pre>",
          "modules": [
            {
              "textRaw": "Custom promisified functions",
              "name": "custom_promisified_functions",
              "type": "module",
              "desc": "<p>Using the <code>util.promisify.custom</code> symbol one can override the return value of\n<a href=\"#utilpromisifyoriginal\"><code>util.promisify()</code></a>:</p>\n<pre><code class=\"language-mjs\">import { promisify } from 'node:util';\n\nfunction doSomething(foo, callback) {\n  // ...\n}\n\ndoSomething[promisify.custom] = (foo) => {\n  return getPromiseSomehow();\n};\n\nconst promisified = promisify(doSomething);\nconsole.log(promisified === doSomething[promisify.custom]);\n// prints 'true'\n</code></pre>\n<pre><code class=\"language-cjs\">const { promisify } = require('node:util');\n\nfunction doSomething(foo, callback) {\n  // ...\n}\n\ndoSomething[promisify.custom] = (foo) => {\n  return getPromiseSomehow();\n};\n\nconst promisified = promisify(doSomething);\nconsole.log(promisified === doSomething[promisify.custom]);\n// prints 'true'\n</code></pre>\n<p>This can be useful for cases where the original function does not follow the\nstandard format of taking an error-first callback as the last argument.</p>\n<p>For example, with a function that takes in\n<code>(foo, onSuccessCallback, onErrorCallback)</code>:</p>\n<pre><code class=\"language-js\">doSomething[util.promisify.custom] = (foo) => {\n  return new Promise((resolve, reject) => {\n    doSomething(foo, resolve, reject);\n  });\n};\n</code></pre>\n<p>If <code>promisify.custom</code> is defined but is not a function, <code>promisify()</code> will\nthrow an error.</p>",
              "displayName": "Custom promisified functions"
            }
          ],
          "properties": [
            {
              "textRaw": "Type: {symbol} that can be used to declare custom promisified variants of functions, see Custom promisified functions.",
              "name": "custom",
              "type": "symbol",
              "meta": {
                "added": [
                  "v8.0.0"
                ],
                "changes": [
                  {
                    "version": [
                      "v13.12.0",
                      "v12.16.2"
                    ],
                    "pr-url": "https://github.com/nodejs/node/pull/31672",
                    "description": "This is now defined as a shared symbol."
                  }
                ]
              },
              "desc": "<p>In addition to being accessible through <code>util.promisify.custom</code>, this\nsymbol is <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/for\">registered globally</a> and can be\naccessed in any environment as <code>Symbol.for('nodejs.util.promisify.custom')</code>.</p>\n<p>For example, with a function that takes in\n<code>(foo, onSuccessCallback, onErrorCallback)</code>:</p>\n<pre><code class=\"language-js\">const kCustomPromisifiedSymbol = Symbol.for('nodejs.util.promisify.custom');\n\ndoSomething[kCustomPromisifiedSymbol] = (foo) => {\n  return new Promise((resolve, reject) => {\n    doSomething(foo, resolve, reject);\n  });\n};\n</code></pre>",
              "shortDesc": "that can be used to declare custom promisified variants of functions, see Custom promisified functions."
            }
          ]
        },
        {
          "textRaw": "`util.stripVTControlCharacters(str)`",
          "name": "stripVTControlCharacters",
          "type": "method",
          "meta": {
            "added": [
              "v16.11.0"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`str` {string}",
                  "name": "str",
                  "type": "string"
                }
              ],
              "return": {
                "textRaw": "Returns: {string}",
                "name": "return",
                "type": "string"
              }
            }
          ],
          "desc": "<p>Returns <code>str</code> with any ANSI escape codes removed.</p>\n<pre><code class=\"language-js\">console.log(util.stripVTControlCharacters('\\u001B[4mvalue\\u001B[0m'));\n// Prints \"value\"\n</code></pre>"
        },
        {
          "textRaw": "`util.styleText(format, text[, options])`",
          "name": "styleText",
          "type": "method",
          "meta": {
            "added": [
              "v21.7.0",
              "v20.12.0"
            ],
            "changes": [
              {
                "version": "v26.1.0",
                "pr-url": "https://github.com/nodejs/node/pull/61556",
                "description": "Add support for hexadecimal colors."
              },
              {
                "version": [
                  "v24.2.0",
                  "v22.17.0"
                ],
                "pr-url": "https://github.com/nodejs/node/pull/58437",
                "description": "Added the `'none'` format as a non-op format."
              },
              {
                "version": [
                  "v23.5.0",
                  "v22.13.0"
                ],
                "pr-url": "https://github.com/nodejs/node/pull/56265",
                "description": "styleText is now stable."
              },
              {
                "version": [
                  "v22.8.0",
                  "v20.18.0"
                ],
                "pr-url": "https://github.com/nodejs/node/pull/54389",
                "description": "Respect isTTY and environment variables such as NO_COLOR, NODE_DISABLE_COLORS, and FORCE_COLOR."
              }
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`format` {string|Array} A text format or an Array of text formats defined in `util.inspect.colors`, or a hex color in `#RGB` or `#RRGGBB` form.",
                  "name": "format",
                  "type": "string|Array",
                  "desc": "A text format or an Array of text formats defined in `util.inspect.colors`, or a hex color in `#RGB` or `#RRGGBB` form."
                },
                {
                  "textRaw": "`text` {string} The text to be formatted.",
                  "name": "text",
                  "type": "string",
                  "desc": "The text to be formatted."
                },
                {
                  "textRaw": "`options` {Object}",
                  "name": "options",
                  "type": "Object",
                  "options": [
                    {
                      "textRaw": "`validateStream` {boolean} When true, `stream` is checked to see if it can handle colors. **Default:** `true`.",
                      "name": "validateStream",
                      "type": "boolean",
                      "default": "`true`",
                      "desc": "When true, `stream` is checked to see if it can handle colors."
                    },
                    {
                      "textRaw": "`stream` {Stream} A stream that will be validated if it can be colored. **Default:** `process.stdout`.",
                      "name": "stream",
                      "type": "Stream",
                      "default": "`process.stdout`",
                      "desc": "A stream that will be validated if it can be colored."
                    }
                  ],
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>This function returns a formatted text considering the <code>format</code> passed\nfor printing in a terminal. It is aware of the terminal's capabilities\nand acts according to the configuration set via <code>NO_COLOR</code>,\n<code>NODE_DISABLE_COLORS</code> and <code>FORCE_COLOR</code> environment variables.</p>\n<pre><code class=\"language-mjs\">import { styleText } from 'node:util';\nimport { stderr } from 'node:process';\n\nconst successMessage = styleText('green', 'Success!');\nconsole.log(successMessage);\n\nconst errorMessage = styleText(\n  'red',\n  'Error! Error!',\n  // Validate if process.stderr has TTY\n  { stream: stderr },\n);\nconsole.error(errorMessage);\n</code></pre>\n<pre><code class=\"language-cjs\">const { styleText } = require('node:util');\nconst { stderr } = require('node:process');\n\nconst successMessage = styleText('green', 'Success!');\nconsole.log(successMessage);\n\nconst errorMessage = styleText(\n  'red',\n  'Error! Error!',\n  // Validate if process.stderr has TTY\n  { stream: stderr },\n);\nconsole.error(errorMessage);\n</code></pre>\n<p><code>util.inspect.colors</code> also provides text formats such as <code>italic</code>, and\n<code>underline</code> and you can combine both:</p>\n<pre><code class=\"language-cjs\">console.log(\n  util.styleText(['underline', 'italic'], 'My italic underlined message'),\n);\n</code></pre>\n<p>When passing an array of formats, the order of the format applied\nis left to right so the following style might overwrite the previous one.</p>\n<pre><code class=\"language-cjs\">console.log(\n  util.styleText(['red', 'green'], 'text'), // green\n);\n</code></pre>\n<p>The special format value <code>none</code> applies no additional styling to the text.</p>\n<p>In addition to predefined color names, <code>util.styleText()</code> supports hex color\nstrings using ANSI TrueColor (24-bit) escape sequences. Hex colors can be\nspecified in either 3-digit (<code>#RGB</code>) or 6-digit (<code>#RRGGBB</code>) format:</p>\n<pre><code class=\"language-mjs\">import { styleText } from 'node:util';\n\n// 6-digit hex color\nconsole.log(styleText('#ff5733', 'Orange text'));\n\n// 3-digit hex color (shorthand)\nconsole.log(styleText('#f00', 'Red text'));\n</code></pre>\n<pre><code class=\"language-cjs\">const { styleText } = require('node:util');\n\n// 6-digit hex color\nconsole.log(styleText('#ff5733', 'Orange text'));\n\n// 3-digit hex color (shorthand)\nconsole.log(styleText('#f00', 'Red text'));\n</code></pre>\n<p>The full list of formats can be found in <a href=\"#modifiers\">modifiers</a>.</p>"
        },
        {
          "textRaw": "`util.toUSVString(string)`",
          "name": "toUSVString",
          "type": "method",
          "meta": {
            "added": [
              "v16.8.0",
              "v14.18.0"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`string` {string}",
                  "name": "string",
                  "type": "string"
                }
              ]
            }
          ],
          "desc": "<p>Returns the <code>string</code> after replacing any surrogate code points\n(or equivalently, any unpaired surrogate code units) with the\nUnicode \"replacement character\" U+FFFD.</p>"
        },
        {
          "textRaw": "`util.transferableAbortController()`",
          "name": "transferableAbortController",
          "type": "method",
          "meta": {
            "added": [
              "v18.11.0"
            ],
            "changes": [
              {
                "version": [
                  "v23.11.0",
                  "v22.15.0"
                ],
                "pr-url": "https://github.com/nodejs/node/pull/57510",
                "description": "Marking the API stable."
              }
            ]
          },
          "signatures": [
            {
              "params": []
            }
          ],
          "desc": "<p>Creates and returns an <a href=\"globals.html#class-abortcontroller\"><code>&#x3C;AbortController></code></a> instance whose <a href=\"globals.html#class-abortsignal\"><code>&#x3C;AbortSignal></code></a> is marked\nas transferable and can be used with <code>structuredClone()</code> or <code>postMessage()</code>.</p>"
        },
        {
          "textRaw": "`util.transferableAbortSignal(signal)`",
          "name": "transferableAbortSignal",
          "type": "method",
          "meta": {
            "added": [
              "v18.11.0"
            ],
            "changes": [
              {
                "version": [
                  "v23.11.0",
                  "v22.15.0"
                ],
                "pr-url": "https://github.com/nodejs/node/pull/57510",
                "description": "Marking the API stable."
              }
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`signal` {AbortSignal}",
                  "name": "signal",
                  "type": "AbortSignal"
                }
              ],
              "return": {
                "textRaw": "Returns: {AbortSignal}",
                "name": "return",
                "type": "AbortSignal"
              }
            }
          ],
          "desc": "<p>Marks the given <a href=\"globals.html#class-abortsignal\"><code>&#x3C;AbortSignal></code></a> as transferable so that it can be used with <code>structuredClone()</code> and <code>postMessage()</code>.</p>\n<pre><code class=\"language-js\">const signal = transferableAbortSignal(AbortSignal.timeout(100));\nconst channel = new MessageChannel();\nchannel.port2.postMessage(signal, [signal]);\n</code></pre>"
        },
        {
          "textRaw": "`util.aborted(signal, resource)`",
          "name": "aborted",
          "type": "method",
          "meta": {
            "added": [
              "v19.7.0",
              "v18.16.0"
            ],
            "changes": [
              {
                "version": [
                  "v24.0.0",
                  "v22.16.0"
                ],
                "pr-url": "https://github.com/nodejs/node/pull/57765",
                "description": "Change stability index for this feature from Experimental to Stable."
              }
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`signal` {AbortSignal}",
                  "name": "signal",
                  "type": "AbortSignal"
                },
                {
                  "textRaw": "`resource` {Object} Any non-null object tied to the abortable operation and held weakly. If `resource` is garbage collected before the `signal` aborts, the promise remains pending, allowing Node.js to stop tracking it. This helps prevent memory leaks in long-running or non-cancelable operations.",
                  "name": "resource",
                  "type": "Object",
                  "desc": "Any non-null object tied to the abortable operation and held weakly. If `resource` is garbage collected before the `signal` aborts, the promise remains pending, allowing Node.js to stop tracking it. This helps prevent memory leaks in long-running or non-cancelable operations."
                }
              ],
              "return": {
                "textRaw": "Returns: {Promise}",
                "name": "return",
                "type": "Promise"
              }
            }
          ],
          "desc": "<p>Listens to abort event on the provided <code>signal</code> and returns a promise that resolves when the <code>signal</code> is aborted.\nIf <code>resource</code> is provided, it weakly references the operation's associated object,\nso if <code>resource</code> is garbage collected before the <code>signal</code> aborts,\nthen returned promise shall remain pending.\nThis prevents memory leaks in long-running or non-cancelable operations.</p>\n<pre><code class=\"language-cjs\">const { aborted } = require('node:util');\n\n// Obtain an object with an abortable signal, like a custom resource or operation.\nconst dependent = obtainSomethingAbortable();\n\n// Pass `dependent` as the resource, indicating the promise should only resolve\n// if `dependent` is still in memory when the signal is aborted.\naborted(dependent.signal, dependent).then(() => {\n\n  // This code runs when `dependent` is aborted.\n  console.log('Dependent resource was aborted.');\n});\n\n// Simulate an event that triggers the abort.\ndependent.on('event', () => {\n  dependent.abort(); // This will cause the `aborted` promise to resolve.\n});\n</code></pre>\n<pre><code class=\"language-mjs\">import { aborted } from 'node:util';\n\n// Obtain an object with an abortable signal, like a custom resource or operation.\nconst dependent = obtainSomethingAbortable();\n\n// Pass `dependent` as the resource, indicating the promise should only resolve\n// if `dependent` is still in memory when the signal is aborted.\naborted(dependent.signal, dependent).then(() => {\n\n  // This code runs when `dependent` is aborted.\n  console.log('Dependent resource was aborted.');\n});\n\n// Simulate an event that triggers the abort.\ndependent.on('event', () => {\n  dependent.abort(); // This will cause the `aborted` promise to resolve.\n});\n</code></pre>"
        }
      ],
      "classes": [
        {
          "textRaw": "Class: `util.MIMEType`",
          "name": "util.MIMEType",
          "type": "class",
          "meta": {
            "added": [
              "v19.1.0",
              "v18.13.0"
            ],
            "changes": [
              {
                "version": [
                  "v23.11.0",
                  "v22.15.0"
                ],
                "pr-url": "https://github.com/nodejs/node/pull/57510",
                "description": "Marking the API stable."
              }
            ]
          },
          "desc": "<p>An implementation of <a href=\"https://bmeck.github.io/node-proposal-mime-api/\">the MIMEType class</a>.</p>\n<p>In accordance with browser conventions, all properties of <code>MIMEType</code> objects\nare implemented as getters and setters on the class prototype, rather than as\ndata properties on the object itself.</p>\n<p>A MIME string is a structured string containing multiple meaningful\ncomponents. When parsed, a <code>MIMEType</code> object is returned containing\nproperties for each of these components.</p>",
          "signatures": [
            {
              "textRaw": "`new MIMEType(input)`",
              "name": "MIMEType",
              "type": "ctor",
              "params": [
                {
                  "textRaw": "`input` {string} The input MIME to parse",
                  "name": "input",
                  "type": "string",
                  "desc": "The input MIME to parse"
                }
              ],
              "desc": "<p>Creates a new <code>MIMEType</code> object by parsing the <code>input</code>.</p>\n<pre><code class=\"language-mjs\">import { MIMEType } from 'node:util';\n\nconst myMIME = new MIMEType('text/plain');\n</code></pre>\n<pre><code class=\"language-cjs\">const { MIMEType } = require('node:util');\n\nconst myMIME = new MIMEType('text/plain');\n</code></pre>\n<p>A <code>TypeError</code> will be thrown if the <code>input</code> is not a valid MIME. Note\nthat an effort will be made to coerce the given values into strings. For\ninstance:</p>\n<pre><code class=\"language-mjs\">import { MIMEType } from 'node:util';\nconst myMIME = new MIMEType({ toString: () => 'text/plain' });\nconsole.log(String(myMIME));\n// Prints: text/plain\n</code></pre>\n<pre><code class=\"language-cjs\">const { MIMEType } = require('node:util');\nconst myMIME = new MIMEType({ toString: () => 'text/plain' });\nconsole.log(String(myMIME));\n// Prints: text/plain\n</code></pre>"
            }
          ],
          "properties": [
            {
              "textRaw": "Type: {string}",
              "name": "type",
              "type": "string",
              "desc": "<p>Gets and sets the type portion of the MIME.</p>\n<pre><code class=\"language-mjs\">import { MIMEType } from 'node:util';\n\nconst myMIME = new MIMEType('text/javascript');\nconsole.log(myMIME.type);\n// Prints: text\nmyMIME.type = 'application';\nconsole.log(myMIME.type);\n// Prints: application\nconsole.log(String(myMIME));\n// Prints: application/javascript\n</code></pre>\n<pre><code class=\"language-cjs\">const { MIMEType } = require('node:util');\n\nconst myMIME = new MIMEType('text/javascript');\nconsole.log(myMIME.type);\n// Prints: text\nmyMIME.type = 'application';\nconsole.log(myMIME.type);\n// Prints: application\nconsole.log(String(myMIME));\n// Prints: application/javascript\n</code></pre>"
            },
            {
              "textRaw": "Type: {string}",
              "name": "subtype",
              "type": "string",
              "desc": "<p>Gets and sets the subtype portion of the MIME.</p>\n<pre><code class=\"language-mjs\">import { MIMEType } from 'node:util';\n\nconst myMIME = new MIMEType('text/ecmascript');\nconsole.log(myMIME.subtype);\n// Prints: ecmascript\nmyMIME.subtype = 'javascript';\nconsole.log(myMIME.subtype);\n// Prints: javascript\nconsole.log(String(myMIME));\n// Prints: text/javascript\n</code></pre>\n<pre><code class=\"language-cjs\">const { MIMEType } = require('node:util');\n\nconst myMIME = new MIMEType('text/ecmascript');\nconsole.log(myMIME.subtype);\n// Prints: ecmascript\nmyMIME.subtype = 'javascript';\nconsole.log(myMIME.subtype);\n// Prints: javascript\nconsole.log(String(myMIME));\n// Prints: text/javascript\n</code></pre>"
            },
            {
              "textRaw": "Type: {string}",
              "name": "essence",
              "type": "string",
              "desc": "<p>Gets the essence of the MIME. This property is read only.\nUse <code>mime.type</code> or <code>mime.subtype</code> to alter the MIME.</p>\n<pre><code class=\"language-mjs\">import { MIMEType } from 'node:util';\n\nconst myMIME = new MIMEType('text/javascript;key=value');\nconsole.log(myMIME.essence);\n// Prints: text/javascript\nmyMIME.type = 'application';\nconsole.log(myMIME.essence);\n// Prints: application/javascript\nconsole.log(String(myMIME));\n// Prints: application/javascript;key=value\n</code></pre>\n<pre><code class=\"language-cjs\">const { MIMEType } = require('node:util');\n\nconst myMIME = new MIMEType('text/javascript;key=value');\nconsole.log(myMIME.essence);\n// Prints: text/javascript\nmyMIME.type = 'application';\nconsole.log(myMIME.essence);\n// Prints: application/javascript\nconsole.log(String(myMIME));\n// Prints: application/javascript;key=value\n</code></pre>"
            },
            {
              "textRaw": "Type: {MIMEParams}",
              "name": "params",
              "type": "MIMEParams",
              "desc": "<p>Gets the <a href=\"#class-utilmimeparams\"><code>MIMEParams</code></a> object representing the\nparameters of the MIME. This property is read-only. See\n<a href=\"#class-utilmimeparams\"><code>MIMEParams</code></a> documentation for details.</p>"
            }
          ],
          "methods": [
            {
              "textRaw": "`mime.toString()`",
              "name": "toString",
              "type": "method",
              "signatures": [
                {
                  "params": [],
                  "return": {
                    "textRaw": "Returns: {string}",
                    "name": "return",
                    "type": "string"
                  }
                }
              ],
              "desc": "<p>The <code>toString()</code> method on the <code>MIMEType</code> object returns the serialized MIME.</p>\n<p>Because of the need for standard compliance, this method does not allow users\nto customize the serialization process of the MIME.</p>"
            },
            {
              "textRaw": "`mime.toJSON()`",
              "name": "toJSON",
              "type": "method",
              "signatures": [
                {
                  "params": [],
                  "return": {
                    "textRaw": "Returns: {string}",
                    "name": "return",
                    "type": "string"
                  }
                }
              ],
              "desc": "<p>Alias for <a href=\"#mimetostring\"><code>mime.toString()</code></a>.</p>\n<p>This method is automatically called when an <code>MIMEType</code> object is serialized\nwith <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify\"><code>JSON.stringify()</code></a>.</p>\n<pre><code class=\"language-mjs\">import { MIMEType } from 'node:util';\n\nconst myMIMES = [\n  new MIMEType('image/png'),\n  new MIMEType('image/gif'),\n];\nconsole.log(JSON.stringify(myMIMES));\n// Prints: [\"image/png\", \"image/gif\"]\n</code></pre>\n<pre><code class=\"language-cjs\">const { MIMEType } = require('node:util');\n\nconst myMIMES = [\n  new MIMEType('image/png'),\n  new MIMEType('image/gif'),\n];\nconsole.log(JSON.stringify(myMIMES));\n// Prints: [\"image/png\", \"image/gif\"]\n</code></pre>"
            }
          ]
        },
        {
          "textRaw": "Class: `util.MIMEParams`",
          "name": "util.MIMEParams",
          "type": "class",
          "meta": {
            "added": [
              "v19.1.0",
              "v18.13.0"
            ],
            "changes": []
          },
          "desc": "<p>The <code>MIMEParams</code> API provides read and write access to the parameters of a\n<code>MIMEType</code>.</p>",
          "signatures": [
            {
              "textRaw": "`new MIMEParams()`",
              "name": "MIMEParams",
              "type": "ctor",
              "params": [],
              "desc": "<p>Creates a new <code>MIMEParams</code> object by with empty parameters</p>\n<pre><code class=\"language-mjs\">import { MIMEParams } from 'node:util';\n\nconst myParams = new MIMEParams();\n</code></pre>\n<pre><code class=\"language-cjs\">const { MIMEParams } = require('node:util');\n\nconst myParams = new MIMEParams();\n</code></pre>"
            }
          ],
          "methods": [
            {
              "textRaw": "`mimeParams.delete(name)`",
              "name": "delete",
              "type": "method",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`name` {string}",
                      "name": "name",
                      "type": "string"
                    }
                  ]
                }
              ],
              "desc": "<p>Remove all name-value pairs whose name is <code>name</code>.</p>"
            },
            {
              "textRaw": "`mimeParams.entries()`",
              "name": "entries",
              "type": "method",
              "signatures": [
                {
                  "params": [],
                  "return": {
                    "textRaw": "Returns: {Iterator}",
                    "name": "return",
                    "type": "Iterator"
                  }
                }
              ],
              "desc": "<p>Returns an iterator over each of the name-value pairs in the parameters.\nEach item of the iterator is a JavaScript <code>Array</code>. The first item of the array\nis the <code>name</code>, the second item of the array is the <code>value</code>.</p>"
            },
            {
              "textRaw": "`mimeParams.get(name)`",
              "name": "get",
              "type": "method",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`name` {string}",
                      "name": "name",
                      "type": "string"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {string|null} A string or `null` if there is no name-value pair with the given `name`.",
                    "name": "return",
                    "type": "string|null",
                    "desc": "A string or `null` if there is no name-value pair with the given `name`."
                  }
                }
              ],
              "desc": "<p>Returns the value of the first name-value pair whose name is <code>name</code>. If there\nare no such pairs, <code>null</code> is returned.</p>"
            },
            {
              "textRaw": "`mimeParams.has(name)`",
              "name": "has",
              "type": "method",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`name` {string}",
                      "name": "name",
                      "type": "string"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if there is at least one name-value pair whose name is <code>name</code>.</p>"
            },
            {
              "textRaw": "`mimeParams.keys()`",
              "name": "keys",
              "type": "method",
              "signatures": [
                {
                  "params": [],
                  "return": {
                    "textRaw": "Returns: {Iterator}",
                    "name": "return",
                    "type": "Iterator"
                  }
                }
              ],
              "desc": "<p>Returns an iterator over the names of each name-value pair.</p>\n<pre><code class=\"language-mjs\">import { MIMEType } from 'node:util';\n\nconst { params } = new MIMEType('text/plain;foo=0;bar=1');\nfor (const name of params.keys()) {\n  console.log(name);\n}\n// Prints:\n//   foo\n//   bar\n</code></pre>\n<pre><code class=\"language-cjs\">const { MIMEType } = require('node:util');\n\nconst { params } = new MIMEType('text/plain;foo=0;bar=1');\nfor (const name of params.keys()) {\n  console.log(name);\n}\n// Prints:\n//   foo\n//   bar\n</code></pre>"
            },
            {
              "textRaw": "`mimeParams.set(name, value)`",
              "name": "set",
              "type": "method",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`name` {string}",
                      "name": "name",
                      "type": "string"
                    },
                    {
                      "textRaw": "`value` {string}",
                      "name": "value",
                      "type": "string"
                    }
                  ]
                }
              ],
              "desc": "<p>Sets the value in the <code>MIMEParams</code> object associated with <code>name</code> to\n<code>value</code>. If there are any pre-existing name-value pairs whose names are <code>name</code>,\nset the first such pair's value to <code>value</code>.</p>\n<pre><code class=\"language-mjs\">import { MIMEType } from 'node:util';\n\nconst { params } = new MIMEType('text/plain;foo=0;bar=1');\nparams.set('foo', 'def');\nparams.set('baz', 'xyz');\nconsole.log(params.toString());\n// Prints: foo=def;bar=1;baz=xyz\n</code></pre>\n<pre><code class=\"language-cjs\">const { MIMEType } = require('node:util');\n\nconst { params } = new MIMEType('text/plain;foo=0;bar=1');\nparams.set('foo', 'def');\nparams.set('baz', 'xyz');\nconsole.log(params.toString());\n// Prints: foo=def;bar=1;baz=xyz\n</code></pre>"
            },
            {
              "textRaw": "`mimeParams.values()`",
              "name": "values",
              "type": "method",
              "signatures": [
                {
                  "params": [],
                  "return": {
                    "textRaw": "Returns: {Iterator}",
                    "name": "return",
                    "type": "Iterator"
                  }
                }
              ],
              "desc": "<p>Returns an iterator over the values of each name-value pair.</p>"
            },
            {
              "textRaw": "`mimeParams[Symbol.iterator]()`",
              "name": "[Symbol.iterator]",
              "type": "method",
              "signatures": [
                {
                  "params": [],
                  "return": {
                    "textRaw": "Returns: {Iterator}",
                    "name": "return",
                    "type": "Iterator"
                  }
                }
              ],
              "desc": "<p>Alias for <a href=\"#mimeparamsentries\"><code>mimeParams.entries()</code></a>.</p>\n<pre><code class=\"language-mjs\">import { MIMEType } from 'node:util';\n\nconst { params } = new MIMEType('text/plain;foo=bar;xyz=baz');\nfor (const [name, value] of params) {\n  console.log(name, value);\n}\n// Prints:\n//   foo bar\n//   xyz baz\n</code></pre>\n<pre><code class=\"language-cjs\">const { MIMEType } = require('node:util');\n\nconst { params } = new MIMEType('text/plain;foo=bar;xyz=baz');\nfor (const [name, value] of params) {\n  console.log(name, value);\n}\n// Prints:\n//   foo bar\n//   xyz baz\n</code></pre>"
            }
          ]
        },
        {
          "textRaw": "Class: `util.TextDecoder`",
          "name": "util.TextDecoder",
          "type": "class",
          "meta": {
            "added": [
              "v8.3.0"
            ],
            "changes": [
              {
                "version": "v11.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/22281",
                "description": "The class is now available on the global object."
              }
            ]
          },
          "desc": "<p>An implementation of the <a href=\"https://encoding.spec.whatwg.org/\">WHATWG Encoding Standard</a> <code>TextDecoder</code> API.</p>\n<pre><code class=\"language-js\">const decoder = new TextDecoder();\nconst u8arr = new Uint8Array([72, 101, 108, 108, 111]);\nconsole.log(decoder.decode(u8arr)); // Hello\n</code></pre>",
          "modules": [
            {
              "textRaw": "WHATWG supported encodings",
              "name": "whatwg_supported_encodings",
              "type": "module",
              "desc": "<p>Per the <a href=\"https://encoding.spec.whatwg.org/\">WHATWG Encoding Standard</a>, the encodings supported by the\n<code>TextDecoder</code> API are outlined in the tables below. For each encoding,\none or more aliases may be used.</p>\n<p>Different Node.js build configurations support different sets of encodings.\n(see <a href=\"intl.html\">Internationalization</a>)</p>",
              "modules": [
                {
                  "textRaw": "Encodings supported by default (with full ICU data)",
                  "name": "encodings_supported_by_default_(with_full_icu_data)",
                  "type": "module",
                  "desc": "<table>\n<thead>\n<tr>\n<th>Encoding</th>\n<th>Aliases</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>'ibm866'</code></td>\n<td><code>'866'</code>, <code>'cp866'</code>, <code>'csibm866'</code></td>\n</tr>\n<tr>\n<td><code>'iso-8859-2'</code></td>\n<td><code>'csisolatin2'</code>, <code>'iso-ir-101'</code>, <code>'iso8859-2'</code>, <code>'iso88592'</code>, <code>'iso_8859-2'</code>, <code>'iso_8859-2:1987'</code>, <code>'l2'</code>, <code>'latin2'</code></td>\n</tr>\n<tr>\n<td><code>'iso-8859-3'</code></td>\n<td><code>'csisolatin3'</code>, <code>'iso-ir-109'</code>, <code>'iso8859-3'</code>, <code>'iso88593'</code>, <code>'iso_8859-3'</code>, <code>'iso_8859-3:1988'</code>, <code>'l3'</code>, <code>'latin3'</code></td>\n</tr>\n<tr>\n<td><code>'iso-8859-4'</code></td>\n<td><code>'csisolatin4'</code>, <code>'iso-ir-110'</code>, <code>'iso8859-4'</code>, <code>'iso88594'</code>, <code>'iso_8859-4'</code>, <code>'iso_8859-4:1988'</code>, <code>'l4'</code>, <code>'latin4'</code></td>\n</tr>\n<tr>\n<td><code>'iso-8859-5'</code></td>\n<td><code>'csisolatincyrillic'</code>, <code>'cyrillic'</code>, <code>'iso-ir-144'</code>, <code>'iso8859-5'</code>, <code>'iso88595'</code>, <code>'iso_8859-5'</code>, <code>'iso_8859-5:1988'</code></td>\n</tr>\n<tr>\n<td><code>'iso-8859-6'</code></td>\n<td><code>'arabic'</code>, <code>'asmo-708'</code>, <code>'csiso88596e'</code>, <code>'csiso88596i'</code>, <code>'csisolatinarabic'</code>, <code>'ecma-114'</code>, <code>'iso-8859-6-e'</code>, <code>'iso-8859-6-i'</code>, <code>'iso-ir-127'</code>, <code>'iso8859-6'</code>, <code>'iso88596'</code>, <code>'iso_8859-6'</code>, <code>'iso_8859-6:1987'</code></td>\n</tr>\n<tr>\n<td><code>'iso-8859-7'</code></td>\n<td><code>'csisolatingreek'</code>, <code>'ecma-118'</code>, <code>'elot_928'</code>, <code>'greek'</code>, <code>'greek8'</code>, <code>'iso-ir-126'</code>, <code>'iso8859-7'</code>, <code>'iso88597'</code>, <code>'iso_8859-7'</code>, <code>'iso_8859-7:1987'</code>, <code>'sun_eu_greek'</code></td>\n</tr>\n<tr>\n<td><code>'iso-8859-8'</code></td>\n<td><code>'csiso88598e'</code>, <code>'csisolatinhebrew'</code>, <code>'hebrew'</code>, <code>'iso-8859-8-e'</code>, <code>'iso-ir-138'</code>, <code>'iso8859-8'</code>, <code>'iso88598'</code>, <code>'iso_8859-8'</code>, <code>'iso_8859-8:1988'</code>, <code>'visual'</code></td>\n</tr>\n<tr>\n<td><code>'iso-8859-8-i'</code></td>\n<td><code>'csiso88598i'</code>, <code>'logical'</code></td>\n</tr>\n<tr>\n<td><code>'iso-8859-10'</code></td>\n<td><code>'csisolatin6'</code>, <code>'iso-ir-157'</code>, <code>'iso8859-10'</code>, <code>'iso885910'</code>, <code>'l6'</code>, <code>'latin6'</code></td>\n</tr>\n<tr>\n<td><code>'iso-8859-13'</code></td>\n<td><code>'iso8859-13'</code>, <code>'iso885913'</code></td>\n</tr>\n<tr>\n<td><code>'iso-8859-14'</code></td>\n<td><code>'iso8859-14'</code>, <code>'iso885914'</code></td>\n</tr>\n<tr>\n<td><code>'iso-8859-15'</code></td>\n<td><code>'csisolatin9'</code>, <code>'iso8859-15'</code>, <code>'iso885915'</code>, <code>'iso_8859-15'</code>, <code>'l9'</code></td>\n</tr>\n<tr>\n<td><code>'koi8-r'</code></td>\n<td><code>'cskoi8r'</code>, <code>'koi'</code>, <code>'koi8'</code>, <code>'koi8_r'</code></td>\n</tr>\n<tr>\n<td><code>'koi8-u'</code></td>\n<td><code>'koi8-ru'</code></td>\n</tr>\n<tr>\n<td><code>'macintosh'</code></td>\n<td><code>'csmacintosh'</code>, <code>'mac'</code>, <code>'x-mac-roman'</code></td>\n</tr>\n<tr>\n<td><code>'windows-874'</code></td>\n<td><code>'dos-874'</code>, <code>'iso-8859-11'</code>, <code>'iso8859-11'</code>, <code>'iso885911'</code>, <code>'tis-620'</code></td>\n</tr>\n<tr>\n<td><code>'windows-1250'</code></td>\n<td><code>'cp1250'</code>, <code>'x-cp1250'</code></td>\n</tr>\n<tr>\n<td><code>'windows-1251'</code></td>\n<td><code>'cp1251'</code>, <code>'x-cp1251'</code></td>\n</tr>\n<tr>\n<td><code>'windows-1252'</code></td>\n<td><code>'ansi_x3.4-1968'</code>, <code>'ascii'</code>, <code>'cp1252'</code>, <code>'cp819'</code>, <code>'csisolatin1'</code>, <code>'ibm819'</code>, <code>'iso-8859-1'</code>, <code>'iso-ir-100'</code>, <code>'iso8859-1'</code>, <code>'iso88591'</code>, <code>'iso_8859-1'</code>, <code>'iso_8859-1:1987'</code>, <code>'l1'</code>, <code>'latin1'</code>, <code>'us-ascii'</code>, <code>'x-cp1252'</code></td>\n</tr>\n<tr>\n<td><code>'windows-1253'</code></td>\n<td><code>'cp1253'</code>, <code>'x-cp1253'</code></td>\n</tr>\n<tr>\n<td><code>'windows-1254'</code></td>\n<td><code>'cp1254'</code>, <code>'csisolatin5'</code>, <code>'iso-8859-9'</code>, <code>'iso-ir-148'</code>, <code>'iso8859-9'</code>, <code>'iso88599'</code>, <code>'iso_8859-9'</code>, <code>'iso_8859-9:1989'</code>, <code>'l5'</code>, <code>'latin5'</code>, <code>'x-cp1254'</code></td>\n</tr>\n<tr>\n<td><code>'windows-1255'</code></td>\n<td><code>'cp1255'</code>, <code>'x-cp1255'</code></td>\n</tr>\n<tr>\n<td><code>'windows-1256'</code></td>\n<td><code>'cp1256'</code>, <code>'x-cp1256'</code></td>\n</tr>\n<tr>\n<td><code>'windows-1257'</code></td>\n<td><code>'cp1257'</code>, <code>'x-cp1257'</code></td>\n</tr>\n<tr>\n<td><code>'windows-1258'</code></td>\n<td><code>'cp1258'</code>, <code>'x-cp1258'</code></td>\n</tr>\n<tr>\n<td><code>'x-mac-cyrillic'</code></td>\n<td><code>'x-mac-ukrainian'</code></td>\n</tr>\n<tr>\n<td><code>'gbk'</code></td>\n<td><code>'chinese'</code>, <code>'csgb2312'</code>, <code>'csiso58gb231280'</code>, <code>'gb2312'</code>, <code>'gb_2312'</code>, <code>'gb_2312-80'</code>, <code>'iso-ir-58'</code>, <code>'x-gbk'</code></td>\n</tr>\n<tr>\n<td><code>'gb18030'</code></td>\n<td></td>\n</tr>\n<tr>\n<td><code>'big5'</code></td>\n<td><code>'big5-hkscs'</code>, <code>'cn-big5'</code>, <code>'csbig5'</code>, <code>'x-x-big5'</code></td>\n</tr>\n<tr>\n<td><code>'euc-jp'</code></td>\n<td><code>'cseucpkdfmtjapanese'</code>, <code>'x-euc-jp'</code></td>\n</tr>\n<tr>\n<td><code>'iso-2022-jp'</code></td>\n<td><code>'csiso2022jp'</code></td>\n</tr>\n<tr>\n<td><code>'shift_jis'</code></td>\n<td><code>'csshiftjis'</code>, <code>'ms932'</code>, <code>'ms_kanji'</code>, <code>'shift-jis'</code>, <code>'sjis'</code>, <code>'windows-31j'</code>, <code>'x-sjis'</code></td>\n</tr>\n<tr>\n<td><code>'euc-kr'</code></td>\n<td><code>'cseuckr'</code>, <code>'csksc56011987'</code>, <code>'iso-ir-149'</code>, <code>'korean'</code>, <code>'ks_c_5601-1987'</code>, <code>'ks_c_5601-1989'</code>, <code>'ksc5601'</code>, <code>'ksc_5601'</code>, <code>'windows-949'</code></td>\n</tr>\n</tbody>\n</table>",
                  "displayName": "Encodings supported by default (with full ICU data)"
                },
                {
                  "textRaw": "Encodings supported when Node.js is built with the `small-icu` option",
                  "name": "encodings_supported_when_node.js_is_built_with_the_`small-icu`_option",
                  "type": "module",
                  "desc": "<table>\n<thead>\n<tr>\n<th>Encoding</th>\n<th>Aliases</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>'utf-8'</code></td>\n<td><code>'unicode-1-1-utf-8'</code>, <code>'utf8'</code></td>\n</tr>\n<tr>\n<td><code>'utf-16le'</code></td>\n<td><code>'utf-16'</code></td>\n</tr>\n<tr>\n<td><code>'utf-16be'</code></td>\n<td></td>\n</tr>\n</tbody>\n</table>",
                  "displayName": "Encodings supported when Node.js is built with the `small-icu` option"
                },
                {
                  "textRaw": "Encodings supported when ICU is disabled",
                  "name": "encodings_supported_when_icu_is_disabled",
                  "type": "module",
                  "desc": "<table>\n<thead>\n<tr>\n<th>Encoding</th>\n<th>Aliases</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>'utf-8'</code></td>\n<td><code>'unicode-1-1-utf-8'</code>, <code>'utf8'</code></td>\n</tr>\n<tr>\n<td><code>'utf-16le'</code></td>\n<td><code>'utf-16'</code></td>\n</tr>\n</tbody>\n</table>\n<p>The <code>'iso-8859-16'</code> encoding listed in the <a href=\"https://encoding.spec.whatwg.org/\">WHATWG Encoding Standard</a>\nis not supported.</p>",
                  "displayName": "Encodings supported when ICU is disabled"
                }
              ],
              "displayName": "WHATWG supported encodings"
            }
          ],
          "signatures": [
            {
              "textRaw": "`new TextDecoder([encoding[, options]])`",
              "name": "TextDecoder",
              "type": "ctor",
              "params": [
                {
                  "textRaw": "`encoding` {string} Identifies the `encoding` that this `TextDecoder` instance supports. **Default:** `'utf-8'`.",
                  "name": "encoding",
                  "type": "string",
                  "default": "`'utf-8'`",
                  "desc": "Identifies the `encoding` that this `TextDecoder` instance supports.",
                  "optional": true
                },
                {
                  "textRaw": "`options` {Object}",
                  "name": "options",
                  "type": "Object",
                  "options": [
                    {
                      "textRaw": "`fatal` {boolean} `true` if decoding failures are fatal. This option is not supported when ICU is disabled (see Internationalization). **Default:** `false`.",
                      "name": "fatal",
                      "type": "boolean",
                      "default": "`false`",
                      "desc": "`true` if decoding failures are fatal. This option is not supported when ICU is disabled (see Internationalization)."
                    },
                    {
                      "textRaw": "`ignoreBOM` {boolean} When `true`, the `TextDecoder` will include the byte order mark in the decoded result. When `false`, the byte order mark will be removed from the output. This option is only used when `encoding` is `'utf-8'`, `'utf-16be'`, or `'utf-16le'`. **Default:** `false`.",
                      "name": "ignoreBOM",
                      "type": "boolean",
                      "default": "`false`",
                      "desc": "When `true`, the `TextDecoder` will include the byte order mark in the decoded result. When `false`, the byte order mark will be removed from the output. This option is only used when `encoding` is `'utf-8'`, `'utf-16be'`, or `'utf-16le'`."
                    }
                  ],
                  "optional": true
                }
              ],
              "desc": "<p>Creates a new <code>TextDecoder</code> instance. The <code>encoding</code> may specify one of the\nsupported encodings or an alias.</p>\n<p>The <code>TextDecoder</code> class is also available on the global object.</p>"
            }
          ],
          "methods": [
            {
              "textRaw": "`textDecoder.decode([input[, options]])`",
              "name": "decode",
              "type": "method",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`input` {ArrayBuffer|DataView|TypedArray} An `ArrayBuffer`, `DataView`, or `TypedArray` instance containing the encoded data.",
                      "name": "input",
                      "type": "ArrayBuffer|DataView|TypedArray",
                      "desc": "An `ArrayBuffer`, `DataView`, or `TypedArray` instance containing the encoded data.",
                      "optional": true
                    },
                    {
                      "textRaw": "`options` {Object}",
                      "name": "options",
                      "type": "Object",
                      "options": [
                        {
                          "textRaw": "`stream` {boolean} `true` if additional chunks of data are expected. **Default:** `false`.",
                          "name": "stream",
                          "type": "boolean",
                          "default": "`false`",
                          "desc": "`true` if additional chunks of data are expected."
                        }
                      ],
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {string}",
                    "name": "return",
                    "type": "string"
                  }
                }
              ],
              "desc": "<p>Decodes the <code>input</code> and returns a string. If <code>options.stream</code> is <code>true</code>, any\nincomplete byte sequences occurring at the end of the <code>input</code> are buffered\ninternally and emitted after the next call to <code>textDecoder.decode()</code>.</p>\n<p>If <code>textDecoder.fatal</code> is <code>true</code>, decoding errors that occur will result in a\n<code>TypeError</code> being thrown.</p>"
            }
          ],
          "properties": [
            {
              "textRaw": "Type: {string}",
              "name": "encoding",
              "type": "string",
              "desc": "<p>The encoding supported by the <code>TextDecoder</code> instance.</p>"
            },
            {
              "textRaw": "Type: {boolean}",
              "name": "fatal",
              "type": "boolean",
              "desc": "<p>The value will be <code>true</code> if decoding errors result in a <code>TypeError</code> being\nthrown.</p>"
            },
            {
              "textRaw": "Type: {boolean}",
              "name": "ignoreBOM",
              "type": "boolean",
              "desc": "<p>The value will be <code>true</code> if the decoding result will include the byte order\nmark.</p>"
            }
          ]
        },
        {
          "textRaw": "Class: `util.TextEncoder`",
          "name": "util.TextEncoder",
          "type": "class",
          "meta": {
            "added": [
              "v8.3.0"
            ],
            "changes": [
              {
                "version": "v11.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/22281",
                "description": "The class is now available on the global object."
              }
            ]
          },
          "desc": "<p>An implementation of the <a href=\"https://encoding.spec.whatwg.org/\">WHATWG Encoding Standard</a> <code>TextEncoder</code> API. All\ninstances of <code>TextEncoder</code> only support UTF-8 encoding.</p>\n<pre><code class=\"language-js\">const encoder = new TextEncoder();\nconst uint8array = encoder.encode('this is some data');\n</code></pre>\n<p>The <code>TextEncoder</code> class is also available on the global object.</p>",
          "methods": [
            {
              "textRaw": "`textEncoder.encode([input])`",
              "name": "encode",
              "type": "method",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`input` {string} The text to encode. **Default:** an empty string.",
                      "name": "input",
                      "type": "string",
                      "default": "an empty string",
                      "desc": "The text to encode.",
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {Uint8Array}",
                    "name": "return",
                    "type": "Uint8Array"
                  }
                }
              ],
              "desc": "<p>UTF-8 encodes the <code>input</code> string and returns a <code>Uint8Array</code> containing the\nencoded bytes.</p>"
            },
            {
              "textRaw": "`textEncoder.encodeInto(src, dest)`",
              "name": "encodeInto",
              "type": "method",
              "meta": {
                "added": [
                  "v12.11.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`src` {string} The text to encode.",
                      "name": "src",
                      "type": "string",
                      "desc": "The text to encode."
                    },
                    {
                      "textRaw": "`dest` {Uint8Array} The array to hold the encode result.",
                      "name": "dest",
                      "type": "Uint8Array",
                      "desc": "The array to hold the encode result."
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {Object}",
                    "name": "return",
                    "type": "Object",
                    "options": [
                      {
                        "textRaw": "`read` {number} The read Unicode code units of src.",
                        "name": "read",
                        "type": "number",
                        "desc": "The read Unicode code units of src."
                      },
                      {
                        "textRaw": "`written` {number} The written UTF-8 bytes of dest.",
                        "name": "written",
                        "type": "number",
                        "desc": "The written UTF-8 bytes of dest."
                      }
                    ]
                  }
                }
              ],
              "desc": "<p>UTF-8 encodes the <code>src</code> string to the <code>dest</code> Uint8Array and returns an object\ncontaining the read Unicode code units and written UTF-8 bytes.</p>\n<pre><code class=\"language-js\">const encoder = new TextEncoder();\nconst src = 'this is some data';\nconst dest = new Uint8Array(10);\nconst { read, written } = encoder.encodeInto(src, dest);\n</code></pre>"
            }
          ],
          "properties": [
            {
              "textRaw": "Type: {string}",
              "name": "encoding",
              "type": "string",
              "desc": "<p>The encoding supported by the <code>TextEncoder</code> instance. Always set to <code>'utf-8'</code>.</p>"
            }
          ]
        }
      ],
      "properties": [
        {
          "textRaw": "`util.types`",
          "name": "types",
          "type": "property",
          "meta": {
            "added": [
              "v10.0.0"
            ],
            "changes": [
              {
                "version": "v15.3.0",
                "pr-url": "https://github.com/nodejs/node/pull/34055",
                "description": "Exposed as `require('util/types')`."
              }
            ]
          },
          "desc": "<p><code>util.types</code> provides type checks for different kinds of built-in objects.\nUnlike <code>instanceof</code> or <code>Object.prototype.toString.call(value)</code>, these checks do\nnot inspect properties of the object that are accessible from JavaScript (like\ntheir prototype), and usually have the overhead of calling into C++.</p>\n<p>The result generally does not make any guarantees about what kinds of\nproperties or behavior a value exposes in JavaScript. They are primarily\nuseful for addon developers who prefer to do type checking in JavaScript.</p>\n<p>The API is accessible via <code>require('node:util').types</code> or <code>require('node:util/types')</code>.</p>",
          "methods": [
            {
              "textRaw": "`util.types.isAnyArrayBuffer(value)`",
              "name": "isAnyArrayBuffer",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a built-in <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\"><code>&#x3C;ArrayBuffer></code></a> or\n<a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer\"><code>&#x3C;SharedArrayBuffer></code></a> instance.</p>\n<p>See also <a href=\"#utiltypesisarraybuffervalue\"><code>util.types.isArrayBuffer()</code></a> and\n<a href=\"#utiltypesissharedarraybuffervalue\"><code>util.types.isSharedArrayBuffer()</code></a>.</p>\n<pre><code class=\"language-js\">util.types.isAnyArrayBuffer(new ArrayBuffer());  // Returns true\nutil.types.isAnyArrayBuffer(new SharedArrayBuffer());  // Returns true\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isArrayBufferView(value)`",
              "name": "isArrayBufferView",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is an instance of one of the <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\"><code>&#x3C;ArrayBuffer></code></a>\nviews, such as typed array objects or <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/DataView\"><code>&#x3C;DataView></code></a>. Equivalent to <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/isView\"><code>ArrayBuffer.isView()</code></a>.</p>\n<pre><code class=\"language-js\">util.types.isArrayBufferView(new Int8Array());  // true\nutil.types.isArrayBufferView(Buffer.from('hello world')); // true\nutil.types.isArrayBufferView(new DataView(new ArrayBuffer(16)));  // true\nutil.types.isArrayBufferView(new ArrayBuffer());  // false\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isArgumentsObject(value)`",
              "name": "isArgumentsObject",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is an <code>arguments</code> object.</p>\n<pre><code class=\"language-js\">function foo() {\n  util.types.isArgumentsObject(arguments);  // Returns true\n}\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isArrayBuffer(value)`",
              "name": "isArrayBuffer",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a built-in <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\"><code>&#x3C;ArrayBuffer></code></a> instance.\nThis does <em>not</em> include <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer\"><code>&#x3C;SharedArrayBuffer></code></a> instances. Usually, it is\ndesirable to test for both; See <a href=\"#utiltypesisanyarraybuffervalue\"><code>util.types.isAnyArrayBuffer()</code></a> for that.</p>\n<pre><code class=\"language-js\">util.types.isArrayBuffer(new ArrayBuffer());  // Returns true\nutil.types.isArrayBuffer(new SharedArrayBuffer());  // Returns false\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isAsyncFunction(value)`",
              "name": "isAsyncFunction",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is an <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function\">async function</a>.\nThis only reports back what the JavaScript engine is seeing;\nin particular, the return value may not match the original source code if\na transpilation tool was used.</p>\n<pre><code class=\"language-js\">util.types.isAsyncFunction(function foo() {});  // Returns false\nutil.types.isAsyncFunction(async function foo() {});  // Returns true\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isBigInt64Array(value)`",
              "name": "isBigInt64Array",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a <code>BigInt64Array</code> instance.</p>\n<pre><code class=\"language-js\">util.types.isBigInt64Array(new BigInt64Array());   // Returns true\nutil.types.isBigInt64Array(new BigUint64Array());  // Returns false\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isBigIntObject(value)`",
              "name": "isBigIntObject",
              "type": "method",
              "meta": {
                "added": [
                  "v10.4.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a BigInt object, e.g. created\nby <code>Object(BigInt(123))</code>.</p>\n<pre><code class=\"language-js\">util.types.isBigIntObject(Object(BigInt(123)));   // Returns true\nutil.types.isBigIntObject(BigInt(123));   // Returns false\nutil.types.isBigIntObject(123);  // Returns false\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isBigUint64Array(value)`",
              "name": "isBigUint64Array",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a <code>BigUint64Array</code> instance.</p>\n<pre><code class=\"language-js\">util.types.isBigUint64Array(new BigInt64Array());   // Returns false\nutil.types.isBigUint64Array(new BigUint64Array());  // Returns true\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isBooleanObject(value)`",
              "name": "isBooleanObject",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a boolean object, e.g. created\nby <code>new Boolean()</code>.</p>\n<pre><code class=\"language-js\">util.types.isBooleanObject(false);  // Returns false\nutil.types.isBooleanObject(true);   // Returns false\nutil.types.isBooleanObject(new Boolean(false)); // Returns true\nutil.types.isBooleanObject(new Boolean(true));  // Returns true\nutil.types.isBooleanObject(Boolean(false)); // Returns false\nutil.types.isBooleanObject(Boolean(true));  // Returns false\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isBoxedPrimitive(value)`",
              "name": "isBoxedPrimitive",
              "type": "method",
              "meta": {
                "added": [
                  "v10.11.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is any boxed primitive object, e.g. created\nby <code>new Boolean()</code>, <code>new String()</code> or <code>Object(Symbol())</code>.</p>\n<p>For example:</p>\n<pre><code class=\"language-js\">util.types.isBoxedPrimitive(false); // Returns false\nutil.types.isBoxedPrimitive(new Boolean(false)); // Returns true\nutil.types.isBoxedPrimitive(Symbol('foo')); // Returns false\nutil.types.isBoxedPrimitive(Object(Symbol('foo'))); // Returns true\nutil.types.isBoxedPrimitive(Object(BigInt(5))); // Returns true\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isCryptoKey(value)`",
              "name": "isCryptoKey",
              "type": "method",
              "meta": {
                "added": [
                  "v16.2.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {Object}",
                      "name": "value",
                      "type": "Object"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if <code>value</code> is a <a href=\"webcrypto.html#class-cryptokey\"><code>&#x3C;CryptoKey></code></a>, <code>false</code> otherwise.</p>"
            },
            {
              "textRaw": "`util.types.isDataView(value)`",
              "name": "isDataView",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a built-in <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/DataView\"><code>&#x3C;DataView></code></a> instance.</p>\n<pre><code class=\"language-js\">const ab = new ArrayBuffer(20);\nutil.types.isDataView(new DataView(ab));  // Returns true\nutil.types.isDataView(new Float64Array());  // Returns false\n</code></pre>\n<p>See also <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/isView\"><code>ArrayBuffer.isView()</code></a>.</p>"
            },
            {
              "textRaw": "`util.types.isDate(value)`",
              "name": "isDate",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a built-in <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date\"><code>&#x3C;Date></code></a> instance.</p>\n<pre><code class=\"language-js\">util.types.isDate(new Date());  // Returns true\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isExternal(value)`",
              "name": "isExternal",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a native <code>External</code> value.</p>\n<p>A native <code>External</code> value is a special type of object that contains a\nraw C++ pointer (<code>void*</code>) for access from native code, and has no other\nproperties. Such objects are created either by Node.js internals or native\naddons. In JavaScript, they are <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/freeze\">frozen</a> objects with a\n<code>null</code> prototype.</p>\n<pre><code class=\"language-c\">#include &#x3C;js_native_api.h>\n#include &#x3C;stdlib.h>\nnapi_value result;\nstatic napi_value MyNapi(napi_env env, napi_callback_info info) {\n  int* raw = (int*) malloc(1024);\n  napi_status status = napi_create_external(env, (void*) raw, NULL, NULL, &#x26;result);\n  if (status != napi_ok) {\n    napi_throw_error(env, NULL, \"napi_create_external failed\");\n    return NULL;\n  }\n  return result;\n}\n...\nDECLARE_NAPI_PROPERTY(\"myNapi\", MyNapi)\n...\n</code></pre>\n<pre><code class=\"language-mjs\">import native from 'napi_addon.node';\nimport { types } from 'node:util';\n\nconst data = native.myNapi();\ntypes.isExternal(data); // returns true\ntypes.isExternal(0); // returns false\ntypes.isExternal(new String('foo')); // returns false\n</code></pre>\n<pre><code class=\"language-cjs\">const native = require('napi_addon.node');\nconst { types } = require('node:util');\n\nconst data = native.myNapi();\ntypes.isExternal(data); // returns true\ntypes.isExternal(0); // returns false\ntypes.isExternal(new String('foo')); // returns false\n</code></pre>\n<p>For further information on <code>napi_create_external</code>, refer to\n<a href=\"n-api.html#napi_create_external\"><code>napi_create_external()</code></a>.</p>"
            },
            {
              "textRaw": "`util.types.isFloat16Array(value)`",
              "name": "isFloat16Array",
              "type": "method",
              "meta": {
                "added": [
                  "v24.0.0",
                  "v22.16.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a built-in <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Float16Array\"><code>&#x3C;Float16Array></code></a> instance.</p>\n<pre><code class=\"language-js\">util.types.isFloat16Array(new ArrayBuffer());  // Returns false\nutil.types.isFloat16Array(new Float16Array());  // Returns true\nutil.types.isFloat16Array(new Float32Array());  // Returns false\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isFloat32Array(value)`",
              "name": "isFloat32Array",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a built-in <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Float32Array\"><code>&#x3C;Float32Array></code></a> instance.</p>\n<pre><code class=\"language-js\">util.types.isFloat32Array(new ArrayBuffer());  // Returns false\nutil.types.isFloat32Array(new Float32Array());  // Returns true\nutil.types.isFloat32Array(new Float64Array());  // Returns false\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isFloat64Array(value)`",
              "name": "isFloat64Array",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a built-in <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Float64Array\"><code>&#x3C;Float64Array></code></a> instance.</p>\n<pre><code class=\"language-js\">util.types.isFloat64Array(new ArrayBuffer());  // Returns false\nutil.types.isFloat64Array(new Uint8Array());  // Returns false\nutil.types.isFloat64Array(new Float64Array());  // Returns true\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isGeneratorFunction(value)`",
              "name": "isGeneratorFunction",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a generator function.\nThis only reports back what the JavaScript engine is seeing;\nin particular, the return value may not match the original source code if\na transpilation tool was used.</p>\n<pre><code class=\"language-js\">util.types.isGeneratorFunction(function foo() {});  // Returns false\nutil.types.isGeneratorFunction(function* foo() {});  // Returns true\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isGeneratorObject(value)`",
              "name": "isGeneratorObject",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a generator object as returned from a\nbuilt-in generator function.\nThis only reports back what the JavaScript engine is seeing;\nin particular, the return value may not match the original source code if\na transpilation tool was used.</p>\n<pre><code class=\"language-js\">function* foo() {}\nconst generator = foo();\nutil.types.isGeneratorObject(generator);  // Returns true\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isInt8Array(value)`",
              "name": "isInt8Array",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a built-in <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Int8Array\"><code>&#x3C;Int8Array></code></a> instance.</p>\n<pre><code class=\"language-js\">util.types.isInt8Array(new ArrayBuffer());  // Returns false\nutil.types.isInt8Array(new Int8Array());  // Returns true\nutil.types.isInt8Array(new Float64Array());  // Returns false\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isInt16Array(value)`",
              "name": "isInt16Array",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a built-in <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Int16Array\"><code>&#x3C;Int16Array></code></a> instance.</p>\n<pre><code class=\"language-js\">util.types.isInt16Array(new ArrayBuffer());  // Returns false\nutil.types.isInt16Array(new Int16Array());  // Returns true\nutil.types.isInt16Array(new Float64Array());  // Returns false\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isInt32Array(value)`",
              "name": "isInt32Array",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a built-in <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Int32Array\"><code>&#x3C;Int32Array></code></a> instance.</p>\n<pre><code class=\"language-js\">util.types.isInt32Array(new ArrayBuffer());  // Returns false\nutil.types.isInt32Array(new Int32Array());  // Returns true\nutil.types.isInt32Array(new Float64Array());  // Returns false\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isKeyObject(value)`",
              "name": "isKeyObject",
              "type": "method",
              "meta": {
                "added": [
                  "v16.2.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {Object}",
                      "name": "value",
                      "type": "Object"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if <code>value</code> is a <a href=\"crypto.html#class-keyobject\"><code>&#x3C;KeyObject></code></a>, <code>false</code> otherwise.</p>"
            },
            {
              "textRaw": "`util.types.isMap(value)`",
              "name": "isMap",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a built-in <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map\"><code>&#x3C;Map></code></a> instance.</p>\n<pre><code class=\"language-js\">util.types.isMap(new Map());  // Returns true\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isMapIterator(value)`",
              "name": "isMapIterator",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is an iterator returned for a built-in\n<a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map\"><code>&#x3C;Map></code></a> instance.</p>\n<pre><code class=\"language-js\">const map = new Map();\nutil.types.isMapIterator(map.keys());  // Returns true\nutil.types.isMapIterator(map.values());  // Returns true\nutil.types.isMapIterator(map.entries());  // Returns true\nutil.types.isMapIterator(map[Symbol.iterator]());  // Returns true\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isModuleNamespaceObject(value)`",
              "name": "isModuleNamespaceObject",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is an instance of a <a href=\"https://tc39.github.io/ecma262/#sec-module-namespace-exotic-objects\">Module Namespace Object</a>.</p>\n<pre><code class=\"language-mjs\">import * as ns from './a.js';\n\nutil.types.isModuleNamespaceObject(ns);  // Returns true\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isNativeError(value)`",
              "name": "isNativeError",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": [],
                "deprecated": [
                  "v24.2.0"
                ]
              },
              "stability": 0,
              "stabilityText": "Deprecated: Use `Error.isError` instead.",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p><strong>Note:</strong> As of Node.js 24, <code>Error.isError()</code> is currently slower than <code>util.types.isNativeError()</code>.\nIf performance is critical, consider benchmarking both in your environment.</p>\n<p>Returns <code>true</code> if the value was returned by the constructor of a\n<a href=\"https://tc39.es/ecma262/#sec-error-objects\">built-in <code>Error</code> type</a>.</p>\n<pre><code class=\"language-js\">console.log(util.types.isNativeError(new Error()));  // true\nconsole.log(util.types.isNativeError(new TypeError()));  // true\nconsole.log(util.types.isNativeError(new RangeError()));  // true\n</code></pre>\n<p>Subclasses of the native error types are also native errors:</p>\n<pre><code class=\"language-js\">class MyError extends Error {}\nconsole.log(util.types.isNativeError(new MyError()));  // true\n</code></pre>\n<p>A value being <code>instanceof</code> a native error class is not equivalent to <code>isNativeError()</code>\nreturning <code>true</code> for that value. <code>isNativeError()</code> returns <code>true</code> for errors\nwhich come from a different <a href=\"https://tc39.es/ecma262/#realm\">realm</a> while <code>instanceof Error</code> returns <code>false</code>\nfor these errors:</p>\n<pre><code class=\"language-mjs\">import { createContext, runInContext } from 'node:vm';\nimport { types } from 'node:util';\n\nconst context = createContext({});\nconst myError = runInContext('new Error()', context);\nconsole.log(types.isNativeError(myError)); // true\nconsole.log(myError instanceof Error); // false\n</code></pre>\n<pre><code class=\"language-cjs\">const { createContext, runInContext } = require('node:vm');\nconst { types } = require('node:util');\n\nconst context = createContext({});\nconst myError = runInContext('new Error()', context);\nconsole.log(types.isNativeError(myError)); // true\nconsole.log(myError instanceof Error); // false\n</code></pre>\n<p>Conversely, <code>isNativeError()</code> returns <code>false</code> for all objects which were not\nreturned by the constructor of a native error. That includes values\nwhich are <code>instanceof</code> native errors:</p>\n<pre><code class=\"language-js\">const myError = { __proto__: Error.prototype };\nconsole.log(util.types.isNativeError(myError)); // false\nconsole.log(myError instanceof Error); // true\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isNumberObject(value)`",
              "name": "isNumberObject",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a number object, e.g. created\nby <code>new Number()</code>.</p>\n<pre><code class=\"language-js\">util.types.isNumberObject(0);  // Returns false\nutil.types.isNumberObject(new Number(0));   // Returns true\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isPromise(value)`",
              "name": "isPromise",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a built-in <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise\"><code>&#x3C;Promise></code></a>.</p>\n<pre><code class=\"language-js\">util.types.isPromise(Promise.resolve(42));  // Returns true\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isProxy(value)`",
              "name": "isProxy",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Proxy\"><code>&#x3C;Proxy></code></a> instance.</p>\n<pre><code class=\"language-js\">const target = {};\nconst proxy = new Proxy(target, {});\nutil.types.isProxy(target);  // Returns false\nutil.types.isProxy(proxy);  // Returns true\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isRegExp(value)`",
              "name": "isRegExp",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a regular expression object.</p>\n<pre><code class=\"language-js\">util.types.isRegExp(/abc/);  // Returns true\nutil.types.isRegExp(new RegExp('abc'));  // Returns true\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isSet(value)`",
              "name": "isSet",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a built-in <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set\"><code>&#x3C;Set></code></a> instance.</p>\n<pre><code class=\"language-js\">util.types.isSet(new Set());  // Returns true\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isSetIterator(value)`",
              "name": "isSetIterator",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is an iterator returned for a built-in\n<a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set\"><code>&#x3C;Set></code></a> instance.</p>\n<pre><code class=\"language-js\">const set = new Set();\nutil.types.isSetIterator(set.keys());  // Returns true\nutil.types.isSetIterator(set.values());  // Returns true\nutil.types.isSetIterator(set.entries());  // Returns true\nutil.types.isSetIterator(set[Symbol.iterator]());  // Returns true\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isSharedArrayBuffer(value)`",
              "name": "isSharedArrayBuffer",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a built-in <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer\"><code>&#x3C;SharedArrayBuffer></code></a> instance.\nThis does <em>not</em> include <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\"><code>&#x3C;ArrayBuffer></code></a> instances. Usually, it is\ndesirable to test for both; See <a href=\"#utiltypesisanyarraybuffervalue\"><code>util.types.isAnyArrayBuffer()</code></a> for that.</p>\n<pre><code class=\"language-js\">util.types.isSharedArrayBuffer(new ArrayBuffer());  // Returns false\nutil.types.isSharedArrayBuffer(new SharedArrayBuffer());  // Returns true\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isStringObject(value)`",
              "name": "isStringObject",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a string object, e.g. created\nby <code>new String()</code>.</p>\n<pre><code class=\"language-js\">util.types.isStringObject('foo');  // Returns false\nutil.types.isStringObject(new String('foo'));   // Returns true\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isSymbolObject(value)`",
              "name": "isSymbolObject",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a symbol object, created\nby calling <code>Object()</code> on a <code>Symbol</code> primitive.</p>\n<pre><code class=\"language-js\">const symbol = Symbol('foo');\nutil.types.isSymbolObject(symbol);  // Returns false\nutil.types.isSymbolObject(Object(symbol));   // Returns true\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isTypedArray(value)`",
              "name": "isTypedArray",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a built-in <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\"><code>&#x3C;TypedArray></code></a> instance.</p>\n<pre><code class=\"language-js\">util.types.isTypedArray(new ArrayBuffer());  // Returns false\nutil.types.isTypedArray(new Uint8Array());  // Returns true\nutil.types.isTypedArray(new Float64Array());  // Returns true\n</code></pre>\n<p>See also <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/isView\"><code>ArrayBuffer.isView()</code></a>.</p>"
            },
            {
              "textRaw": "`util.types.isUint8Array(value)`",
              "name": "isUint8Array",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a built-in <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array\"><code>&#x3C;Uint8Array></code></a> instance.</p>\n<pre><code class=\"language-js\">util.types.isUint8Array(new ArrayBuffer());  // Returns false\nutil.types.isUint8Array(new Uint8Array());  // Returns true\nutil.types.isUint8Array(new Float64Array());  // Returns false\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isUint8ClampedArray(value)`",
              "name": "isUint8ClampedArray",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a built-in <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8ClampedArray\"><code>&#x3C;Uint8ClampedArray></code></a> instance.</p>\n<pre><code class=\"language-js\">util.types.isUint8ClampedArray(new ArrayBuffer());  // Returns false\nutil.types.isUint8ClampedArray(new Uint8ClampedArray());  // Returns true\nutil.types.isUint8ClampedArray(new Float64Array());  // Returns false\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isUint16Array(value)`",
              "name": "isUint16Array",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a built-in <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array\"><code>&#x3C;Uint16Array></code></a> instance.</p>\n<pre><code class=\"language-js\">util.types.isUint16Array(new ArrayBuffer());  // Returns false\nutil.types.isUint16Array(new Uint16Array());  // Returns true\nutil.types.isUint16Array(new Float64Array());  // Returns false\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isUint32Array(value)`",
              "name": "isUint32Array",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a built-in <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint32Array\"><code>&#x3C;Uint32Array></code></a> instance.</p>\n<pre><code class=\"language-js\">util.types.isUint32Array(new ArrayBuffer());  // Returns false\nutil.types.isUint32Array(new Uint32Array());  // Returns true\nutil.types.isUint32Array(new Float64Array());  // Returns false\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isWeakMap(value)`",
              "name": "isWeakMap",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a built-in <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/WeakMap\"><code>&#x3C;WeakMap></code></a> instance.</p>\n<pre><code class=\"language-js\">util.types.isWeakMap(new WeakMap());  // Returns true\n</code></pre>"
            },
            {
              "textRaw": "`util.types.isWeakSet(value)`",
              "name": "isWeakSet",
              "type": "method",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`value` {any}",
                      "name": "value",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Returns <code>true</code> if the value is a built-in <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/WeakSet\"><code>&#x3C;WeakSet></code></a> instance.</p>\n<pre><code class=\"language-js\">util.types.isWeakSet(new WeakSet());  // Returns true\n</code></pre>"
            }
          ]
        }
      ],
      "modules": [
        {
          "textRaw": "Deprecated APIs",
          "name": "deprecated_apis",
          "type": "module",
          "desc": "<p>The following APIs are deprecated and should no longer be used. Existing\napplications and modules should be updated to find alternative approaches.</p>",
          "methods": [
            {
              "textRaw": "`util._extend(target, source)`",
              "name": "_extend",
              "type": "method",
              "meta": {
                "added": [
                  "v0.7.5"
                ],
                "changes": [],
                "deprecated": [
                  "v6.0.0"
                ]
              },
              "stability": 0,
              "stabilityText": "Deprecated: Use `Object.assign()` instead.",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`target` {Object}",
                      "name": "target",
                      "type": "Object"
                    },
                    {
                      "textRaw": "`source` {Object}",
                      "name": "source",
                      "type": "Object"
                    }
                  ]
                }
              ],
              "desc": "<p>The <code>util._extend()</code> method was never intended to be used outside of internal\nNode.js modules. The community found and used it anyway.</p>\n<p>It is deprecated and should not be used in new code. JavaScript comes with very\nsimilar built-in functionality through <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign\"><code>Object.assign()</code></a>.</p>\n<p>An automated migration is available (<a href=\"https://github.com/nodejs/userland-migrations/tree/main/recipes/util-extend-to-object-assign\">source</a>):</p>\n<pre><code class=\"language-bash\">npx codemod@latest @nodejs/util-extend-to-object-assign\n</code></pre>"
            },
            {
              "textRaw": "`util.isArray(object)`",
              "name": "isArray",
              "type": "method",
              "meta": {
                "added": [
                  "v0.6.0"
                ],
                "changes": [],
                "deprecated": [
                  "v4.0.0"
                ]
              },
              "stability": 0,
              "stabilityText": "Deprecated: Use `Array.isArray()` instead.",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`object` {any}",
                      "name": "object",
                      "type": "any"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ],
              "desc": "<p>Alias for <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray\"><code>Array.isArray()</code></a>.</p>\n<p>Returns <code>true</code> if the given <code>object</code> is an <code>Array</code>. Otherwise, returns <code>false</code>.</p>\n<pre><code class=\"language-js\">const util = require('node:util');\n\nutil.isArray([]);\n// Returns: true\nutil.isArray(new Array());\n// Returns: true\nutil.isArray({});\n// Returns: false\n</code></pre>\n<p>An automated migration is available (<a href=\"https://github.com/nodejs/userland-migrations/tree/main/recipes/util-is\">source</a>):</p>\n<pre><code class=\"language-bash\">npx codemod@latest @nodejs/util-is\n</code></pre>"
            }
          ],
          "displayName": "Deprecated APIs"
        }
      ],
      "displayName": "Util"
    }
  ]
}