1<!DOCTYPE html> 2<html lang="en"> 3<head> 4 <meta charset="utf-8"> 5 <meta name="viewport" content="width=device-width"> 6 <meta name="nodejs.org:node-version" content="v14.19.1"> 7 <title>Util | Node.js v14.19.1 Documentation</title> 8 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700,400italic&display=fallback"> 9 <link rel="stylesheet" href="assets/style.css"> 10 <link rel="stylesheet" href="assets/hljs.css"> 11 <link rel="canonical" href="https://nodejs.org/api/util.html"> 12</head> 13<body class="alt apidoc" id="api-section-util"> 14 <div id="content" class="clearfix"> 15 <div id="column2" class="interior"> 16 <div id="intro" class="interior"> 17 <a href="/" title="Go back to the home page"> 18 Node.js 19 </a> 20 </div> 21 <ul> 22<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 23<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 24</ul> 25<hr class="line"> 26<ul> 27<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 28<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 29<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 30<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 31<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 32<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 33<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 34<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 35<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 36<li><a href="console.html" class="nav-console">Console</a></li> 37<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 38<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 39<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 40<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 41<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 42<li><a href="dns.html" class="nav-dns">DNS</a></li> 43<li><a href="domain.html" class="nav-domain">Domain</a></li> 44<li><a href="errors.html" class="nav-errors">Errors</a></li> 45<li><a href="events.html" class="nav-events">Events</a></li> 46<li><a href="fs.html" class="nav-fs">File system</a></li> 47<li><a href="globals.html" class="nav-globals">Globals</a></li> 48<li><a href="http.html" class="nav-http">HTTP</a></li> 49<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 50<li><a href="https.html" class="nav-https">HTTPS</a></li> 51<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 52<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 53<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 54<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 55<li><a href="module.html" class="nav-module">Modules: <code>module</code> API</a></li> 56<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 57<li><a href="net.html" class="nav-net">Net</a></li> 58<li><a href="os.html" class="nav-os">OS</a></li> 59<li><a href="path.html" class="nav-path">Path</a></li> 60<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 61<li><a href="policy.html" class="nav-policy">Policies</a></li> 62<li><a href="process.html" class="nav-process">Process</a></li> 63<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 64<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 65<li><a href="readline.html" class="nav-readline">Readline</a></li> 66<li><a href="repl.html" class="nav-repl">REPL</a></li> 67<li><a href="report.html" class="nav-report">Report</a></li> 68<li><a href="stream.html" class="nav-stream">Stream</a></li> 69<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 70<li><a href="timers.html" class="nav-timers">Timers</a></li> 71<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 72<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 73<li><a href="tty.html" class="nav-tty">TTY</a></li> 74<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 75<li><a href="url.html" class="nav-url">URL</a></li> 76<li><a href="util.html" class="nav-util active">Utilities</a></li> 77<li><a href="v8.html" class="nav-v8">V8</a></li> 78<li><a href="vm.html" class="nav-vm">VM</a></li> 79<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 80<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 81<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 82</ul> 83<hr class="line"> 84<ul> 85<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 86</ul> 87 </div> 88 89 <div id="column1" data-id="util" class="interior"> 90 <header> 91 <div class="header-container"> 92 <h1>Node.js v14.19.1 documentation</h1> 93 <button class="theme-toggle-btn" id="theme-toggle-btn" title="Toggle dark mode/light mode" aria-label="Toggle dark mode/light mode" hidden> 94 <svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" height="24" width="24"> 95 <path fill="none" d="M0 0h24v24H0z" /> 96 <path d="M11.1 12.08c-2.33-4.51-.5-8.48.53-10.07C6.27 2.2 1.98 6.59 1.98 12c0 .14.02.28.02.42.62-.27 1.29-.42 2-.42 1.66 0 3.18.83 4.1 2.15A4.01 4.01 0 0111 18c0 1.52-.87 2.83-2.12 3.51.98.32 2.03.5 3.11.5 3.5 0 6.58-1.8 8.37-4.52-2.36.23-6.98-.97-9.26-5.41z"/> 97 <path d="M7 16h-.18C6.4 14.84 5.3 14 4 14c-1.66 0-3 1.34-3 3s1.34 3 3 3h3c1.1 0 2-.9 2-2s-.9-2-2-2z"/> 98 </svg> 99 <svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" height="24" width="24"> 100 <path d="M0 0h24v24H0z" fill="none" /> 101 <path d="M6.76 4.84l-1.8-1.79-1.41 1.41 1.79 1.79 1.42-1.41zM4 10.5H1v2h3v-2zm9-9.95h-2V3.5h2V.55zm7.45 3.91l-1.41-1.41-1.79 1.79 1.41 1.41 1.79-1.79zm-3.21 13.7l1.79 1.8 1.41-1.41-1.8-1.79-1.4 1.4zM20 10.5v2h3v-2h-3zm-8-5c-3.31 0-6 2.69-6 6s2.69 6 6 6 6-2.69 6-6-2.69-6-6-6zm-1 16.95h2V19.5h-2v2.95zm-7.45-3.91l1.41 1.41 1.79-1.8-1.41-1.41-1.79 1.8z"/> 102 </svg> 103 </button> 104 </div> 105 <div id="gtoc"> 106 <ul> 107 <li> 108 <a href="index.html">Index</a> 109 </li> 110 <li> 111 <a href="all.html">View on single page</a> 112 </li> 113 <li> 114 <a href="util.json">View as JSON</a> 115 </li> 116 117 <li class="version-picker"> 118 <a href="#">View another version <span>▼</span></a> 119 <ol class="version-picker"><li><a href="https://nodejs.org/docs/latest-v17.x/api/util.html">17.x</a></li> 120<li><a href="https://nodejs.org/docs/latest-v16.x/api/util.html">16.x <b>LTS</b></a></li> 121<li><a href="https://nodejs.org/docs/latest-v15.x/api/util.html">15.x</a></li> 122<li><a href="https://nodejs.org/docs/latest-v14.x/api/util.html">14.x <b>LTS</b></a></li> 123<li><a href="https://nodejs.org/docs/latest-v13.x/api/util.html">13.x</a></li> 124<li><a href="https://nodejs.org/docs/latest-v12.x/api/util.html">12.x <b>LTS</b></a></li> 125<li><a href="https://nodejs.org/docs/latest-v11.x/api/util.html">11.x</a></li> 126<li><a href="https://nodejs.org/docs/latest-v10.x/api/util.html">10.x</a></li> 127<li><a href="https://nodejs.org/docs/latest-v9.x/api/util.html">9.x</a></li> 128<li><a href="https://nodejs.org/docs/latest-v8.x/api/util.html">8.x</a></li> 129<li><a href="https://nodejs.org/docs/latest-v7.x/api/util.html">7.x</a></li> 130<li><a href="https://nodejs.org/docs/latest-v6.x/api/util.html">6.x</a></li> 131<li><a href="https://nodejs.org/docs/latest-v5.x/api/util.html">5.x</a></li> 132<li><a href="https://nodejs.org/docs/latest-v4.x/api/util.html">4.x</a></li> 133<li><a href="https://nodejs.org/docs/latest-v0.12.x/api/util.html">0.12.x</a></li> 134<li><a href="https://nodejs.org/docs/latest-v0.10.x/api/util.html">0.10.x</a></li></ol> 135 </li> 136 137 <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/master/doc/api/util.md">Edit on GitHub</a></li> 138 </ul> 139 </div> 140 <hr> 141 </header> 142 143 <details id="toc" open><summary>Table of contents</summary><ul> 144<li><span class="stability_2"><a href="#util_util">Util</a></span> 145<ul> 146<li><a href="#util_util_callbackify_original"><code>util.callbackify(original)</code></a></li> 147<li><a href="#util_util_debuglog_section_callback"><code>util.debuglog(section[, callback])</code></a> 148<ul> 149<li><a href="#util_debuglog_enabled"><code>debuglog().enabled</code></a></li> 150</ul> 151</li> 152<li><a href="#util_util_debug_section"><code>util.debug(section)</code></a></li> 153<li><a href="#util_util_deprecate_fn_msg_code"><code>util.deprecate(fn, msg[, code])</code></a></li> 154<li><a href="#util_util_format_format_args"><code>util.format(format[, ...args])</code></a></li> 155<li><a href="#util_util_formatwithoptions_inspectoptions_format_args"><code>util.formatWithOptions(inspectOptions, format[, ...args])</code></a></li> 156<li><a href="#util_util_getsystemerrorname_err"><code>util.getSystemErrorName(err)</code></a></li> 157<li><a href="#util_util_getsystemerrormap"><code>util.getSystemErrorMap()</code></a></li> 158<li><span class="stability_3"><a href="#util_util_inherits_constructor_superconstructor"><code>util.inherits(constructor, superConstructor)</code></a></span></li> 159<li><a href="#util_util_inspect_object_options"><code>util.inspect(object[, options])</code></a></li> 160<li><a href="#util_util_inspect_object_showhidden_depth_colors"><code>util.inspect(object[, showHidden[, depth[, colors]]])</code></a> 161<ul> 162<li><a href="#util_customizing_util_inspect_colors">Customizing <code>util.inspect</code> colors</a> 163<ul> 164<li><a href="#util_modifiers">Modifiers</a></li> 165<li><a href="#util_foreground_colors">Foreground colors</a></li> 166<li><a href="#util_background_colors">Background colors</a></li> 167</ul> 168</li> 169<li><a href="#util_custom_inspection_functions_on_objects">Custom inspection functions on objects</a></li> 170<li><a href="#util_util_inspect_custom"><code>util.inspect.custom</code></a></li> 171<li><a href="#util_util_inspect_defaultoptions"><code>util.inspect.defaultOptions</code></a></li> 172</ul> 173</li> 174<li><a href="#util_util_isdeepstrictequal_val1_val2"><code>util.isDeepStrictEqual(val1, val2)</code></a></li> 175<li><a href="#util_util_promisify_original"><code>util.promisify(original)</code></a> 176<ul> 177<li><a href="#util_custom_promisified_functions">Custom promisified functions</a></li> 178<li><a href="#util_util_promisify_custom"><code>util.promisify.custom</code></a></li> 179</ul> 180</li> 181<li><a href="#util_class_util_textdecoder">Class: <code>util.TextDecoder</code></a> 182<ul> 183<li><a href="#util_whatwg_supported_encodings">WHATWG supported encodings</a> 184<ul> 185<li><a href="#util_encodings_supported_by_default_with_full_icu_data">Encodings supported by default (with full ICU data)</a></li> 186<li><a href="#util_encodings_supported_when_node_js_is_built_with_the_small_icu_option">Encodings supported when Node.js is built with the <code>small-icu</code> option</a></li> 187<li><a href="#util_encodings_supported_when_icu_is_disabled">Encodings supported when ICU is disabled</a></li> 188</ul> 189</li> 190<li><a href="#util_new_textdecoder_encoding_options"><code>new TextDecoder([encoding[, options]])</code></a></li> 191<li><a href="#util_textdecoder_decode_input_options"><code>textDecoder.decode([input[, options]])</code></a></li> 192<li><a href="#util_textdecoder_encoding"><code>textDecoder.encoding</code></a></li> 193<li><a href="#util_textdecoder_fatal"><code>textDecoder.fatal</code></a></li> 194<li><a href="#util_textdecoder_ignorebom"><code>textDecoder.ignoreBOM</code></a></li> 195</ul> 196</li> 197<li><a href="#util_class_util_textencoder">Class: <code>util.TextEncoder</code></a> 198<ul> 199<li><a href="#util_textencoder_encode_input"><code>textEncoder.encode([input])</code></a></li> 200<li><a href="#util_textencoder_encodeinto_src_dest"><code>textEncoder.encodeInto(src, dest)</code></a></li> 201<li><a href="#util_textencoder_encoding"><code>textEncoder.encoding</code></a></li> 202</ul> 203</li> 204<li><a href="#util_util_tousvstring_string"><code>util.toUSVString(string)</code></a></li> 205<li><a href="#util_util_types"><code>util.types</code></a> 206<ul> 207<li><a href="#util_util_types_isanyarraybuffer_value"><code>util.types.isAnyArrayBuffer(value)</code></a></li> 208<li><a href="#util_util_types_isarraybufferview_value"><code>util.types.isArrayBufferView(value)</code></a></li> 209<li><a href="#util_util_types_isargumentsobject_value"><code>util.types.isArgumentsObject(value)</code></a></li> 210<li><a href="#util_util_types_isarraybuffer_value"><code>util.types.isArrayBuffer(value)</code></a></li> 211<li><a href="#util_util_types_isasyncfunction_value"><code>util.types.isAsyncFunction(value)</code></a></li> 212<li><a href="#util_util_types_isbigint64array_value"><code>util.types.isBigInt64Array(value)</code></a></li> 213<li><a href="#util_util_types_isbiguint64array_value"><code>util.types.isBigUint64Array(value)</code></a></li> 214<li><a href="#util_util_types_isbooleanobject_value"><code>util.types.isBooleanObject(value)</code></a></li> 215<li><a href="#util_util_types_isboxedprimitive_value"><code>util.types.isBoxedPrimitive(value)</code></a></li> 216<li><a href="#util_util_types_isdataview_value"><code>util.types.isDataView(value)</code></a></li> 217<li><a href="#util_util_types_isdate_value"><code>util.types.isDate(value)</code></a></li> 218<li><a href="#util_util_types_isexternal_value"><code>util.types.isExternal(value)</code></a></li> 219<li><a href="#util_util_types_isfloat32array_value"><code>util.types.isFloat32Array(value)</code></a></li> 220<li><a href="#util_util_types_isfloat64array_value"><code>util.types.isFloat64Array(value)</code></a></li> 221<li><a href="#util_util_types_isgeneratorfunction_value"><code>util.types.isGeneratorFunction(value)</code></a></li> 222<li><a href="#util_util_types_isgeneratorobject_value"><code>util.types.isGeneratorObject(value)</code></a></li> 223<li><a href="#util_util_types_isint8array_value"><code>util.types.isInt8Array(value)</code></a></li> 224<li><a href="#util_util_types_isint16array_value"><code>util.types.isInt16Array(value)</code></a></li> 225<li><a href="#util_util_types_isint32array_value"><code>util.types.isInt32Array(value)</code></a></li> 226<li><a href="#util_util_types_ismap_value"><code>util.types.isMap(value)</code></a></li> 227<li><a href="#util_util_types_ismapiterator_value"><code>util.types.isMapIterator(value)</code></a></li> 228<li><a href="#util_util_types_ismodulenamespaceobject_value"><code>util.types.isModuleNamespaceObject(value)</code></a></li> 229<li><a href="#util_util_types_isnativeerror_value"><code>util.types.isNativeError(value)</code></a></li> 230<li><a href="#util_util_types_isnumberobject_value"><code>util.types.isNumberObject(value)</code></a></li> 231<li><a href="#util_util_types_ispromise_value"><code>util.types.isPromise(value)</code></a></li> 232<li><a href="#util_util_types_isproxy_value"><code>util.types.isProxy(value)</code></a></li> 233<li><a href="#util_util_types_isregexp_value"><code>util.types.isRegExp(value)</code></a></li> 234<li><a href="#util_util_types_isset_value"><code>util.types.isSet(value)</code></a></li> 235<li><a href="#util_util_types_issetiterator_value"><code>util.types.isSetIterator(value)</code></a></li> 236<li><a href="#util_util_types_issharedarraybuffer_value"><code>util.types.isSharedArrayBuffer(value)</code></a></li> 237<li><a href="#util_util_types_isstringobject_value"><code>util.types.isStringObject(value)</code></a></li> 238<li><a href="#util_util_types_issymbolobject_value"><code>util.types.isSymbolObject(value)</code></a></li> 239<li><a href="#util_util_types_istypedarray_value"><code>util.types.isTypedArray(value)</code></a></li> 240<li><a href="#util_util_types_isuint8array_value"><code>util.types.isUint8Array(value)</code></a></li> 241<li><a href="#util_util_types_isuint8clampedarray_value"><code>util.types.isUint8ClampedArray(value)</code></a></li> 242<li><a href="#util_util_types_isuint16array_value"><code>util.types.isUint16Array(value)</code></a></li> 243<li><a href="#util_util_types_isuint32array_value"><code>util.types.isUint32Array(value)</code></a></li> 244<li><a href="#util_util_types_isweakmap_value"><code>util.types.isWeakMap(value)</code></a></li> 245<li><a href="#util_util_types_isweakset_value"><code>util.types.isWeakSet(value)</code></a></li> 246<li><span class="stability_0"><a href="#util_util_types_iswebassemblycompiledmodule_value"><code>util.types.isWebAssemblyCompiledModule(value)</code></a></span></li> 247</ul> 248</li> 249<li><a href="#util_deprecated_apis">Deprecated APIs</a> 250<ul> 251<li><span class="stability_0"><a href="#util_util_extend_target_source"><code>util._extend(target, source)</code></a></span></li> 252<li><span class="stability_0"><a href="#util_util_isarray_object"><code>util.isArray(object)</code></a></span></li> 253<li><span class="stability_0"><a href="#util_util_isboolean_object"><code>util.isBoolean(object)</code></a></span></li> 254<li><span class="stability_0"><a href="#util_util_isbuffer_object"><code>util.isBuffer(object)</code></a></span></li> 255<li><span class="stability_0"><a href="#util_util_isdate_object"><code>util.isDate(object)</code></a></span></li> 256<li><span class="stability_0"><a href="#util_util_iserror_object"><code>util.isError(object)</code></a></span></li> 257<li><span class="stability_0"><a href="#util_util_isfunction_object"><code>util.isFunction(object)</code></a></span></li> 258<li><span class="stability_0"><a href="#util_util_isnull_object"><code>util.isNull(object)</code></a></span></li> 259<li><span class="stability_0"><a href="#util_util_isnullorundefined_object"><code>util.isNullOrUndefined(object)</code></a></span></li> 260<li><span class="stability_0"><a href="#util_util_isnumber_object"><code>util.isNumber(object)</code></a></span></li> 261<li><span class="stability_0"><a href="#util_util_isobject_object"><code>util.isObject(object)</code></a></span></li> 262<li><span class="stability_0"><a href="#util_util_isprimitive_object"><code>util.isPrimitive(object)</code></a></span></li> 263<li><span class="stability_0"><a href="#util_util_isregexp_object"><code>util.isRegExp(object)</code></a></span></li> 264<li><span class="stability_0"><a href="#util_util_isstring_object"><code>util.isString(object)</code></a></span></li> 265<li><span class="stability_0"><a href="#util_util_issymbol_object"><code>util.isSymbol(object)</code></a></span></li> 266<li><span class="stability_0"><a href="#util_util_isundefined_object"><code>util.isUndefined(object)</code></a></span></li> 267<li><span class="stability_0"><a href="#util_util_log_string"><code>util.log(string)</code></a></span></li> 268</ul> 269</li> 270</ul> 271</li> 272</ul></details> 273 274 <div id="apicontent"> 275 <h2>Util<span><a class="mark" href="#util_util" id="util_util">#</a></span></h2> 276 277<p></p><div class="api_stability api_stability_2"><a href="documentation.html#documentation_stability_index">Stability: 2</a> - Stable</div><p></p> 278<p><strong>Source Code:</strong> <a href="https://github.com/nodejs/node/blob/v14.19.1/lib/util.js">lib/util.js</a></p> 279<p>The <code>util</code> module supports the needs of Node.js internal APIs. Many of the 280utilities are useful for application and module developers as well. To access 281it:</p> 282<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>);</code></pre> 283<section><h3><code>util.callbackify(original)</code><span><a class="mark" href="#util_util_callbackify_original" id="util_util_callbackify_original">#</a></span></h3> 284<div class="api_metadata"> 285<span>Added in: v8.2.0</span> 286</div> 287<ul> 288<li><code>original</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> An <code>async</code> function</li> 289<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> a callback style function</li> 290</ul> 291<p>Takes an <code>async</code> function (or a function that returns a <code>Promise</code>) and returns a 292function following the error-first callback style, i.e. taking 293an <code>(err, value) => ...</code> callback as the last argument. In the callback, the 294first argument will be the rejection reason (or <code>null</code> if the <code>Promise</code> 295resolved), and the second argument will be the resolved value.</p> 296<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 297 298<span class="hljs-keyword">async</span> <span class="hljs-keyword">function</span> <span class="hljs-title function_">fn</span>(<span class="hljs-params"></span>) { 299 <span class="hljs-keyword">return</span> <span class="hljs-string">'hello world'</span>; 300} 301<span class="hljs-keyword">const</span> callbackFunction = util.<span class="hljs-title function_">callbackify</span>(fn); 302 303<span class="hljs-title function_">callbackFunction</span>(<span class="hljs-function">(<span class="hljs-params">err, ret</span>) =></span> { 304 <span class="hljs-keyword">if</span> (err) <span class="hljs-keyword">throw</span> err; 305 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(ret); 306});</code></pre> 307<p>Will print:</p> 308<pre><code class="language-text">hello world</code></pre> 309<p>The callback is executed asynchronously, and will have a limited stack trace. 310If the callback throws, the process will emit an <a href="process.html#process_event_uncaughtexception"><code>'uncaughtException'</code></a> 311event, and if not handled will exit.</p> 312<p>Since <code>null</code> has a special meaning as the first argument to a callback, if a 313wrapped function rejects a <code>Promise</code> with a falsy value as a reason, the value 314is wrapped in an <code>Error</code> with the original value stored in a field named 315<code>reason</code>.</p> 316<pre><code class="language-js"><span class="hljs-keyword">function</span> <span class="hljs-title function_">fn</span>(<span class="hljs-params"></span>) { 317 <span class="hljs-keyword">return</span> <span class="hljs-title class_">Promise</span>.<span class="hljs-title function_">reject</span>(<span class="hljs-literal">null</span>); 318} 319<span class="hljs-keyword">const</span> callbackFunction = util.<span class="hljs-title function_">callbackify</span>(fn); 320 321<span class="hljs-title function_">callbackFunction</span>(<span class="hljs-function">(<span class="hljs-params">err, ret</span>) =></span> { 322 <span class="hljs-comment">// When the Promise was rejected with `null` it is wrapped with an Error and</span> 323 <span class="hljs-comment">// the original value is stored in `reason`.</span> 324 err && err.<span class="hljs-title function_">hasOwnProperty</span>(<span class="hljs-string">'reason'</span>) && err.<span class="hljs-property">reason</span> === <span class="hljs-literal">null</span>; <span class="hljs-comment">// true</span> 325});</code></pre> 326</section><section><h3><code>util.debuglog(section[, callback])</code><span><a class="mark" href="#util_util_debuglog_section_callback" id="util_util_debuglog_section_callback">#</a></span></h3> 327<div class="api_metadata"> 328<span>Added in: v0.11.3</span> 329</div> 330<ul> 331<li><code>section</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> A string identifying the portion of the application for 332which the <code>debuglog</code> function is being created.</li> 333<li><code>callback</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> A callback invoked the first time the logging function 334is called with a function argument that is a more optimized logging function.</li> 335<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> The logging function</li> 336</ul> 337<p>The <code>util.debuglog()</code> method is used to create a function that conditionally 338writes debug messages to <code>stderr</code> based on the existence of the <code>NODE_DEBUG</code> 339environment variable. If the <code>section</code> name appears within the value of that 340environment variable, then the returned function operates similar to 341<a href="console.html#console_console_error_data_args"><code>console.error()</code></a>. If not, then the returned function is a no-op.</p> 342<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 343<span class="hljs-keyword">const</span> debuglog = util.<span class="hljs-title function_">debuglog</span>(<span class="hljs-string">'foo'</span>); 344 345<span class="hljs-title function_">debuglog</span>(<span class="hljs-string">'hello from foo [%d]'</span>, <span class="hljs-number">123</span>);</code></pre> 346<p>If this program is run with <code>NODE_DEBUG=foo</code> in the environment, then 347it will output something like:</p> 348<pre><code class="language-console">FOO 3245: hello from foo [123]</code></pre> 349<p>where <code>3245</code> is the process id. If it is not run with that 350environment variable set, then it will not print anything.</p> 351<p>The <code>section</code> supports wildcard also:</p> 352<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 353<span class="hljs-keyword">const</span> debuglog = util.<span class="hljs-title function_">debuglog</span>(<span class="hljs-string">'foo-bar'</span>); 354 355<span class="hljs-title function_">debuglog</span>(<span class="hljs-string">'hi there, it\'s foo-bar [%d]'</span>, <span class="hljs-number">2333</span>);</code></pre> 356<p>if it is run with <code>NODE_DEBUG=foo*</code> in the environment, then it will output 357something like:</p> 358<pre><code class="language-console">FOO-BAR 3257: hi there, it's foo-bar [2333]</code></pre> 359<p>Multiple comma-separated <code>section</code> names may be specified in the <code>NODE_DEBUG</code> 360environment variable: <code>NODE_DEBUG=fs,net,tls</code>.</p> 361<p>The optional <code>callback</code> argument can be used to replace the logging function 362with a different function that doesn't have any initialization or 363unnecessary wrapping.</p> 364<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 365<span class="hljs-keyword">let</span> debuglog = util.<span class="hljs-title function_">debuglog</span>(<span class="hljs-string">'internals'</span>, <span class="hljs-function">(<span class="hljs-params">debug</span>) =></span> { 366 <span class="hljs-comment">// Replace with a logging function that optimizes out</span> 367 <span class="hljs-comment">// testing if the section is enabled</span> 368 debuglog = debug; 369});</code></pre> 370<h4><code>debuglog().enabled</code><span><a class="mark" href="#util_debuglog_enabled" id="util_debuglog_enabled">#</a></span></h4> 371<div class="api_metadata"> 372<span>Added in: v14.9.0</span> 373</div> 374<ul> 375<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 376</ul> 377<p>The <code>util.debuglog().enabled</code> getter is used to create a test that can be used 378in conditionals based on the existence of the <code>NODE_DEBUG</code> environment variable. 379If the <code>section</code> name appears within the value of that environment variable, 380then the returned value will be <code>true</code>. If not, then the returned value will be 381<code>false</code>.</p> 382<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 383<span class="hljs-keyword">const</span> enabled = util.<span class="hljs-title function_">debuglog</span>(<span class="hljs-string">'foo'</span>).<span class="hljs-property">enabled</span>; 384<span class="hljs-keyword">if</span> (enabled) { 385 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'hello from foo [%d]'</span>, <span class="hljs-number">123</span>); 386}</code></pre> 387<p>If this program is run with <code>NODE_DEBUG=foo</code> in the environment, then it will 388output something like:</p> 389<pre><code class="language-console">hello from foo [123]</code></pre> 390</section><section><h3><code>util.debug(section)</code><span><a class="mark" href="#util_util_debug_section" id="util_util_debug_section">#</a></span></h3> 391<div class="api_metadata"> 392<span>Added in: v14.9.0</span> 393</div> 394<p>Alias for <code>util.debuglog</code>. Usage allows for readability of that doesn't imply 395logging when only using <code>util.debuglog().enabled</code>.</p> 396</section><section><h3><code>util.deprecate(fn, msg[, code])</code><span><a class="mark" href="#util_util_deprecate_fn_msg_code" id="util_util_deprecate_fn_msg_code">#</a></span></h3> 397<div class="api_metadata"> 398<details class="changelog"><summary>History</summary> 399<table> 400<tbody><tr><th>Version</th><th>Changes</th></tr> 401<tr><td>v10.0.0</td> 402<td><p>Deprecation warnings are only emitted once for each code.</p></td></tr> 403<tr><td>v0.8.0</td> 404<td><p><span>Added in: v0.8.0</span></p></td></tr> 405</tbody></table> 406</details> 407</div> 408<ul> 409<li><code>fn</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> The function that is being deprecated.</li> 410<li><code>msg</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> A warning message to display when the deprecated function is 411invoked.</li> 412<li><code>code</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> A deprecation code. See the <a href="deprecations.html#deprecations_list_of_deprecated_apis">list of deprecated APIs</a> for a 413list of codes.</li> 414<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> The deprecated function wrapped to emit a warning.</li> 415</ul> 416<p>The <code>util.deprecate()</code> method wraps <code>fn</code> (which may be a function or class) in 417such a way that it is marked as deprecated.</p> 418<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 419 420<span class="hljs-built_in">exports</span>.<span class="hljs-property">obsoleteFunction</span> = util.<span class="hljs-title function_">deprecate</span>(<span class="hljs-function">() =></span> { 421 <span class="hljs-comment">// Do something here.</span> 422}, <span class="hljs-string">'obsoleteFunction() is deprecated. Use newShinyFunction() instead.'</span>);</code></pre> 423<p>When called, <code>util.deprecate()</code> will return a function that will emit a 424<code>DeprecationWarning</code> using the <a href="process.html#process_event_warning"><code>'warning'</code></a> event. The warning will 425be emitted and printed to <code>stderr</code> the first time the returned function is 426called. After the warning is emitted, the wrapped function is called without 427emitting a warning.</p> 428<p>If the same optional <code>code</code> is supplied in multiple calls to <code>util.deprecate()</code>, 429the warning will be emitted only once for that <code>code</code>.</p> 430<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 431 432<span class="hljs-keyword">const</span> fn1 = util.<span class="hljs-title function_">deprecate</span>(someFunction, someMessage, <span class="hljs-string">'DEP0001'</span>); 433<span class="hljs-keyword">const</span> fn2 = util.<span class="hljs-title function_">deprecate</span>(someOtherFunction, someOtherMessage, <span class="hljs-string">'DEP0001'</span>); 434<span class="hljs-title function_">fn1</span>(); <span class="hljs-comment">// Emits a deprecation warning with code DEP0001</span> 435<span class="hljs-title function_">fn2</span>(); <span class="hljs-comment">// Does not emit a deprecation warning because it has the same code</span></code></pre> 436<p>If either the <code>--no-deprecation</code> or <code>--no-warnings</code> command-line flags are 437used, or if the <code>process.noDeprecation</code> property is set to <code>true</code> <em>prior</em> to 438the first deprecation warning, the <code>util.deprecate()</code> method does nothing.</p> 439<p>If the <code>--trace-deprecation</code> or <code>--trace-warnings</code> command-line flags are set, 440or the <code>process.traceDeprecation</code> property is set to <code>true</code>, a warning and a 441stack trace are printed to <code>stderr</code> the first time the deprecated function is 442called.</p> 443<p>If the <code>--throw-deprecation</code> command-line flag is set, or the 444<code>process.throwDeprecation</code> property is set to <code>true</code>, then an exception will be 445thrown when the deprecated function is called.</p> 446<p>The <code>--throw-deprecation</code> command-line flag and <code>process.throwDeprecation</code> 447property take precedence over <code>--trace-deprecation</code> and 448<code>process.traceDeprecation</code>.</p> 449</section><section><h3><code>util.format(format[, ...args])</code><span><a class="mark" href="#util_util_format_format_args" id="util_util_format_format_args">#</a></span></h3> 450<div class="api_metadata"> 451<details class="changelog"><summary>History</summary> 452<table> 453<tbody><tr><th>Version</th><th>Changes</th></tr> 454<tr><td>v12.11.0</td> 455<td><p>The <code>%c</code> specifier is ignored now.</p></td></tr> 456<tr><td>v12.0.0</td> 457<td><p>The <code>format</code> argument is now only taken as such if it actually contains format specifiers.</p></td></tr> 458<tr><td>v12.0.0</td> 459<td><p>If the <code>format</code> 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.</p></td></tr> 460<tr><td>v11.4.0</td> 461<td><p>The <code>%d</code>, <code>%f</code> and <code>%i</code> specifiers now support Symbols properly.</p></td></tr> 462<tr><td>v11.4.0</td> 463<td><p>The <code>%o</code> specifier's <code>depth</code> has default depth of 4 again.</p></td></tr> 464<tr><td>v11.0.0</td> 465<td><p>The <code>%o</code> specifier's <code>depth</code> option will now fall back to the default depth.</p></td></tr> 466<tr><td>v10.12.0</td> 467<td><p>The <code>%d</code> and <code>%i</code> specifiers now support BigInt.</p></td></tr> 468<tr><td>v8.4.0</td> 469<td><p>The <code>%o</code> and <code>%O</code> specifiers are supported now.</p></td></tr> 470<tr><td>v0.5.3</td> 471<td><p><span>Added in: v0.5.3</span></p></td></tr> 472</tbody></table> 473</details> 474</div> 475<ul> 476<li><code>format</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> A <code>printf</code>-like format string.</li> 477</ul> 478<p>The <code>util.format()</code> method returns a formatted string using the first argument 479as a <code>printf</code>-like format string which can contain zero or more format 480specifiers. Each specifier is replaced with the converted value from the 481corresponding argument. Supported specifiers are:</p> 482<ul> 483<li><code>%s</code>: <code>String</code> will be used to convert all values except <code>BigInt</code>, <code>Object</code> 484and <code>-0</code>. <code>BigInt</code> values will be represented with an <code>n</code> and Objects that 485have no user defined <code>toString</code> function are inspected using <code>util.inspect()</code> 486with options <code>{ depth: 0, colors: false, compact: 3 }</code>.</li> 487<li><code>%d</code>: <code>Number</code> will be used to convert all values except <code>BigInt</code> and 488<code>Symbol</code>.</li> 489<li><code>%i</code>: <code>parseInt(value, 10)</code> is used for all values except <code>BigInt</code> and 490<code>Symbol</code>.</li> 491<li><code>%f</code>: <code>parseFloat(value)</code> is used for all values expect <code>Symbol</code>.</li> 492<li><code>%j</code>: JSON. Replaced with the string <code>'[Circular]'</code> if the argument contains 493circular references.</li> 494<li><code>%o</code>: <code>Object</code>. A string representation of an object with generic JavaScript 495object formatting. Similar to <code>util.inspect()</code> with options 496<code>{ showHidden: true, showProxy: true }</code>. This will show the full object 497including non-enumerable properties and proxies.</li> 498<li><code>%O</code>: <code>Object</code>. A string representation of an object with generic JavaScript 499object formatting. Similar to <code>util.inspect()</code> without options. This will show 500the full object not including non-enumerable properties and proxies.</li> 501<li><code>%c</code>: <code>CSS</code>. This specifier is ignored and will skip any CSS passed in.</li> 502<li><code>%%</code>: single percent sign (<code>'%'</code>). This does not consume an argument.</li> 503<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> The formatted string</li> 504</ul> 505<p>If a specifier does not have a corresponding argument, it is not replaced:</p> 506<pre><code class="language-js">util.<span class="hljs-title function_">format</span>(<span class="hljs-string">'%s:%s'</span>, <span class="hljs-string">'foo'</span>); 507<span class="hljs-comment">// Returns: 'foo:%s'</span></code></pre> 508<p>Values that are not part of the format string are formatted using 509<code>util.inspect()</code> if their type is not <code>string</code>.</p> 510<p>If there are more arguments passed to the <code>util.format()</code> method than the 511number of specifiers, the extra arguments are concatenated to the returned 512string, separated by spaces:</p> 513<pre><code class="language-js">util.<span class="hljs-title function_">format</span>(<span class="hljs-string">'%s:%s'</span>, <span class="hljs-string">'foo'</span>, <span class="hljs-string">'bar'</span>, <span class="hljs-string">'baz'</span>); 514<span class="hljs-comment">// Returns: 'foo:bar baz'</span></code></pre> 515<p>If the first argument does not contain a valid format specifier, <code>util.format()</code> 516returns a string that is the concatenation of all arguments separated by spaces:</p> 517<pre><code class="language-js">util.<span class="hljs-title function_">format</span>(<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>); 518<span class="hljs-comment">// Returns: '1 2 3'</span></code></pre> 519<p>If only one argument is passed to <code>util.format()</code>, it is returned as it is 520without any formatting:</p> 521<pre><code class="language-js">util.<span class="hljs-title function_">format</span>(<span class="hljs-string">'%% %s'</span>); 522<span class="hljs-comment">// Returns: '%% %s'</span></code></pre> 523<p><code>util.format()</code> is a synchronous method that is intended as a debugging tool. 524Some input values can have a significant performance overhead that can block the 525event loop. Use this function with care and never in a hot code path.</p> 526</section><section><h3><code>util.formatWithOptions(inspectOptions, format[, ...args])</code><span><a class="mark" href="#util_util_formatwithoptions_inspectoptions_format_args" id="util_util_formatwithoptions_inspectoptions_format_args">#</a></span></h3> 527<div class="api_metadata"> 528<span>Added in: v10.0.0</span> 529</div> 530<ul> 531<li><code>inspectOptions</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 532<li><code>format</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 533</ul> 534<p>This function is identical to <a href="#util_util_format_format_args"><code>util.format()</code></a>, except in that it takes 535an <code>inspectOptions</code> argument which specifies options that are passed along to 536<a href="#util_util_inspect_object_options"><code>util.inspect()</code></a>.</p> 537<pre><code class="language-js">util.<span class="hljs-title function_">formatWithOptions</span>({ <span class="hljs-attr">colors</span>: <span class="hljs-literal">true</span> }, <span class="hljs-string">'See object %O'</span>, { <span class="hljs-attr">foo</span>: <span class="hljs-number">42</span> }); 538<span class="hljs-comment">// Returns 'See object { foo: 42 }', where `42` is colored as a number</span> 539<span class="hljs-comment">// when printed to a terminal.</span></code></pre> 540</section><section><h3><code>util.getSystemErrorName(err)</code><span><a class="mark" href="#util_util_getsystemerrorname_err" id="util_util_getsystemerrorname_err">#</a></span></h3> 541<div class="api_metadata"> 542<span>Added in: v9.7.0</span> 543</div> 544<ul> 545<li><code>err</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 546<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 547</ul> 548<p>Returns the string name for a numeric error code that comes from a Node.js API. 549The mapping between error codes and error names is platform-dependent. 550See <a href="errors.html#errors_common_system_errors">Common System Errors</a> for the names of common errors.</p> 551<pre><code class="language-js">fs.<span class="hljs-title function_">access</span>(<span class="hljs-string">'file/that/does/not/exist'</span>, <span class="hljs-function">(<span class="hljs-params">err</span>) =></span> { 552 <span class="hljs-keyword">const</span> name = util.<span class="hljs-title function_">getSystemErrorName</span>(err.<span class="hljs-property">errno</span>); 553 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>(name); <span class="hljs-comment">// ENOENT</span> 554});</code></pre> 555</section><section><h3><code>util.getSystemErrorMap()</code><span><a class="mark" href="#util_util_getsystemerrormap" id="util_util_getsystemerrormap">#</a></span></h3> 556<div class="api_metadata"> 557<span>Added in: v14.17.0</span> 558</div> 559<ul> 560<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map" class="type"><Map></a></li> 561</ul> 562<p>Returns a Map of all system error codes available from the Node.js API. 563The mapping between error codes and error names is platform-dependent. 564See <a href="errors.html#errors_common_system_errors">Common System Errors</a> for the names of common errors.</p> 565<pre><code class="language-js">fs.<span class="hljs-title function_">access</span>(<span class="hljs-string">'file/that/does/not/exist'</span>, <span class="hljs-function">(<span class="hljs-params">err</span>) =></span> { 566 <span class="hljs-keyword">const</span> errorMap = util.<span class="hljs-title function_">getSystemErrorMap</span>(); 567 <span class="hljs-keyword">const</span> name = errorMap.<span class="hljs-title function_">get</span>(err.<span class="hljs-property">errno</span>); 568 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">error</span>(name); <span class="hljs-comment">// ENOENT</span> 569});</code></pre> 570</section><section><h3><code>util.inherits(constructor, superConstructor)</code><span><a class="mark" href="#util_util_inherits_constructor_superconstructor" id="util_util_inherits_constructor_superconstructor">#</a></span></h3> 571<div class="api_metadata"> 572<details class="changelog"><summary>History</summary> 573<table> 574<tbody><tr><th>Version</th><th>Changes</th></tr> 575<tr><td>v5.0.0</td> 576<td><p>The <code>constructor</code> parameter can refer to an ES6 class now.</p></td></tr> 577<tr><td>v0.3.0</td> 578<td><p><span>Added in: v0.3.0</span></p></td></tr> 579</tbody></table> 580</details> 581</div> 582<p></p><div class="api_stability api_stability_3"><a href="documentation.html#documentation_stability_index">Stability: 3</a> - Legacy: Use ES2015 class syntax and <code>extends</code> keyword instead.</div><p></p> 583<ul> 584<li><code>constructor</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 585<li><code>superConstructor</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 586</ul> 587<p>Usage of <code>util.inherits()</code> is discouraged. Please use the ES6 <code>class</code> and 588<code>extends</code> keywords to get language level inheritance support. Also note 589that the two styles are <a href="https://github.com/nodejs/node/issues/4179">semantically incompatible</a>.</p> 590<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 591prototype of <code>constructor</code> will be set to a new object created from 592<code>superConstructor</code>.</p> 593<p>This mainly adds some input validation on top of 594<code>Object.setPrototypeOf(constructor.prototype, superConstructor.prototype)</code>. 595As an additional convenience, <code>superConstructor</code> will be accessible 596through the <code>constructor.super_</code> property.</p> 597<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 598<span class="hljs-keyword">const</span> <span class="hljs-title class_">EventEmitter</span> = <span class="hljs-built_in">require</span>(<span class="hljs-string">'events'</span>); 599 600<span class="hljs-keyword">function</span> <span class="hljs-title function_">MyStream</span>(<span class="hljs-params"></span>) { 601 <span class="hljs-title class_">EventEmitter</span>.<span class="hljs-title function_">call</span>(<span class="hljs-variable language_">this</span>); 602} 603 604util.<span class="hljs-title function_">inherits</span>(<span class="hljs-title class_">MyStream</span>, <span class="hljs-title class_">EventEmitter</span>); 605 606<span class="hljs-title class_">MyStream</span>.<span class="hljs-property"><span class="hljs-keyword">prototype</span></span>.<span class="hljs-property">write</span> = <span class="hljs-keyword">function</span>(<span class="hljs-params">data</span>) { 607 <span class="hljs-variable language_">this</span>.<span class="hljs-title function_">emit</span>(<span class="hljs-string">'data'</span>, data); 608}; 609 610<span class="hljs-keyword">const</span> stream = <span class="hljs-keyword">new</span> <span class="hljs-title class_">MyStream</span>(); 611 612<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(stream <span class="hljs-keyword">instanceof</span> <span class="hljs-title class_">EventEmitter</span>); <span class="hljs-comment">// true</span> 613<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title class_">MyStream</span>.<span class="hljs-property">super_</span> === <span class="hljs-title class_">EventEmitter</span>); <span class="hljs-comment">// true</span> 614 615stream.<span class="hljs-title function_">on</span>(<span class="hljs-string">'data'</span>, <span class="hljs-function">(<span class="hljs-params">data</span>) =></span> { 616 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`Received data: "<span class="hljs-subst">${data}</span>"`</span>); 617}); 618stream.<span class="hljs-title function_">write</span>(<span class="hljs-string">'It works!'</span>); <span class="hljs-comment">// Received data: "It works!"</span></code></pre> 619<p>ES6 example using <code>class</code> and <code>extends</code>:</p> 620<pre><code class="language-js"><span class="hljs-keyword">const</span> <span class="hljs-title class_">EventEmitter</span> = <span class="hljs-built_in">require</span>(<span class="hljs-string">'events'</span>); 621 622<span class="hljs-keyword">class</span> <span class="hljs-title class_">MyStream</span> <span class="hljs-keyword">extends</span> <span class="hljs-title class_ inherited__">EventEmitter</span> { 623 <span class="hljs-title function_">write</span>(<span class="hljs-params">data</span>) { 624 <span class="hljs-variable language_">this</span>.<span class="hljs-title function_">emit</span>(<span class="hljs-string">'data'</span>, data); 625 } 626} 627 628<span class="hljs-keyword">const</span> stream = <span class="hljs-keyword">new</span> <span class="hljs-title class_">MyStream</span>(); 629 630stream.<span class="hljs-title function_">on</span>(<span class="hljs-string">'data'</span>, <span class="hljs-function">(<span class="hljs-params">data</span>) =></span> { 631 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`Received data: "<span class="hljs-subst">${data}</span>"`</span>); 632}); 633stream.<span class="hljs-title function_">write</span>(<span class="hljs-string">'With ES6'</span>);</code></pre> 634</section><section><h3><code>util.inspect(object[, options])</code><span><a class="mark" href="#util_util_inspect_object_options" id="util_util_inspect_object_options">#</a></span></h3> 635</section><section><h3><code>util.inspect(object[, showHidden[, depth[, colors]]])</code><span><a class="mark" href="#util_util_inspect_object_showhidden_depth_colors" id="util_util_inspect_object_showhidden_depth_colors">#</a></span></h3> 636<div class="api_metadata"> 637<details class="changelog"><summary>History</summary> 638<table> 639<tbody><tr><th>Version</th><th>Changes</th></tr> 640<tr><td>v13.0.0</td> 641<td><p>Circular references now include a marker to the reference.</p></td></tr> 642<tr><td>v14.6.0, v12.19.0</td> 643<td><p>If <code>object</code> is from a different <code>vm.Context</code> now, a custom inspection function on it will not receive context-specific arguments anymore.</p></td></tr> 644<tr><td>v13.13.0, v12.17.0</td> 645<td><p>The <code>maxStringLength</code> option is supported now.</p></td></tr> 646<tr><td>v13.5.0, v12.16.0</td> 647<td><p>User defined prototype properties are inspected in case <code>showHidden</code> is <code>true</code>.</p></td></tr> 648<tr><td>v12.0.0</td> 649<td><p>The <code>compact</code> options default is changed to <code>3</code> and the <code>breakLength</code> options default is changed to <code>80</code>.</p></td></tr> 650<tr><td>v12.0.0</td> 651<td><p>Internal properties no longer appear in the context argument of a custom inspection function.</p></td></tr> 652<tr><td>v11.11.0</td> 653<td><p>The <code>compact</code> option accepts numbers for a new output mode.</p></td></tr> 654<tr><td>v11.7.0</td> 655<td><p>ArrayBuffers now also show their binary contents.</p></td></tr> 656<tr><td>v11.5.0</td> 657<td><p>The <code>getters</code> option is supported now.</p></td></tr> 658<tr><td>v11.4.0</td> 659<td><p>The <code>depth</code> default changed back to <code>2</code>.</p></td></tr> 660<tr><td>v11.0.0</td> 661<td><p>The <code>depth</code> default changed to <code>20</code>.</p></td></tr> 662<tr><td>v11.0.0</td> 663<td><p>The inspection output is now limited to about 128 MB. Data above that size will not be fully inspected.</p></td></tr> 664<tr><td>v10.12.0</td> 665<td><p>The <code>sorted</code> option is supported now.</p></td></tr> 666<tr><td>v10.6.0</td> 667<td><p>Inspecting linked lists and similar objects is now possible up to the maximum call stack size.</p></td></tr> 668<tr><td>v10.0.0</td> 669<td><p>The <code>WeakMap</code> and <code>WeakSet</code> entries can now be inspected as well.</p></td></tr> 670<tr><td>v9.9.0</td> 671<td><p>The <code>compact</code> option is supported now.</p></td></tr> 672<tr><td>v6.6.0</td> 673<td><p>Custom inspection functions can now return <code>this</code>.</p></td></tr> 674<tr><td>v6.3.0</td> 675<td><p>The <code>breakLength</code> option is supported now.</p></td></tr> 676<tr><td>v6.1.0</td> 677<td><p>The <code>maxArrayLength</code> option is supported now; in particular, long arrays are truncated by default.</p></td></tr> 678<tr><td>v6.1.0</td> 679<td><p>The <code>showProxy</code> option is supported now.</p></td></tr> 680<tr><td>v0.3.0</td> 681<td><p><span>Added in: v0.3.0</span></p></td></tr> 682</tbody></table> 683</details> 684</div> 685<ul> 686<li><code>object</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a> Any JavaScript primitive or <code>Object</code>.</li> 687<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 688<ul> 689<li><code>showHidden</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> If <code>true</code>, <code>object</code>'s non-enumerable symbols and 690properties are included in the formatted result. <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap"><code>WeakMap</code></a> and 691<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet"><code>WeakSet</code></a> entries are also included as well as user defined prototype 692properties (excluding method properties). <strong>Default:</strong> <code>false</code>.</li> 693<li><code>depth</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> Specifies the number of times to recurse while formatting 694<code>object</code>. This is useful for inspecting large objects. To recurse up to 695the maximum call stack size pass <code>Infinity</code> or <code>null</code>. 696<strong>Default:</strong> <code>2</code>.</li> 697<li><code>colors</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> If <code>true</code>, the output is styled with ANSI color 698codes. Colors are customizable. See <a href="#util_customizing_util_inspect_colors">Customizing <code>util.inspect</code> colors</a>. 699<strong>Default:</strong> <code>false</code>.</li> 700<li><code>customInspect</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> If <code>false</code>, 701<code>[util.inspect.custom](depth, opts)</code> functions are not invoked. 702<strong>Default:</strong> <code>true</code>.</li> 703<li><code>showProxy</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> If <code>true</code>, <code>Proxy</code> inspection includes 704the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy#Terminology"><code>target</code> and <code>handler</code></a> objects. <strong>Default:</strong> <code>false</code>.</li> 705<li><code>maxArrayLength</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a> Specifies the maximum number of <code>Array</code>, 706<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray"><code>TypedArray</code></a>, <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap"><code>WeakMap</code></a> and <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet"><code>WeakSet</code></a> elements to include when 707formatting. Set to <code>null</code> or <code>Infinity</code> to show all elements. Set to <code>0</code> or 708negative to show no elements. <strong>Default:</strong> <code>100</code>.</li> 709<li><code>maxStringLength</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a> Specifies the maximum number of characters to 710include when formatting. Set to <code>null</code> or <code>Infinity</code> to show all elements. 711Set to <code>0</code> or negative to show no characters. <strong>Default:</strong> <code>Infinity</code>.</li> 712<li><code>breakLength</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a> The length at which input values are split across 713multiple lines. Set to <code>Infinity</code> to format the input as a single line 714(in combination with <code>compact</code> set to <code>true</code> or any number >= <code>1</code>). 715<strong>Default:</strong> <code>80</code>.</li> 716<li><code>compact</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer></a> Setting this to <code>false</code> causes each object key 717to be displayed on a new line. It will also add new lines to text that is 718longer than <code>breakLength</code>. If set to a number, the most <code>n</code> inner elements 719are united on a single line as long as all properties fit into 720<code>breakLength</code>. Short array elements are also grouped together. No 721text will be reduced below 16 characters, no matter the <code>breakLength</code> size. 722For more information, see the example below. <strong>Default:</strong> <code>3</code>.</li> 723<li><code>sorted</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a> If set to <code>true</code> or a function, all properties 724of an object, and <code>Set</code> and <code>Map</code> entries are sorted in the resulting 725string. If set to <code>true</code> the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort">default sort</a> is used. If set to a function, 726it is used as a <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#Parameters">compare function</a>.</li> 727<li><code>getters</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> If set to <code>true</code>, getters are inspected. If set 728to <code>'get'</code>, only getters without a corresponding setter are inspected. If 729set to <code>'set'</code>, only getters with a corresponding setter are inspected. 730This might cause side effects depending on the getter function. 731<strong>Default:</strong> <code>false</code>.</li> 732</ul> 733</li> 734<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> The representation of <code>object</code>.</li> 735</ul> 736<p>The <code>util.inspect()</code> method returns a string representation of <code>object</code> that is 737intended for debugging. The output of <code>util.inspect</code> may change at any time 738and should not be depended upon programmatically. Additional <code>options</code> may be 739passed that alter the result. 740<code>util.inspect()</code> will use the constructor's name and/or <code>@@toStringTag</code> to make 741an identifiable tag for an inspected value.</p> 742<pre><code class="language-js"><span class="hljs-keyword">class</span> <span class="hljs-title class_">Foo</span> { 743 get [<span class="hljs-title class_">Symbol</span>.<span class="hljs-property">toStringTag</span>]() { 744 <span class="hljs-keyword">return</span> <span class="hljs-string">'bar'</span>; 745 } 746} 747 748<span class="hljs-keyword">class</span> <span class="hljs-title class_">Bar</span> {} 749 750<span class="hljs-keyword">const</span> baz = <span class="hljs-title class_">Object</span>.<span class="hljs-title function_">create</span>(<span class="hljs-literal">null</span>, { [<span class="hljs-title class_">Symbol</span>.<span class="hljs-property">toStringTag</span>]: { <span class="hljs-attr">value</span>: <span class="hljs-string">'foo'</span> } }); 751 752util.<span class="hljs-title function_">inspect</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Foo</span>()); <span class="hljs-comment">// 'Foo [bar] {}'</span> 753util.<span class="hljs-title function_">inspect</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Bar</span>()); <span class="hljs-comment">// 'Bar {}'</span> 754util.<span class="hljs-title function_">inspect</span>(baz); <span class="hljs-comment">// '[foo] {}'</span></code></pre> 755<p>Circular references point to their anchor by using a reference index:</p> 756<pre><code class="language-js"><span class="hljs-keyword">const</span> { inspect } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 757 758<span class="hljs-keyword">const</span> obj = {}; 759obj.<span class="hljs-property">a</span> = [obj]; 760obj.<span class="hljs-property">b</span> = {}; 761obj.<span class="hljs-property">b</span>.<span class="hljs-property">inner</span> = obj.<span class="hljs-property">b</span>; 762obj.<span class="hljs-property">b</span>.<span class="hljs-property">obj</span> = obj; 763 764<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title function_">inspect</span>(obj)); 765<span class="hljs-comment">// <ref *1> {</span> 766<span class="hljs-comment">// a: [ [Circular *1] ],</span> 767<span class="hljs-comment">// b: <ref *2> { inner: [Circular *2], obj: [Circular *1] }</span> 768<span class="hljs-comment">// }</span></code></pre> 769<p>The following example inspects all properties of the <code>util</code> object:</p> 770<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 771 772<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(util.<span class="hljs-title function_">inspect</span>(util, { <span class="hljs-attr">showHidden</span>: <span class="hljs-literal">true</span>, <span class="hljs-attr">depth</span>: <span class="hljs-literal">null</span> }));</code></pre> 773<p>The following example highlights the effect of the <code>compact</code> option:</p> 774<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 775 776<span class="hljs-keyword">const</span> o = { 777 <span class="hljs-attr">a</span>: [<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, [[ 778 <span class="hljs-string">'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do '</span> + 779 <span class="hljs-string">'eiusmod tempor incididunt ut labore et dolore magna aliqua.'</span>, 780 <span class="hljs-string">'test'</span>, 781 <span class="hljs-string">'foo'</span>]], <span class="hljs-number">4</span>], 782 <span class="hljs-attr">b</span>: <span class="hljs-keyword">new</span> <span class="hljs-title class_">Map</span>([[<span class="hljs-string">'za'</span>, <span class="hljs-number">1</span>], [<span class="hljs-string">'zb'</span>, <span class="hljs-string">'test'</span>]]) 783}; 784<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(util.<span class="hljs-title function_">inspect</span>(o, { <span class="hljs-attr">compact</span>: <span class="hljs-literal">true</span>, <span class="hljs-attr">depth</span>: <span class="hljs-number">5</span>, <span class="hljs-attr">breakLength</span>: <span class="hljs-number">80</span> })); 785 786<span class="hljs-comment">// { a:</span> 787<span class="hljs-comment">// [ 1,</span> 788<span class="hljs-comment">// 2,</span> 789<span class="hljs-comment">// [ [ 'Lorem ipsum dolor sit amet, consectetur [...]', // A long line</span> 790<span class="hljs-comment">// 'test',</span> 791<span class="hljs-comment">// 'foo' ] ],</span> 792<span class="hljs-comment">// 4 ],</span> 793<span class="hljs-comment">// b: Map(2) { 'za' => 1, 'zb' => 'test' } }</span> 794 795<span class="hljs-comment">// Setting `compact` to false changes the output to be more reader friendly.</span> 796<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(util.<span class="hljs-title function_">inspect</span>(o, { <span class="hljs-attr">compact</span>: <span class="hljs-literal">false</span>, <span class="hljs-attr">depth</span>: <span class="hljs-number">5</span>, <span class="hljs-attr">breakLength</span>: <span class="hljs-number">80</span> })); 797 798<span class="hljs-comment">// {</span> 799<span class="hljs-comment">// a: [</span> 800<span class="hljs-comment">// 1,</span> 801<span class="hljs-comment">// 2,</span> 802<span class="hljs-comment">// [</span> 803<span class="hljs-comment">// [</span> 804<span class="hljs-comment">// 'Lorem ipsum dolor sit amet, consectetur ' +</span> 805<span class="hljs-comment">// 'adipiscing elit, sed do eiusmod tempor ' +</span> 806<span class="hljs-comment">// 'incididunt ut labore et dolore magna ' +</span> 807<span class="hljs-comment">// 'aliqua.,</span> 808<span class="hljs-comment">// 'test',</span> 809<span class="hljs-comment">// 'foo'</span> 810<span class="hljs-comment">// ]</span> 811<span class="hljs-comment">// ],</span> 812<span class="hljs-comment">// 4</span> 813<span class="hljs-comment">// ],</span> 814<span class="hljs-comment">// b: Map(2) {</span> 815<span class="hljs-comment">// 'za' => 1,</span> 816<span class="hljs-comment">// 'zb' => 'test'</span> 817<span class="hljs-comment">// }</span> 818<span class="hljs-comment">// }</span> 819 820<span class="hljs-comment">// Setting `breakLength` to e.g. 150 will print the "Lorem ipsum" text in a</span> 821<span class="hljs-comment">// single line.</span> 822<span class="hljs-comment">// Reducing the `breakLength` will split the "Lorem ipsum" text in smaller</span> 823<span class="hljs-comment">// chunks.</span></code></pre> 824<p>The <code>showHidden</code> option allows <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap"><code>WeakMap</code></a> and <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet"><code>WeakSet</code></a> entries to be 825inspected. If there are more entries than <code>maxArrayLength</code>, there is no 826guarantee which entries are displayed. That means retrieving the same 827<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet"><code>WeakSet</code></a> entries twice may result in different output. Furthermore, entries 828with no remaining strong references may be garbage collected at any time.</p> 829<pre><code class="language-js"><span class="hljs-keyword">const</span> { inspect } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 830 831<span class="hljs-keyword">const</span> obj = { <span class="hljs-attr">a</span>: <span class="hljs-number">1</span> }; 832<span class="hljs-keyword">const</span> obj2 = { <span class="hljs-attr">b</span>: <span class="hljs-number">2</span> }; 833<span class="hljs-keyword">const</span> weakSet = <span class="hljs-keyword">new</span> <span class="hljs-title class_">WeakSet</span>([obj, obj2]); 834 835<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title function_">inspect</span>(weakSet, { <span class="hljs-attr">showHidden</span>: <span class="hljs-literal">true</span> })); 836<span class="hljs-comment">// WeakSet { { a: 1 }, { b: 2 } }</span></code></pre> 837<p>The <code>sorted</code> option ensures that an object's property insertion order does not 838impact the result of <code>util.inspect()</code>.</p> 839<pre><code class="language-js"><span class="hljs-keyword">const</span> { inspect } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 840<span class="hljs-keyword">const</span> assert = <span class="hljs-built_in">require</span>(<span class="hljs-string">'assert'</span>); 841 842<span class="hljs-keyword">const</span> o1 = { 843 <span class="hljs-attr">b</span>: [<span class="hljs-number">2</span>, <span class="hljs-number">3</span>, <span class="hljs-number">1</span>], 844 <span class="hljs-attr">a</span>: <span class="hljs-string">'`a` comes before `b`'</span>, 845 <span class="hljs-attr">c</span>: <span class="hljs-keyword">new</span> <span class="hljs-title class_">Set</span>([<span class="hljs-number">2</span>, <span class="hljs-number">3</span>, <span class="hljs-number">1</span>]) 846}; 847<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title function_">inspect</span>(o1, { <span class="hljs-attr">sorted</span>: <span class="hljs-literal">true</span> })); 848<span class="hljs-comment">// { a: '`a` comes before `b`', b: [ 2, 3, 1 ], c: Set(3) { 1, 2, 3 } }</span> 849<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-title function_">inspect</span>(o1, { <span class="hljs-attr">sorted</span>: <span class="hljs-function">(<span class="hljs-params">a, b</span>) =></span> b.<span class="hljs-title function_">localeCompare</span>(a) })); 850<span class="hljs-comment">// { c: Set(3) { 3, 2, 1 }, b: [ 2, 3, 1 ], a: '`a` comes before `b`' }</span> 851 852<span class="hljs-keyword">const</span> o2 = { 853 <span class="hljs-attr">c</span>: <span class="hljs-keyword">new</span> <span class="hljs-title class_">Set</span>([<span class="hljs-number">2</span>, <span class="hljs-number">1</span>, <span class="hljs-number">3</span>]), 854 <span class="hljs-attr">a</span>: <span class="hljs-string">'`a` comes before `b`'</span>, 855 <span class="hljs-attr">b</span>: [<span class="hljs-number">2</span>, <span class="hljs-number">3</span>, <span class="hljs-number">1</span>] 856}; 857assert.<span class="hljs-property">strict</span>.<span class="hljs-title function_">equal</span>( 858 <span class="hljs-title function_">inspect</span>(o1, { <span class="hljs-attr">sorted</span>: <span class="hljs-literal">true</span> }), 859 <span class="hljs-title function_">inspect</span>(o2, { <span class="hljs-attr">sorted</span>: <span class="hljs-literal">true</span> }) 860);</code></pre> 861<p><code>util.inspect()</code> is a synchronous method intended for debugging. Its maximum 862output length is approximately 128 MB. Inputs that result in longer output will 863be truncated.</p> 864<h4>Customizing <code>util.inspect</code> colors<span><a class="mark" href="#util_customizing_util_inspect_colors" id="util_customizing_util_inspect_colors">#</a></span></h4> 865 866<p>Color output (if enabled) of <code>util.inspect</code> is customizable globally 867via the <code>util.inspect.styles</code> and <code>util.inspect.colors</code> properties.</p> 868<p><code>util.inspect.styles</code> is a map associating a style name to a color from 869<code>util.inspect.colors</code>.</p> 870<p>The default styles and associated colors are:</p> 871<ul> 872<li><code>bigint</code>: <code>yellow</code></li> 873<li><code>boolean</code>: <code>yellow</code></li> 874<li><code>date</code>: <code>magenta</code></li> 875<li><code>module</code>: <code>underline</code></li> 876<li><code>name</code>: (no styling)</li> 877<li><code>null</code>: <code>bold</code></li> 878<li><code>number</code>: <code>yellow</code></li> 879<li><code>regexp</code>: <code>red</code></li> 880<li><code>special</code>: <code>cyan</code> (e.g., <code>Proxies</code>)</li> 881<li><code>string</code>: <code>green</code></li> 882<li><code>symbol</code>: <code>green</code></li> 883<li><code>undefined</code>: <code>grey</code></li> 884</ul> 885<p>Color styling uses ANSI control codes that may not be supported on all 886terminals. To verify color support use <a href="tty.html#tty_writestream_hascolors_count_env"><code>tty.hasColors()</code></a>.</p> 887<p>Predefined control codes are listed below (grouped as "Modifiers", "Foreground 888colors", and "Background colors").</p> 889<h5>Modifiers<span><a class="mark" href="#util_modifiers" id="util_modifiers">#</a></span></h5> 890<p>Modifier support varies throughout different terminals. They will mostly be 891ignored, if not supported.</p> 892<ul> 893<li><code>reset</code> - Resets all (color) modifiers to their defaults</li> 894<li><strong>bold</strong> - Make text bold</li> 895<li><em>italic</em> - Make text italic</li> 896<li><span style="border-bottom: 1px;">underline</span> - Make text underlined</li> 897<li><del>strikethrough</del> - Puts a horizontal line through the center of the text 898(Alias: <code>strikeThrough</code>, <code>crossedout</code>, <code>crossedOut</code>)</li> 899<li><code>hidden</code> - Prints the text, but makes it invisible (Alias: conceal)</li> 900<li><span style="opacity: 0.5;">dim</span> - Decreased color intensity (Alias: 901<code>faint</code>)</li> 902<li><span style="border-top: 1px">overlined</span> - Make text overlined</li> 903<li>blink - Hides and shows the text in an interval</li> 904<li><span style="filter: invert(100%)">inverse</span> - Swap foreground and 905background colors (Alias: <code>swapcolors</code>, <code>swapColors</code>)</li> 906<li><span style="border-bottom: 1px double;">doubleunderline</span> - Make text 907double underlined (Alias: <code>doubleUnderline</code>)</li> 908<li><span style="border: 1px">framed</span> - Draw a frame around the text</li> 909</ul> 910<h5>Foreground colors<span><a class="mark" href="#util_foreground_colors" id="util_foreground_colors">#</a></span></h5> 911<ul> 912<li><code>black</code></li> 913<li><code>red</code></li> 914<li><code>green</code></li> 915<li><code>yellow</code></li> 916<li><code>blue</code></li> 917<li><code>magenta</code></li> 918<li><code>cyan</code></li> 919<li><code>white</code></li> 920<li><code>gray</code> (alias: <code>grey</code>, <code>blackBright</code>)</li> 921<li><code>redBright</code></li> 922<li><code>greenBright</code></li> 923<li><code>yellowBright</code></li> 924<li><code>blueBright</code></li> 925<li><code>magentaBright</code></li> 926<li><code>cyanBright</code></li> 927<li><code>whiteBright</code></li> 928</ul> 929<h5>Background colors<span><a class="mark" href="#util_background_colors" id="util_background_colors">#</a></span></h5> 930<ul> 931<li><code>bgBlack</code></li> 932<li><code>bgRed</code></li> 933<li><code>bgGreen</code></li> 934<li><code>bgYellow</code></li> 935<li><code>bgBlue</code></li> 936<li><code>bgMagenta</code></li> 937<li><code>bgCyan</code></li> 938<li><code>bgWhite</code></li> 939<li><code>bgGray</code> (alias: <code>bgGrey</code>, <code>bgBlackBright</code>)</li> 940<li><code>bgRedBright</code></li> 941<li><code>bgGreenBright</code></li> 942<li><code>bgYellowBright</code></li> 943<li><code>bgBlueBright</code></li> 944<li><code>bgMagentaBright</code></li> 945<li><code>bgCyanBright</code></li> 946<li><code>bgWhiteBright</code></li> 947</ul> 948<h4>Custom inspection functions on objects<span><a class="mark" href="#util_custom_inspection_functions_on_objects" id="util_custom_inspection_functions_on_objects">#</a></span></h4> 949 950<p>Objects may also define their own 951<a href="#util_util_inspect_custom"><code>[util.inspect.custom](depth, opts)</code></a> function, 952which <code>util.inspect()</code> will invoke and use the result of when inspecting 953the object:</p> 954<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 955 956<span class="hljs-keyword">class</span> <span class="hljs-title class_">Box</span> { 957 <span class="hljs-title function_">constructor</span>(<span class="hljs-params">value</span>) { 958 <span class="hljs-variable language_">this</span>.<span class="hljs-property">value</span> = value; 959 } 960 961 [util.<span class="hljs-property">inspect</span>.<span class="hljs-property">custom</span>](depth, options) { 962 <span class="hljs-keyword">if</span> (depth < <span class="hljs-number">0</span>) { 963 <span class="hljs-keyword">return</span> options.<span class="hljs-title function_">stylize</span>(<span class="hljs-string">'[Box]'</span>, <span class="hljs-string">'special'</span>); 964 } 965 966 <span class="hljs-keyword">const</span> newOptions = <span class="hljs-title class_">Object</span>.<span class="hljs-title function_">assign</span>({}, options, { 967 <span class="hljs-attr">depth</span>: options.<span class="hljs-property">depth</span> === <span class="hljs-literal">null</span> ? <span class="hljs-literal">null</span> : options.<span class="hljs-property">depth</span> - <span class="hljs-number">1</span> 968 }); 969 970 <span class="hljs-comment">// Five space padding because that's the size of "Box< ".</span> 971 <span class="hljs-keyword">const</span> padding = <span class="hljs-string">' '</span>.<span class="hljs-title function_">repeat</span>(<span class="hljs-number">5</span>); 972 <span class="hljs-keyword">const</span> inner = util.<span class="hljs-title function_">inspect</span>(<span class="hljs-variable language_">this</span>.<span class="hljs-property">value</span>, newOptions) 973 .<span class="hljs-title function_">replace</span>(<span class="hljs-regexp">/\n/g</span>, <span class="hljs-string">`\n<span class="hljs-subst">${padding}</span>`</span>); 974 <span class="hljs-keyword">return</span> <span class="hljs-string">`<span class="hljs-subst">${options.stylize(<span class="hljs-string">'Box'</span>, <span class="hljs-string">'special'</span>)}</span>< <span class="hljs-subst">${inner}</span> >`</span>; 975 } 976} 977 978<span class="hljs-keyword">const</span> box = <span class="hljs-keyword">new</span> <span class="hljs-title class_">Box</span>(<span class="hljs-literal">true</span>); 979 980util.<span class="hljs-title function_">inspect</span>(box); 981<span class="hljs-comment">// Returns: "Box< true >"</span></code></pre> 982<p>Custom <code>[util.inspect.custom](depth, opts)</code> functions typically return a string 983but may return a value of any type that will be formatted accordingly by 984<code>util.inspect()</code>.</p> 985<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 986 987<span class="hljs-keyword">const</span> obj = { <span class="hljs-attr">foo</span>: <span class="hljs-string">'this will not show up in the inspect() output'</span> }; 988obj[util.<span class="hljs-property">inspect</span>.<span class="hljs-property">custom</span>] = <span class="hljs-function">(<span class="hljs-params">depth</span>) =></span> { 989 <span class="hljs-keyword">return</span> { <span class="hljs-attr">bar</span>: <span class="hljs-string">'baz'</span> }; 990}; 991 992util.<span class="hljs-title function_">inspect</span>(obj); 993<span class="hljs-comment">// Returns: "{ bar: 'baz' }"</span></code></pre> 994<h4><code>util.inspect.custom</code><span><a class="mark" href="#util_util_inspect_custom" id="util_util_inspect_custom">#</a></span></h4> 995<div class="api_metadata"> 996<details class="changelog"><summary>History</summary> 997<table> 998<tbody><tr><th>Version</th><th>Changes</th></tr> 999<tr><td>v10.12.0</td> 1000<td><p>This is now defined as a shared symbol.</p></td></tr> 1001<tr><td>v6.6.0</td> 1002<td><p><span>Added in: v6.6.0</span></p></td></tr> 1003</tbody></table> 1004</details> 1005</div> 1006<ul> 1007<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Symbol_type" class="type"><symbol></a> that can be used to declare custom inspect functions.</li> 1008</ul> 1009<p>In addition to being accessible through <code>util.inspect.custom</code>, this 1010symbol is <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/for">registered globally</a> and can be 1011accessed in any environment as <code>Symbol.for('nodejs.util.inspect.custom')</code>.</p> 1012<pre><code class="language-js"><span class="hljs-keyword">const</span> inspect = <span class="hljs-title class_">Symbol</span>.<span class="hljs-title function_">for</span>(<span class="hljs-string">'nodejs.util.inspect.custom'</span>); 1013 1014<span class="hljs-keyword">class</span> <span class="hljs-title class_">Password</span> { 1015 <span class="hljs-title function_">constructor</span>(<span class="hljs-params">value</span>) { 1016 <span class="hljs-variable language_">this</span>.<span class="hljs-property">value</span> = value; 1017 } 1018 1019 <span class="hljs-title function_">toString</span>(<span class="hljs-params"></span>) { 1020 <span class="hljs-keyword">return</span> <span class="hljs-string">'xxxxxxxx'</span>; 1021 } 1022 1023 [inspect]() { 1024 <span class="hljs-keyword">return</span> <span class="hljs-string">`Password <<span class="hljs-subst">${<span class="hljs-variable language_">this</span>.toString()}</span>>`</span>; 1025 } 1026} 1027 1028<span class="hljs-keyword">const</span> password = <span class="hljs-keyword">new</span> <span class="hljs-title class_">Password</span>(<span class="hljs-string">'r0sebud'</span>); 1029<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(password); 1030<span class="hljs-comment">// Prints Password <xxxxxxxx></span></code></pre> 1031<p>See <a href="#util_custom_inspection_functions_on_objects">Custom inspection functions on Objects</a> for more details.</p> 1032<h4><code>util.inspect.defaultOptions</code><span><a class="mark" href="#util_util_inspect_defaultoptions" id="util_util_inspect_defaultoptions">#</a></span></h4> 1033<div class="api_metadata"> 1034<span>Added in: v6.4.0</span> 1035</div> 1036<p>The <code>defaultOptions</code> value allows customization of the default options used by 1037<code>util.inspect</code>. This is useful for functions like <code>console.log</code> or 1038<code>util.format</code> which implicitly call into <code>util.inspect</code>. It shall be set to an 1039object containing one or more valid <a href="#util_util_inspect_object_options"><code>util.inspect()</code></a> options. Setting 1040option properties directly is also supported.</p> 1041<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 1042<span class="hljs-keyword">const</span> arr = <span class="hljs-title class_">Array</span>(<span class="hljs-number">101</span>).<span class="hljs-title function_">fill</span>(<span class="hljs-number">0</span>); 1043 1044<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(arr); <span class="hljs-comment">// Logs the truncated array</span> 1045util.<span class="hljs-property">inspect</span>.<span class="hljs-property">defaultOptions</span>.<span class="hljs-property">maxArrayLength</span> = <span class="hljs-literal">null</span>; 1046<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(arr); <span class="hljs-comment">// logs the full array</span></code></pre> 1047</section><section><h3><code>util.isDeepStrictEqual(val1, val2)</code><span><a class="mark" href="#util_util_isdeepstrictequal_val1_val2" id="util_util_isdeepstrictequal_val1_val2">#</a></span></h3> 1048<div class="api_metadata"> 1049<span>Added in: v9.0.0</span> 1050</div> 1051<ul> 1052<li><code>val1</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1053<li><code>val2</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1054<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1055</ul> 1056<p>Returns <code>true</code> if there is deep strict equality between <code>val1</code> and <code>val2</code>. 1057Otherwise, returns <code>false</code>.</p> 1058<p>See <a href="assert.html#assert_assert_deepstrictequal_actual_expected_message"><code>assert.deepStrictEqual()</code></a> for more information about deep strict 1059equality.</p> 1060</section><section><h3><code>util.promisify(original)</code><span><a class="mark" href="#util_util_promisify_original" id="util_util_promisify_original">#</a></span></h3> 1061<div class="api_metadata"> 1062<span>Added in: v8.0.0</span> 1063</div> 1064<ul> 1065<li><code>original</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 1066<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> 1067</ul> 1068<p>Takes a function following the common error-first callback style, i.e. taking 1069an <code>(err, value) => ...</code> callback as the last argument, and returns a version 1070that returns promises.</p> 1071<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 1072<span class="hljs-keyword">const</span> fs = <span class="hljs-built_in">require</span>(<span class="hljs-string">'fs'</span>); 1073 1074<span class="hljs-keyword">const</span> stat = util.<span class="hljs-title function_">promisify</span>(fs.<span class="hljs-property">stat</span>); 1075<span class="hljs-title function_">stat</span>(<span class="hljs-string">'.'</span>).<span class="hljs-title function_">then</span>(<span class="hljs-function">(<span class="hljs-params">stats</span>) =></span> { 1076 <span class="hljs-comment">// Do something with `stats`</span> 1077}).<span class="hljs-title function_">catch</span>(<span class="hljs-function">(<span class="hljs-params">error</span>) =></span> { 1078 <span class="hljs-comment">// Handle the error.</span> 1079});</code></pre> 1080<p>Or, equivalently using <code>async function</code>s:</p> 1081<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 1082<span class="hljs-keyword">const</span> fs = <span class="hljs-built_in">require</span>(<span class="hljs-string">'fs'</span>); 1083 1084<span class="hljs-keyword">const</span> stat = util.<span class="hljs-title function_">promisify</span>(fs.<span class="hljs-property">stat</span>); 1085 1086<span class="hljs-keyword">async</span> <span class="hljs-keyword">function</span> <span class="hljs-title function_">callStat</span>(<span class="hljs-params"></span>) { 1087 <span class="hljs-keyword">const</span> stats = <span class="hljs-keyword">await</span> <span class="hljs-title function_">stat</span>(<span class="hljs-string">'.'</span>); 1088 <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`This directory is owned by <span class="hljs-subst">${stats.uid}</span>`</span>); 1089}</code></pre> 1090<p>If there is an <code>original[util.promisify.custom]</code> property present, <code>promisify</code> 1091will return its value, see <a href="#util_custom_promisified_functions">Custom promisified functions</a>.</p> 1092<p><code>promisify()</code> assumes that <code>original</code> is a function taking a callback as its 1093final argument in all cases. If <code>original</code> is not a function, <code>promisify()</code> 1094will throw an error. If <code>original</code> is a function but its last argument is not 1095an error-first callback, it will still be passed an error-first 1096callback as its last argument.</p> 1097<p>Using <code>promisify()</code> on class methods or other methods that use <code>this</code> may not 1098work as expected unless handled specially:</p> 1099<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 1100 1101<span class="hljs-keyword">class</span> <span class="hljs-title class_">Foo</span> { 1102 <span class="hljs-title function_">constructor</span>(<span class="hljs-params"></span>) { 1103 <span class="hljs-variable language_">this</span>.<span class="hljs-property">a</span> = <span class="hljs-number">42</span>; 1104 } 1105 1106 <span class="hljs-title function_">bar</span>(<span class="hljs-params">callback</span>) { 1107 <span class="hljs-title function_">callback</span>(<span class="hljs-literal">null</span>, <span class="hljs-variable language_">this</span>.<span class="hljs-property">a</span>); 1108 } 1109} 1110 1111<span class="hljs-keyword">const</span> foo = <span class="hljs-keyword">new</span> <span class="hljs-title class_">Foo</span>(); 1112 1113<span class="hljs-keyword">const</span> naiveBar = util.<span class="hljs-title function_">promisify</span>(foo.<span class="hljs-property">bar</span>); 1114<span class="hljs-comment">// TypeError: Cannot read property 'a' of undefined</span> 1115<span class="hljs-comment">// naiveBar().then(a => console.log(a));</span> 1116 1117naiveBar.<span class="hljs-title function_">call</span>(foo).<span class="hljs-title function_">then</span>(<span class="hljs-function">(<span class="hljs-params">a</span>) =></span> <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(a)); <span class="hljs-comment">// '42'</span> 1118 1119<span class="hljs-keyword">const</span> bindBar = naiveBar.<span class="hljs-title function_">bind</span>(foo); 1120<span class="hljs-title function_">bindBar</span>().<span class="hljs-title function_">then</span>(<span class="hljs-function">(<span class="hljs-params">a</span>) =></span> <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(a)); <span class="hljs-comment">// '42'</span></code></pre> 1121<h4>Custom promisified functions<span><a class="mark" href="#util_custom_promisified_functions" id="util_custom_promisified_functions">#</a></span></h4> 1122<p>Using the <code>util.promisify.custom</code> symbol one can override the return value of 1123<a href="#util_util_promisify_original"><code>util.promisify()</code></a>:</p> 1124<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 1125 1126<span class="hljs-keyword">function</span> <span class="hljs-title function_">doSomething</span>(<span class="hljs-params">foo, callback</span>) { 1127 <span class="hljs-comment">// ...</span> 1128} 1129 1130doSomething[util.<span class="hljs-property">promisify</span>.<span class="hljs-property">custom</span>] = <span class="hljs-function">(<span class="hljs-params">foo</span>) =></span> { 1131 <span class="hljs-keyword">return</span> <span class="hljs-title function_">getPromiseSomehow</span>(); 1132}; 1133 1134<span class="hljs-keyword">const</span> promisified = util.<span class="hljs-title function_">promisify</span>(doSomething); 1135<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(promisified === doSomething[util.<span class="hljs-property">promisify</span>.<span class="hljs-property">custom</span>]); 1136<span class="hljs-comment">// prints 'true'</span></code></pre> 1137<p>This can be useful for cases where the original function does not follow the 1138standard format of taking an error-first callback as the last argument.</p> 1139<p>For example, with a function that takes in 1140<code>(foo, onSuccessCallback, onErrorCallback)</code>:</p> 1141<pre><code class="language-js">doSomething[util.<span class="hljs-property">promisify</span>.<span class="hljs-property">custom</span>] = <span class="hljs-function">(<span class="hljs-params">foo</span>) =></span> { 1142 <span class="hljs-keyword">return</span> <span class="hljs-keyword">new</span> <span class="hljs-title class_">Promise</span>(<span class="hljs-function">(<span class="hljs-params">resolve, reject</span>) =></span> { 1143 <span class="hljs-title function_">doSomething</span>(foo, resolve, reject); 1144 }); 1145};</code></pre> 1146<p>If <code>promisify.custom</code> is defined but is not a function, <code>promisify()</code> will 1147throw an error.</p> 1148<h4><code>util.promisify.custom</code><span><a class="mark" href="#util_util_promisify_custom" id="util_util_promisify_custom">#</a></span></h4> 1149<div class="api_metadata"> 1150<details class="changelog"><summary>History</summary> 1151<table> 1152<tbody><tr><th>Version</th><th>Changes</th></tr> 1153<tr><td>v13.12.0, v12.16.2</td> 1154<td><p>This is now defined as a shared symbol.</p></td></tr> 1155<tr><td>v8.0.0</td> 1156<td><p><span>Added in: v8.0.0</span></p></td></tr> 1157</tbody></table> 1158</details> 1159</div> 1160<ul> 1161<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Symbol_type" class="type"><symbol></a> that can be used to declare custom promisified variants of functions, 1162see <a href="#util_custom_promisified_functions">Custom promisified functions</a>.</li> 1163</ul> 1164<p>In addition to being accessible through <code>util.promisify.custom</code>, this 1165symbol is <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/for">registered globally</a> and can be 1166accessed in any environment as <code>Symbol.for('nodejs.util.promisify.custom')</code>.</p> 1167<p>For example, with a function that takes in 1168<code>(foo, onSuccessCallback, onErrorCallback)</code>:</p> 1169<pre><code class="language-js"><span class="hljs-keyword">const</span> kCustomPromisifiedSymbol = <span class="hljs-title class_">Symbol</span>.<span class="hljs-title function_">for</span>(<span class="hljs-string">'nodejs.util.promisify.custom'</span>); 1170 1171doSomething[kCustomPromisifiedSymbol] = <span class="hljs-function">(<span class="hljs-params">foo</span>) =></span> { 1172 <span class="hljs-keyword">return</span> <span class="hljs-keyword">new</span> <span class="hljs-title class_">Promise</span>(<span class="hljs-function">(<span class="hljs-params">resolve, reject</span>) =></span> { 1173 <span class="hljs-title function_">doSomething</span>(foo, resolve, reject); 1174 }); 1175};</code></pre> 1176</section><section><h3>Class: <code>util.TextDecoder</code><span><a class="mark" href="#util_class_util_textdecoder" id="util_class_util_textdecoder">#</a></span></h3> 1177<div class="api_metadata"> 1178<span>Added in: v8.3.0</span> 1179</div> 1180<p>An implementation of the <a href="https://encoding.spec.whatwg.org/">WHATWG Encoding Standard</a> <code>TextDecoder</code> API.</p> 1181<pre><code class="language-js"><span class="hljs-keyword">const</span> decoder = <span class="hljs-keyword">new</span> <span class="hljs-title class_">TextDecoder</span>(<span class="hljs-string">'shift_jis'</span>); 1182<span class="hljs-keyword">let</span> string = <span class="hljs-string">''</span>; 1183<span class="hljs-keyword">let</span> buffer; 1184<span class="hljs-keyword">while</span> (buffer = <span class="hljs-title function_">getNextChunkSomehow</span>()) { 1185 string += decoder.<span class="hljs-title function_">decode</span>(buffer, { <span class="hljs-attr">stream</span>: <span class="hljs-literal">true</span> }); 1186} 1187string += decoder.<span class="hljs-title function_">decode</span>(); <span class="hljs-comment">// end-of-stream</span></code></pre> 1188<h4>WHATWG supported encodings<span><a class="mark" href="#util_whatwg_supported_encodings" id="util_whatwg_supported_encodings">#</a></span></h4> 1189<p>Per the <a href="https://encoding.spec.whatwg.org/">WHATWG Encoding Standard</a>, the encodings supported by the 1190<code>TextDecoder</code> API are outlined in the tables below. For each encoding, 1191one or more aliases may be used.</p> 1192<p>Different Node.js build configurations support different sets of encodings. 1193(see <a href="intl.html">Internationalization</a>)</p> 1194<h5>Encodings supported by default (with full ICU data)<span><a class="mark" href="#util_encodings_supported_by_default_with_full_icu_data" id="util_encodings_supported_by_default_with_full_icu_data">#</a></span></h5> 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340<table><thead><tr><th>Encoding</th><th>Aliases</th></tr></thead><tbody><tr><td><code>'ibm866'</code></td><td><code>'866'</code>, <code>'cp866'</code>, <code>'csibm866'</code></td></tr><tr><td><code>'iso-8859-2'</code></td><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></tr><tr><td><code>'iso-8859-3'</code></td><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></tr><tr><td><code>'iso-8859-4'</code></td><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></tr><tr><td><code>'iso-8859-5'</code></td><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></tr><tr><td><code>'iso-8859-6'</code></td><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></tr><tr><td><code>'iso-8859-7'</code></td><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></tr><tr><td><code>'iso-8859-8'</code></td><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></tr><tr><td><code>'iso-8859-8-i'</code></td><td><code>'csiso88598i'</code>, <code>'logical'</code></td></tr><tr><td><code>'iso-8859-10'</code></td><td><code>'csisolatin6'</code>, <code>'iso-ir-157'</code>, <code>'iso8859-10'</code>, <code>'iso885910'</code>, <code>'l6'</code>, <code>'latin6'</code></td></tr><tr><td><code>'iso-8859-13'</code></td><td><code>'iso8859-13'</code>, <code>'iso885913'</code></td></tr><tr><td><code>'iso-8859-14'</code></td><td><code>'iso8859-14'</code>, <code>'iso885914'</code></td></tr><tr><td><code>'iso-8859-15'</code></td><td><code>'csisolatin9'</code>, <code>'iso8859-15'</code>, <code>'iso885915'</code>, <code>'iso_8859-15'</code>, <code>'l9'</code></td></tr><tr><td><code>'koi8-r'</code></td><td><code>'cskoi8r'</code>, <code>'koi'</code>, <code>'koi8'</code>, <code>'koi8_r'</code></td></tr><tr><td><code>'koi8-u'</code></td><td><code>'koi8-ru'</code></td></tr><tr><td><code>'macintosh'</code></td><td><code>'csmacintosh'</code>, <code>'mac'</code>, <code>'x-mac-roman'</code></td></tr><tr><td><code>'windows-874'</code></td><td><code>'dos-874'</code>, <code>'iso-8859-11'</code>, <code>'iso8859-11'</code>, <code>'iso885911'</code>, <code>'tis-620'</code></td></tr><tr><td><code>'windows-1250'</code></td><td><code>'cp1250'</code>, <code>'x-cp1250'</code></td></tr><tr><td><code>'windows-1251'</code></td><td><code>'cp1251'</code>, <code>'x-cp1251'</code></td></tr><tr><td><code>'windows-1252'</code></td><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></tr><tr><td><code>'windows-1253'</code></td><td><code>'cp1253'</code>, <code>'x-cp1253'</code></td></tr><tr><td><code>'windows-1254'</code></td><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></tr><tr><td><code>'windows-1255'</code></td><td><code>'cp1255'</code>, <code>'x-cp1255'</code></td></tr><tr><td><code>'windows-1256'</code></td><td><code>'cp1256'</code>, <code>'x-cp1256'</code></td></tr><tr><td><code>'windows-1257'</code></td><td><code>'cp1257'</code>, <code>'x-cp1257'</code></td></tr><tr><td><code>'windows-1258'</code></td><td><code>'cp1258'</code>, <code>'x-cp1258'</code></td></tr><tr><td><code>'x-mac-cyrillic'</code></td><td><code>'x-mac-ukrainian'</code></td></tr><tr><td><code>'gbk'</code></td><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></tr><tr><td><code>'gb18030'</code></td><td></td></tr><tr><td><code>'big5'</code></td><td><code>'big5-hkscs'</code>, <code>'cn-big5'</code>, <code>'csbig5'</code>, <code>'x-x-big5'</code></td></tr><tr><td><code>'euc-jp'</code></td><td><code>'cseucpkdfmtjapanese'</code>, <code>'x-euc-jp'</code></td></tr><tr><td><code>'iso-2022-jp'</code></td><td><code>'csiso2022jp'</code></td></tr><tr><td><code>'shift_jis'</code></td><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></tr><tr><td><code>'euc-kr'</code></td><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></tr></tbody></table> 1341<h5>Encodings supported when Node.js is built with the <code>small-icu</code> option<span><a class="mark" href="#util_encodings_supported_when_node_js_is_built_with_the_small_icu_option" id="util_encodings_supported_when_node_js_is_built_with_the_small_icu_option">#</a></span></h5> 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363<table><thead><tr><th>Encoding</th><th>Aliases</th></tr></thead><tbody><tr><td><code>'utf-8'</code></td><td><code>'unicode-1-1-utf-8'</code>, <code>'utf8'</code></td></tr><tr><td><code>'utf-16le'</code></td><td><code>'utf-16'</code></td></tr><tr><td><code>'utf-16be'</code></td><td></td></tr></tbody></table> 1364<h5>Encodings supported when ICU is disabled<span><a class="mark" href="#util_encodings_supported_when_icu_is_disabled" id="util_encodings_supported_when_icu_is_disabled">#</a></span></h5> 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382<table><thead><tr><th>Encoding</th><th>Aliases</th></tr></thead><tbody><tr><td><code>'utf-8'</code></td><td><code>'unicode-1-1-utf-8'</code>, <code>'utf8'</code></td></tr><tr><td><code>'utf-16le'</code></td><td><code>'utf-16'</code></td></tr></tbody></table> 1383<p>The <code>'iso-8859-16'</code> encoding listed in the <a href="https://encoding.spec.whatwg.org/">WHATWG Encoding Standard</a> 1384is not supported.</p> 1385<h4><code>new TextDecoder([encoding[, options]])</code><span><a class="mark" href="#util_new_textdecoder_encoding_options" id="util_new_textdecoder_encoding_options">#</a></span></h4> 1386<div class="api_metadata"> 1387<details class="changelog"><summary>History</summary> 1388<table> 1389<tbody><tr><th>Version</th><th>Changes</th></tr> 1390<tr><td>v11.0.0</td> 1391<td><p>The class is now available on the global object.</p></td></tr> 1392<tr><td>v8.3.0</td> 1393<td><p><span>Added in: v8.3.0</span></p></td></tr> 1394</tbody></table> 1395</details> 1396</div> 1397<ul> 1398<li><code>encoding</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> Identifies the <code>encoding</code> that this <code>TextDecoder</code> instance 1399supports. <strong>Default:</strong> <code>'utf-8'</code>.</li> 1400<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 1401<ul> 1402<li><code>fatal</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> <code>true</code> if decoding failures are fatal. 1403This option is not supported when ICU is disabled 1404(see <a href="intl.html">Internationalization</a>). <strong>Default:</strong> <code>false</code>.</li> 1405<li><code>ignoreBOM</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> When <code>true</code>, the <code>TextDecoder</code> will include the byte 1406order mark in the decoded result. When <code>false</code>, the byte order mark will 1407be removed from the output. This option is only used when <code>encoding</code> is 1408<code>'utf-8'</code>, <code>'utf-16be'</code> or <code>'utf-16le'</code>. <strong>Default:</strong> <code>false</code>.</li> 1409</ul> 1410</li> 1411</ul> 1412<p>Creates an new <code>TextDecoder</code> instance. The <code>encoding</code> may specify one of the 1413supported encodings or an alias.</p> 1414<p>The <code>TextDecoder</code> class is also available on the global object.</p> 1415<h4><code>textDecoder.decode([input[, options]])</code><span><a class="mark" href="#util_textdecoder_decode_input_options" id="util_textdecoder_decode_input_options">#</a></span></h4> 1416<ul> 1417<li><code>input</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer" class="type"><ArrayBuffer></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView" class="type"><DataView></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray" class="type"><TypedArray></a> An <code>ArrayBuffer</code>, <code>DataView</code> or 1418<code>TypedArray</code> instance containing the encoded data.</li> 1419<li><code>options</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 1420<ul> 1421<li><code>stream</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> <code>true</code> if additional chunks of data are expected. 1422<strong>Default:</strong> <code>false</code>.</li> 1423</ul> 1424</li> 1425<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 1426</ul> 1427<p>Decodes the <code>input</code> and returns a string. If <code>options.stream</code> is <code>true</code>, any 1428incomplete byte sequences occurring at the end of the <code>input</code> are buffered 1429internally and emitted after the next call to <code>textDecoder.decode()</code>.</p> 1430<p>If <code>textDecoder.fatal</code> is <code>true</code>, decoding errors that occur will result in a 1431<code>TypeError</code> being thrown.</p> 1432<h4><code>textDecoder.encoding</code><span><a class="mark" href="#util_textdecoder_encoding" id="util_textdecoder_encoding">#</a></span></h4> 1433<ul> 1434<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 1435</ul> 1436<p>The encoding supported by the <code>TextDecoder</code> instance.</p> 1437<h4><code>textDecoder.fatal</code><span><a class="mark" href="#util_textdecoder_fatal" id="util_textdecoder_fatal">#</a></span></h4> 1438<ul> 1439<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1440</ul> 1441<p>The value will be <code>true</code> if decoding errors result in a <code>TypeError</code> being 1442thrown.</p> 1443<h4><code>textDecoder.ignoreBOM</code><span><a class="mark" href="#util_textdecoder_ignorebom" id="util_textdecoder_ignorebom">#</a></span></h4> 1444<ul> 1445<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1446</ul> 1447<p>The value will be <code>true</code> if the decoding result will include the byte order 1448mark.</p> 1449</section><section><h3>Class: <code>util.TextEncoder</code><span><a class="mark" href="#util_class_util_textencoder" id="util_class_util_textencoder">#</a></span></h3> 1450<div class="api_metadata"> 1451<details class="changelog"><summary>History</summary> 1452<table> 1453<tbody><tr><th>Version</th><th>Changes</th></tr> 1454<tr><td>v11.0.0</td> 1455<td><p>The class is now available on the global object.</p></td></tr> 1456<tr><td>v8.3.0</td> 1457<td><p><span>Added in: v8.3.0</span></p></td></tr> 1458</tbody></table> 1459</details> 1460</div> 1461<p>An implementation of the <a href="https://encoding.spec.whatwg.org/">WHATWG Encoding Standard</a> <code>TextEncoder</code> API. All 1462instances of <code>TextEncoder</code> only support UTF-8 encoding.</p> 1463<pre><code class="language-js"><span class="hljs-keyword">const</span> encoder = <span class="hljs-keyword">new</span> <span class="hljs-title class_">TextEncoder</span>(); 1464<span class="hljs-keyword">const</span> uint8array = encoder.<span class="hljs-title function_">encode</span>(<span class="hljs-string">'this is some data'</span>);</code></pre> 1465<p>The <code>TextEncoder</code> class is also available on the global object.</p> 1466<h4><code>textEncoder.encode([input])</code><span><a class="mark" href="#util_textencoder_encode_input" id="util_textencoder_encode_input">#</a></span></h4> 1467<ul> 1468<li><code>input</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> The text to encode. <strong>Default:</strong> an empty string.</li> 1469<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array" class="type"><Uint8Array></a></li> 1470</ul> 1471<p>UTF-8 encodes the <code>input</code> string and returns a <code>Uint8Array</code> containing the 1472encoded bytes.</p> 1473<h4><code>textEncoder.encodeInto(src, dest)</code><span><a class="mark" href="#util_textencoder_encodeinto_src_dest" id="util_textencoder_encodeinto_src_dest">#</a></span></h4> 1474<ul> 1475<li><code>src</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> The text to encode.</li> 1476<li><code>dest</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array" class="type"><Uint8Array></a> The array to hold the encode result.</li> 1477<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> 1478<ul> 1479<li><code>read</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The read Unicode code units of src.</li> 1480<li><code>written</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The written UTF-8 bytes of dest.</li> 1481</ul> 1482</li> 1483</ul> 1484<p>UTF-8 encodes the <code>src</code> string to the <code>dest</code> Uint8Array and returns an object 1485containing the read Unicode code units and written UTF-8 bytes.</p> 1486<pre><code class="language-js"><span class="hljs-keyword">const</span> encoder = <span class="hljs-keyword">new</span> <span class="hljs-title class_">TextEncoder</span>(); 1487<span class="hljs-keyword">const</span> src = <span class="hljs-string">'this is some data'</span>; 1488<span class="hljs-keyword">const</span> dest = <span class="hljs-keyword">new</span> <span class="hljs-title class_">Uint</span>8<span class="hljs-built_in">Array</span>(<span class="hljs-number">10</span>); 1489<span class="hljs-keyword">const</span> { read, written } = encoder.<span class="hljs-title function_">encodeInto</span>(src, dest);</code></pre> 1490<h4><code>textEncoder.encoding</code><span><a class="mark" href="#util_textencoder_encoding" id="util_textencoder_encoding">#</a></span></h4> 1491<ul> 1492<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 1493</ul> 1494<p>The encoding supported by the <code>TextEncoder</code> instance. Always set to <code>'utf-8'</code>.</p> 1495</section><section><h3><code>util.toUSVString(string)</code><span><a class="mark" href="#util_util_tousvstring_string" id="util_util_tousvstring_string">#</a></span></h3> 1496<div class="api_metadata"> 1497<span>Added in: v14.18.0</span> 1498</div> 1499<ul> 1500<li><code>string</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 1501</ul> 1502<p>Returns the <code>string</code> after replacing any surrogate code points 1503(or equivalently, any unpaired surrogate code units) with the 1504Unicode "replacement character" U+FFFD.</p> 1505</section><section><h3><code>util.types</code><span><a class="mark" href="#util_util_types" id="util_util_types">#</a></span></h3> 1506<div class="api_metadata"> 1507<span>Added in: v10.0.0</span> 1508</div> 1509<p><code>util.types</code> provides type checks for different kinds of built-in objects. 1510Unlike <code>instanceof</code> or <code>Object.prototype.toString.call(value)</code>, these checks do 1511not inspect properties of the object that are accessible from JavaScript (like 1512their prototype), and usually have the overhead of calling into C++.</p> 1513<p>The result generally does not make any guarantees about what kinds of 1514properties or behavior a value exposes in JavaScript. They are primarily 1515useful for addon developers who prefer to do type checking in JavaScript.</p> 1516<h4><code>util.types.isAnyArrayBuffer(value)</code><span><a class="mark" href="#util_util_types_isanyarraybuffer_value" id="util_util_types_isanyarraybuffer_value">#</a></span></h4> 1517<div class="api_metadata"> 1518<span>Added in: v10.0.0</span> 1519</div> 1520<ul> 1521<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1522<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1523</ul> 1524<p>Returns <code>true</code> if the value is a built-in <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer"><code>ArrayBuffer</code></a> or 1525<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer"><code>SharedArrayBuffer</code></a> instance.</p> 1526<p>See also <a href="#util_util_types_isarraybuffer_value"><code>util.types.isArrayBuffer()</code></a> and 1527<a href="#util_util_types_issharedarraybuffer_value"><code>util.types.isSharedArrayBuffer()</code></a>.</p> 1528<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isAnyArrayBuffer</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayBuffer</span>()); <span class="hljs-comment">// Returns true</span> 1529util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isAnyArrayBuffer</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">SharedArrayBuffer</span>()); <span class="hljs-comment">// Returns true</span></code></pre> 1530<h4><code>util.types.isArrayBufferView(value)</code><span><a class="mark" href="#util_util_types_isarraybufferview_value" id="util_util_types_isarraybufferview_value">#</a></span></h4> 1531<div class="api_metadata"> 1532<span>Added in: v10.0.0</span> 1533</div> 1534<ul> 1535<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1536<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1537</ul> 1538<p>Returns <code>true</code> if the value is an instance of one of the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer"><code>ArrayBuffer</code></a> 1539views, such as typed array objects or <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView"><code>DataView</code></a>. Equivalent to 1540<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/isView"><code>ArrayBuffer.isView()</code></a>.</p> 1541<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isArrayBufferView</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Int</span>8<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// true</span> 1542util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isArrayBufferView</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(<span class="hljs-string">'hello world'</span>)); <span class="hljs-comment">// true</span> 1543util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isArrayBufferView</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">DataView</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayBuffer</span>(<span class="hljs-number">16</span>))); <span class="hljs-comment">// true</span> 1544util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isArrayBufferView</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayBuffer</span>()); <span class="hljs-comment">// false</span></code></pre> 1545<h4><code>util.types.isArgumentsObject(value)</code><span><a class="mark" href="#util_util_types_isargumentsobject_value" id="util_util_types_isargumentsobject_value">#</a></span></h4> 1546<div class="api_metadata"> 1547<span>Added in: v10.0.0</span> 1548</div> 1549<ul> 1550<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1551<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1552</ul> 1553<p>Returns <code>true</code> if the value is an <code>arguments</code> object.</p> 1554<!-- eslint-disable prefer-rest-params --> 1555<pre><code class="language-js"><span class="hljs-keyword">function</span> <span class="hljs-title function_">foo</span>(<span class="hljs-params"></span>) { 1556 util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isArgumentsObject</span>(<span class="hljs-variable language_">arguments</span>); <span class="hljs-comment">// Returns true</span> 1557}</code></pre> 1558<h4><code>util.types.isArrayBuffer(value)</code><span><a class="mark" href="#util_util_types_isarraybuffer_value" id="util_util_types_isarraybuffer_value">#</a></span></h4> 1559<div class="api_metadata"> 1560<span>Added in: v10.0.0</span> 1561</div> 1562<ul> 1563<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1564<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1565</ul> 1566<p>Returns <code>true</code> if the value is a built-in <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer"><code>ArrayBuffer</code></a> instance. 1567This does <em>not</em> include <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer"><code>SharedArrayBuffer</code></a> instances. Usually, it is 1568desirable to test for both; See <a href="#util_util_types_isanyarraybuffer_value"><code>util.types.isAnyArrayBuffer()</code></a> for that.</p> 1569<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isArrayBuffer</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayBuffer</span>()); <span class="hljs-comment">// Returns true</span> 1570util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isArrayBuffer</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">SharedArrayBuffer</span>()); <span class="hljs-comment">// Returns false</span></code></pre> 1571<h4><code>util.types.isAsyncFunction(value)</code><span><a class="mark" href="#util_util_types_isasyncfunction_value" id="util_util_types_isasyncfunction_value">#</a></span></h4> 1572<div class="api_metadata"> 1573<span>Added in: v10.0.0</span> 1574</div> 1575<ul> 1576<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1577<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1578</ul> 1579<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>. 1580This only reports back what the JavaScript engine is seeing; 1581in particular, the return value may not match the original source code if 1582a transpilation tool was used.</p> 1583<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isAsyncFunction</span>(<span class="hljs-keyword">function</span> <span class="hljs-title function_">foo</span>(<span class="hljs-params"></span>) {}); <span class="hljs-comment">// Returns false</span> 1584util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isAsyncFunction</span>(<span class="hljs-keyword">async</span> <span class="hljs-keyword">function</span> <span class="hljs-title function_">foo</span>(<span class="hljs-params"></span>) {}); <span class="hljs-comment">// Returns true</span></code></pre> 1585<h4><code>util.types.isBigInt64Array(value)</code><span><a class="mark" href="#util_util_types_isbigint64array_value" id="util_util_types_isbigint64array_value">#</a></span></h4> 1586<div class="api_metadata"> 1587<span>Added in: v10.0.0</span> 1588</div> 1589<ul> 1590<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1591<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1592</ul> 1593<p>Returns <code>true</code> if the value is a <code>BigInt64Array</code> instance.</p> 1594<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isBigInt64Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">BigInt</span>64<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// Returns true</span> 1595util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isBigInt64Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">BigUint</span>64<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// Returns false</span></code></pre> 1596<h4><code>util.types.isBigUint64Array(value)</code><span><a class="mark" href="#util_util_types_isbiguint64array_value" id="util_util_types_isbiguint64array_value">#</a></span></h4> 1597<div class="api_metadata"> 1598<span>Added in: v10.0.0</span> 1599</div> 1600<ul> 1601<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1602<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1603</ul> 1604<p>Returns <code>true</code> if the value is a <code>BigUint64Array</code> instance.</p> 1605<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isBigUint64Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">BigInt</span>64<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// Returns false</span> 1606util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isBigUint64Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">BigUint</span>64<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// Returns true</span></code></pre> 1607<h4><code>util.types.isBooleanObject(value)</code><span><a class="mark" href="#util_util_types_isbooleanobject_value" id="util_util_types_isbooleanobject_value">#</a></span></h4> 1608<div class="api_metadata"> 1609<span>Added in: v10.0.0</span> 1610</div> 1611<ul> 1612<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1613<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1614</ul> 1615<p>Returns <code>true</code> if the value is a boolean object, e.g. created 1616by <code>new Boolean()</code>.</p> 1617<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isBooleanObject</span>(<span class="hljs-literal">false</span>); <span class="hljs-comment">// Returns false</span> 1618util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isBooleanObject</span>(<span class="hljs-literal">true</span>); <span class="hljs-comment">// Returns false</span> 1619util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isBooleanObject</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Boolean</span>(<span class="hljs-literal">false</span>)); <span class="hljs-comment">// Returns true</span> 1620util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isBooleanObject</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Boolean</span>(<span class="hljs-literal">true</span>)); <span class="hljs-comment">// Returns true</span> 1621util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isBooleanObject</span>(<span class="hljs-title class_">Boolean</span>(<span class="hljs-literal">false</span>)); <span class="hljs-comment">// Returns false</span> 1622util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isBooleanObject</span>(<span class="hljs-title class_">Boolean</span>(<span class="hljs-literal">true</span>)); <span class="hljs-comment">// Returns false</span></code></pre> 1623<h4><code>util.types.isBoxedPrimitive(value)</code><span><a class="mark" href="#util_util_types_isboxedprimitive_value" id="util_util_types_isboxedprimitive_value">#</a></span></h4> 1624<div class="api_metadata"> 1625<span>Added in: v10.11.0</span> 1626</div> 1627<ul> 1628<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1629<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1630</ul> 1631<p>Returns <code>true</code> if the value is any boxed primitive object, e.g. created 1632by <code>new Boolean()</code>, <code>new String()</code> or <code>Object(Symbol())</code>.</p> 1633<p>For example:</p> 1634<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isBoxedPrimitive</span>(<span class="hljs-literal">false</span>); <span class="hljs-comment">// Returns false</span> 1635util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isBoxedPrimitive</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Boolean</span>(<span class="hljs-literal">false</span>)); <span class="hljs-comment">// Returns true</span> 1636util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isBoxedPrimitive</span>(<span class="hljs-title class_">Symbol</span>(<span class="hljs-string">'foo'</span>)); <span class="hljs-comment">// Returns false</span> 1637util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isBoxedPrimitive</span>(<span class="hljs-title class_">Object</span>(<span class="hljs-title class_">Symbol</span>(<span class="hljs-string">'foo'</span>))); <span class="hljs-comment">// Returns true</span> 1638util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isBoxedPrimitive</span>(<span class="hljs-title class_">Object</span>(<span class="hljs-title class_">BigInt</span>(<span class="hljs-number">5</span>))); <span class="hljs-comment">// Returns true</span></code></pre> 1639<h4><code>util.types.isDataView(value)</code><span><a class="mark" href="#util_util_types_isdataview_value" id="util_util_types_isdataview_value">#</a></span></h4> 1640<div class="api_metadata"> 1641<span>Added in: v10.0.0</span> 1642</div> 1643<ul> 1644<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1645<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1646</ul> 1647<p>Returns <code>true</code> if the value is a built-in <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView"><code>DataView</code></a> instance.</p> 1648<pre><code class="language-js"><span class="hljs-keyword">const</span> ab = <span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayBuffer</span>(<span class="hljs-number">20</span>); 1649util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isDataView</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">DataView</span>(ab)); <span class="hljs-comment">// Returns true</span> 1650util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isDataView</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Float</span>64<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// Returns false</span></code></pre> 1651<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> 1652<h4><code>util.types.isDate(value)</code><span><a class="mark" href="#util_util_types_isdate_value" id="util_util_types_isdate_value">#</a></span></h4> 1653<div class="api_metadata"> 1654<span>Added in: v10.0.0</span> 1655</div> 1656<ul> 1657<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1658<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1659</ul> 1660<p>Returns <code>true</code> if the value is a built-in <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date"><code>Date</code></a> instance.</p> 1661<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isDate</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Date</span>()); <span class="hljs-comment">// Returns true</span></code></pre> 1662<h4><code>util.types.isExternal(value)</code><span><a class="mark" href="#util_util_types_isexternal_value" id="util_util_types_isexternal_value">#</a></span></h4> 1663<div class="api_metadata"> 1664<span>Added in: v10.0.0</span> 1665</div> 1666<ul> 1667<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1668<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1669</ul> 1670<p>Returns <code>true</code> if the value is a native <code>External</code> value.</p> 1671<p>A native <code>External</code> value is a special type of object that contains a 1672raw C++ pointer (<code>void*</code>) for access from native code, and has no other 1673properties. Such objects are created either by Node.js internals or native 1674addons. 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 1675<code>null</code> prototype.</p> 1676<pre><code class="language-c"><span class="hljs-meta">#<span class="hljs-keyword">include</span> <span class="hljs-string"><js_native_api.h></span></span> 1677<span class="hljs-meta">#<span class="hljs-keyword">include</span> <span class="hljs-string"><stdlib.h></span></span> 1678napi_value result; 1679<span class="hljs-keyword">static</span> napi_value <span class="hljs-title function_">MyNapi</span><span class="hljs-params">(napi_env env, napi_callback_info info)</span> { 1680 <span class="hljs-type">int</span>* raw = (<span class="hljs-type">int</span>*) <span class="hljs-built_in">malloc</span>(<span class="hljs-number">1024</span>); 1681 napi_status status = napi_create_external(env, (<span class="hljs-type">void</span>*) raw, <span class="hljs-literal">NULL</span>, <span class="hljs-literal">NULL</span>, &result); 1682 <span class="hljs-keyword">if</span> (status != napi_ok) { 1683 napi_throw_error(env, <span class="hljs-literal">NULL</span>, <span class="hljs-string">"napi_create_external failed"</span>); 1684 <span class="hljs-keyword">return</span> <span class="hljs-literal">NULL</span>; 1685 } 1686 <span class="hljs-keyword">return</span> result; 1687} 1688... 1689DECLARE_NAPI_PROPERTY(<span class="hljs-string">"myNapi"</span>, MyNapi) 1690...</code></pre> 1691<pre><code class="language-js"><span class="hljs-keyword">const</span> native = <span class="hljs-built_in">require</span>(<span class="hljs-string">'napi_addon.node'</span>); 1692<span class="hljs-keyword">const</span> data = native.<span class="hljs-title function_">myNapi</span>(); 1693util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isExternal</span>(data); <span class="hljs-comment">// returns true</span> 1694util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isExternal</span>(<span class="hljs-number">0</span>); <span class="hljs-comment">// returns false</span> 1695util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isExternal</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">String</span>(<span class="hljs-string">'foo'</span>)); <span class="hljs-comment">// returns false</span></code></pre> 1696<p>For further information on <code>napi_create_external</code>, refer to 1697<a href="n-api.html#n_api_napi_create_external"><code>napi_create_external()</code></a>.</p> 1698<h4><code>util.types.isFloat32Array(value)</code><span><a class="mark" href="#util_util_types_isfloat32array_value" id="util_util_types_isfloat32array_value">#</a></span></h4> 1699<div class="api_metadata"> 1700<span>Added in: v10.0.0</span> 1701</div> 1702<ul> 1703<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1704<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1705</ul> 1706<p>Returns <code>true</code> if the value is a built-in <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float32Array"><code>Float32Array</code></a> instance.</p> 1707<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isFloat32Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayBuffer</span>()); <span class="hljs-comment">// Returns false</span> 1708util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isFloat32Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Float</span>32<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// Returns true</span> 1709util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isFloat32Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Float</span>64<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// Returns false</span></code></pre> 1710<h4><code>util.types.isFloat64Array(value)</code><span><a class="mark" href="#util_util_types_isfloat64array_value" id="util_util_types_isfloat64array_value">#</a></span></h4> 1711<div class="api_metadata"> 1712<span>Added in: v10.0.0</span> 1713</div> 1714<ul> 1715<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1716<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1717</ul> 1718<p>Returns <code>true</code> if the value is a built-in <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array"><code>Float64Array</code></a> instance.</p> 1719<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isFloat64Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayBuffer</span>()); <span class="hljs-comment">// Returns false</span> 1720util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isFloat64Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Uint</span>8<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// Returns false</span> 1721util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isFloat64Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Float</span>64<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// Returns true</span></code></pre> 1722<h4><code>util.types.isGeneratorFunction(value)</code><span><a class="mark" href="#util_util_types_isgeneratorfunction_value" id="util_util_types_isgeneratorfunction_value">#</a></span></h4> 1723<div class="api_metadata"> 1724<span>Added in: v10.0.0</span> 1725</div> 1726<ul> 1727<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1728<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1729</ul> 1730<p>Returns <code>true</code> if the value is a generator function. 1731This only reports back what the JavaScript engine is seeing; 1732in particular, the return value may not match the original source code if 1733a transpilation tool was used.</p> 1734<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isGeneratorFunction</span>(<span class="hljs-keyword">function</span> <span class="hljs-title function_">foo</span>(<span class="hljs-params"></span>) {}); <span class="hljs-comment">// Returns false</span> 1735util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isGeneratorFunction</span>(<span class="hljs-keyword">function</span>* <span class="hljs-title function_">foo</span>(<span class="hljs-params"></span>) {}); <span class="hljs-comment">// Returns true</span></code></pre> 1736<h4><code>util.types.isGeneratorObject(value)</code><span><a class="mark" href="#util_util_types_isgeneratorobject_value" id="util_util_types_isgeneratorobject_value">#</a></span></h4> 1737<div class="api_metadata"> 1738<span>Added in: v10.0.0</span> 1739</div> 1740<ul> 1741<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1742<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1743</ul> 1744<p>Returns <code>true</code> if the value is a generator object as returned from a 1745built-in generator function. 1746This only reports back what the JavaScript engine is seeing; 1747in particular, the return value may not match the original source code if 1748a transpilation tool was used.</p> 1749<pre><code class="language-js"><span class="hljs-keyword">function</span>* <span class="hljs-title function_">foo</span>(<span class="hljs-params"></span>) {} 1750<span class="hljs-keyword">const</span> generator = <span class="hljs-title function_">foo</span>(); 1751util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isGeneratorObject</span>(generator); <span class="hljs-comment">// Returns true</span></code></pre> 1752<h4><code>util.types.isInt8Array(value)</code><span><a class="mark" href="#util_util_types_isint8array_value" id="util_util_types_isint8array_value">#</a></span></h4> 1753<div class="api_metadata"> 1754<span>Added in: v10.0.0</span> 1755</div> 1756<ul> 1757<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1758<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1759</ul> 1760<p>Returns <code>true</code> if the value is a built-in <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int8Array"><code>Int8Array</code></a> instance.</p> 1761<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isInt8Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayBuffer</span>()); <span class="hljs-comment">// Returns false</span> 1762util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isInt8Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Int</span>8<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// Returns true</span> 1763util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isInt8Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Float</span>64<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// Returns false</span></code></pre> 1764<h4><code>util.types.isInt16Array(value)</code><span><a class="mark" href="#util_util_types_isint16array_value" id="util_util_types_isint16array_value">#</a></span></h4> 1765<div class="api_metadata"> 1766<span>Added in: v10.0.0</span> 1767</div> 1768<ul> 1769<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1770<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1771</ul> 1772<p>Returns <code>true</code> if the value is a built-in <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int16Array"><code>Int16Array</code></a> instance.</p> 1773<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isInt16Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayBuffer</span>()); <span class="hljs-comment">// Returns false</span> 1774util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isInt16Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Int</span>16<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// Returns true</span> 1775util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isInt16Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Float</span>64<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// Returns false</span></code></pre> 1776<h4><code>util.types.isInt32Array(value)</code><span><a class="mark" href="#util_util_types_isint32array_value" id="util_util_types_isint32array_value">#</a></span></h4> 1777<div class="api_metadata"> 1778<span>Added in: v10.0.0</span> 1779</div> 1780<ul> 1781<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1782<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1783</ul> 1784<p>Returns <code>true</code> if the value is a built-in <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array"><code>Int32Array</code></a> instance.</p> 1785<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isInt32Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayBuffer</span>()); <span class="hljs-comment">// Returns false</span> 1786util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isInt32Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Int</span>32<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// Returns true</span> 1787util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isInt32Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Float</span>64<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// Returns false</span></code></pre> 1788<h4><code>util.types.isMap(value)</code><span><a class="mark" href="#util_util_types_ismap_value" id="util_util_types_ismap_value">#</a></span></h4> 1789<div class="api_metadata"> 1790<span>Added in: v10.0.0</span> 1791</div> 1792<ul> 1793<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1794<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1795</ul> 1796<p>Returns <code>true</code> if the value is a built-in <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map"><code>Map</code></a> instance.</p> 1797<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isMap</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Map</span>()); <span class="hljs-comment">// Returns true</span></code></pre> 1798<h4><code>util.types.isMapIterator(value)</code><span><a class="mark" href="#util_util_types_ismapiterator_value" id="util_util_types_ismapiterator_value">#</a></span></h4> 1799<div class="api_metadata"> 1800<span>Added in: v10.0.0</span> 1801</div> 1802<ul> 1803<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1804<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1805</ul> 1806<p>Returns <code>true</code> if the value is an iterator returned for a built-in 1807<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map"><code>Map</code></a> instance.</p> 1808<pre><code class="language-js"><span class="hljs-keyword">const</span> map = <span class="hljs-keyword">new</span> <span class="hljs-title class_">Map</span>(); 1809util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isMapIterator</span>(map.<span class="hljs-title function_">keys</span>()); <span class="hljs-comment">// Returns true</span> 1810util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isMapIterator</span>(map.<span class="hljs-title function_">values</span>()); <span class="hljs-comment">// Returns true</span> 1811util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isMapIterator</span>(map.<span class="hljs-title function_">entries</span>()); <span class="hljs-comment">// Returns true</span> 1812util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isMapIterator</span>(map[<span class="hljs-title class_">Symbol</span>.<span class="hljs-property">iterator</span>]()); <span class="hljs-comment">// Returns true</span></code></pre> 1813<h4><code>util.types.isModuleNamespaceObject(value)</code><span><a class="mark" href="#util_util_types_ismodulenamespaceobject_value" id="util_util_types_ismodulenamespaceobject_value">#</a></span></h4> 1814<div class="api_metadata"> 1815<span>Added in: v10.0.0</span> 1816</div> 1817<ul> 1818<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1819<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1820</ul> 1821<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> 1822<!-- eslint-skip --> 1823<pre><code class="language-js"><span class="hljs-keyword">import</span> * <span class="hljs-keyword">as</span> ns <span class="hljs-keyword">from</span> <span class="hljs-string">'./a.js'</span>; 1824 1825util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isModuleNamespaceObject</span>(ns); <span class="hljs-comment">// Returns true</span></code></pre> 1826<h4><code>util.types.isNativeError(value)</code><span><a class="mark" href="#util_util_types_isnativeerror_value" id="util_util_types_isnativeerror_value">#</a></span></h4> 1827<div class="api_metadata"> 1828<span>Added in: v10.0.0</span> 1829</div> 1830<ul> 1831<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1832<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1833</ul> 1834<p>Returns <code>true</code> if the value is an instance of a built-in <a href="errors.html#errors_class_error"><code>Error</code></a> type.</p> 1835<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isNativeError</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Error</span>()); <span class="hljs-comment">// Returns true</span> 1836util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isNativeError</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">TypeError</span>()); <span class="hljs-comment">// Returns true</span> 1837util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isNativeError</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">RangeError</span>()); <span class="hljs-comment">// Returns true</span></code></pre> 1838<h4><code>util.types.isNumberObject(value)</code><span><a class="mark" href="#util_util_types_isnumberobject_value" id="util_util_types_isnumberobject_value">#</a></span></h4> 1839<div class="api_metadata"> 1840<span>Added in: v10.0.0</span> 1841</div> 1842<ul> 1843<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1844<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1845</ul> 1846<p>Returns <code>true</code> if the value is a number object, e.g. created 1847by <code>new Number()</code>.</p> 1848<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isNumberObject</span>(<span class="hljs-number">0</span>); <span class="hljs-comment">// Returns false</span> 1849util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isNumberObject</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Number</span>(<span class="hljs-number">0</span>)); <span class="hljs-comment">// Returns true</span></code></pre> 1850<h4><code>util.types.isPromise(value)</code><span><a class="mark" href="#util_util_types_ispromise_value" id="util_util_types_ispromise_value">#</a></span></h4> 1851<div class="api_metadata"> 1852<span>Added in: v10.0.0</span> 1853</div> 1854<ul> 1855<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1856<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1857</ul> 1858<p>Returns <code>true</code> if the value is a built-in <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise"><code>Promise</code></a>.</p> 1859<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isPromise</span>(<span class="hljs-title class_">Promise</span>.<span class="hljs-title function_">resolve</span>(<span class="hljs-number">42</span>)); <span class="hljs-comment">// Returns true</span></code></pre> 1860<h4><code>util.types.isProxy(value)</code><span><a class="mark" href="#util_util_types_isproxy_value" id="util_util_types_isproxy_value">#</a></span></h4> 1861<div class="api_metadata"> 1862<span>Added in: v10.0.0</span> 1863</div> 1864<ul> 1865<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1866<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1867</ul> 1868<p>Returns <code>true</code> if the value is a <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy"><code>Proxy</code></a> instance.</p> 1869<pre><code class="language-js"><span class="hljs-keyword">const</span> target = {}; 1870<span class="hljs-keyword">const</span> proxy = <span class="hljs-keyword">new</span> <span class="hljs-title class_">Proxy</span>(target, {}); 1871util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isProxy</span>(target); <span class="hljs-comment">// Returns false</span> 1872util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isProxy</span>(proxy); <span class="hljs-comment">// Returns true</span></code></pre> 1873<h4><code>util.types.isRegExp(value)</code><span><a class="mark" href="#util_util_types_isregexp_value" id="util_util_types_isregexp_value">#</a></span></h4> 1874<div class="api_metadata"> 1875<span>Added in: v10.0.0</span> 1876</div> 1877<ul> 1878<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1879<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1880</ul> 1881<p>Returns <code>true</code> if the value is a regular expression object.</p> 1882<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isRegExp</span>(<span class="hljs-regexp">/abc/</span>); <span class="hljs-comment">// Returns true</span> 1883util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isRegExp</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">RegExp</span>(<span class="hljs-string">'abc'</span>)); <span class="hljs-comment">// Returns true</span></code></pre> 1884<h4><code>util.types.isSet(value)</code><span><a class="mark" href="#util_util_types_isset_value" id="util_util_types_isset_value">#</a></span></h4> 1885<div class="api_metadata"> 1886<span>Added in: v10.0.0</span> 1887</div> 1888<ul> 1889<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1890<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1891</ul> 1892<p>Returns <code>true</code> if the value is a built-in <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set"><code>Set</code></a> instance.</p> 1893<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isSet</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Set</span>()); <span class="hljs-comment">// Returns true</span></code></pre> 1894<h4><code>util.types.isSetIterator(value)</code><span><a class="mark" href="#util_util_types_issetiterator_value" id="util_util_types_issetiterator_value">#</a></span></h4> 1895<div class="api_metadata"> 1896<span>Added in: v10.0.0</span> 1897</div> 1898<ul> 1899<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1900<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1901</ul> 1902<p>Returns <code>true</code> if the value is an iterator returned for a built-in 1903<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set"><code>Set</code></a> instance.</p> 1904<pre><code class="language-js"><span class="hljs-keyword">const</span> set = <span class="hljs-keyword">new</span> <span class="hljs-title class_">Set</span>(); 1905util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isSetIterator</span>(set.<span class="hljs-title function_">keys</span>()); <span class="hljs-comment">// Returns true</span> 1906util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isSetIterator</span>(set.<span class="hljs-title function_">values</span>()); <span class="hljs-comment">// Returns true</span> 1907util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isSetIterator</span>(set.<span class="hljs-title function_">entries</span>()); <span class="hljs-comment">// Returns true</span> 1908util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isSetIterator</span>(set[<span class="hljs-title class_">Symbol</span>.<span class="hljs-property">iterator</span>]()); <span class="hljs-comment">// Returns true</span></code></pre> 1909<h4><code>util.types.isSharedArrayBuffer(value)</code><span><a class="mark" href="#util_util_types_issharedarraybuffer_value" id="util_util_types_issharedarraybuffer_value">#</a></span></h4> 1910<div class="api_metadata"> 1911<span>Added in: v10.0.0</span> 1912</div> 1913<ul> 1914<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1915<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1916</ul> 1917<p>Returns <code>true</code> if the value is a built-in <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer"><code>SharedArrayBuffer</code></a> instance. 1918This does <em>not</em> include <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer"><code>ArrayBuffer</code></a> instances. Usually, it is 1919desirable to test for both; See <a href="#util_util_types_isanyarraybuffer_value"><code>util.types.isAnyArrayBuffer()</code></a> for that.</p> 1920<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isSharedArrayBuffer</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayBuffer</span>()); <span class="hljs-comment">// Returns false</span> 1921util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isSharedArrayBuffer</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">SharedArrayBuffer</span>()); <span class="hljs-comment">// Returns true</span></code></pre> 1922<h4><code>util.types.isStringObject(value)</code><span><a class="mark" href="#util_util_types_isstringobject_value" id="util_util_types_isstringobject_value">#</a></span></h4> 1923<div class="api_metadata"> 1924<span>Added in: v10.0.0</span> 1925</div> 1926<ul> 1927<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1928<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1929</ul> 1930<p>Returns <code>true</code> if the value is a string object, e.g. created 1931by <code>new String()</code>.</p> 1932<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isStringObject</span>(<span class="hljs-string">'foo'</span>); <span class="hljs-comment">// Returns false</span> 1933util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isStringObject</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">String</span>(<span class="hljs-string">'foo'</span>)); <span class="hljs-comment">// Returns true</span></code></pre> 1934<h4><code>util.types.isSymbolObject(value)</code><span><a class="mark" href="#util_util_types_issymbolobject_value" id="util_util_types_issymbolobject_value">#</a></span></h4> 1935<div class="api_metadata"> 1936<span>Added in: v10.0.0</span> 1937</div> 1938<ul> 1939<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1940<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1941</ul> 1942<p>Returns <code>true</code> if the value is a symbol object, created 1943by calling <code>Object()</code> on a <code>Symbol</code> primitive.</p> 1944<pre><code class="language-js"><span class="hljs-keyword">const</span> symbol = <span class="hljs-title class_">Symbol</span>(<span class="hljs-string">'foo'</span>); 1945util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isSymbolObject</span>(symbol); <span class="hljs-comment">// Returns false</span> 1946util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isSymbolObject</span>(<span class="hljs-title class_">Object</span>(symbol)); <span class="hljs-comment">// Returns true</span></code></pre> 1947<h4><code>util.types.isTypedArray(value)</code><span><a class="mark" href="#util_util_types_istypedarray_value" id="util_util_types_istypedarray_value">#</a></span></h4> 1948<div class="api_metadata"> 1949<span>Added in: v10.0.0</span> 1950</div> 1951<ul> 1952<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1953<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1954</ul> 1955<p>Returns <code>true</code> if the value is a built-in <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray"><code>TypedArray</code></a> instance.</p> 1956<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isTypedArray</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayBuffer</span>()); <span class="hljs-comment">// Returns false</span> 1957util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isTypedArray</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Uint</span>8<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// Returns true</span> 1958util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isTypedArray</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Float</span>64<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// Returns true</span></code></pre> 1959<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> 1960<h4><code>util.types.isUint8Array(value)</code><span><a class="mark" href="#util_util_types_isuint8array_value" id="util_util_types_isuint8array_value">#</a></span></h4> 1961<div class="api_metadata"> 1962<span>Added in: v10.0.0</span> 1963</div> 1964<ul> 1965<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1966<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1967</ul> 1968<p>Returns <code>true</code> if the value is a built-in <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array"><code>Uint8Array</code></a> instance.</p> 1969<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isUint8Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayBuffer</span>()); <span class="hljs-comment">// Returns false</span> 1970util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isUint8Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Uint</span>8<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// Returns true</span> 1971util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isUint8Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Float</span>64<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// Returns false</span></code></pre> 1972<h4><code>util.types.isUint8ClampedArray(value)</code><span><a class="mark" href="#util_util_types_isuint8clampedarray_value" id="util_util_types_isuint8clampedarray_value">#</a></span></h4> 1973<div class="api_metadata"> 1974<span>Added in: v10.0.0</span> 1975</div> 1976<ul> 1977<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1978<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1979</ul> 1980<p>Returns <code>true</code> if the value is a built-in <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8ClampedArray"><code>Uint8ClampedArray</code></a> instance.</p> 1981<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isUint8ClampedArray</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayBuffer</span>()); <span class="hljs-comment">// Returns false</span> 1982util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isUint8ClampedArray</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Uint</span>8ClampedArray()); <span class="hljs-comment">// Returns true</span> 1983util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isUint8ClampedArray</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Float</span>64<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// Returns false</span></code></pre> 1984<h4><code>util.types.isUint16Array(value)</code><span><a class="mark" href="#util_util_types_isuint16array_value" id="util_util_types_isuint16array_value">#</a></span></h4> 1985<div class="api_metadata"> 1986<span>Added in: v10.0.0</span> 1987</div> 1988<ul> 1989<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 1990<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 1991</ul> 1992<p>Returns <code>true</code> if the value is a built-in <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array"><code>Uint16Array</code></a> instance.</p> 1993<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isUint16Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayBuffer</span>()); <span class="hljs-comment">// Returns false</span> 1994util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isUint16Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Uint</span>16<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// Returns true</span> 1995util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isUint16Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Float</span>64<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// Returns false</span></code></pre> 1996<h4><code>util.types.isUint32Array(value)</code><span><a class="mark" href="#util_util_types_isuint32array_value" id="util_util_types_isuint32array_value">#</a></span></h4> 1997<div class="api_metadata"> 1998<span>Added in: v10.0.0</span> 1999</div> 2000<ul> 2001<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 2002<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2003</ul> 2004<p>Returns <code>true</code> if the value is a built-in <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint32Array"><code>Uint32Array</code></a> instance.</p> 2005<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isUint32Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">ArrayBuffer</span>()); <span class="hljs-comment">// Returns false</span> 2006util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isUint32Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Uint</span>32<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// Returns true</span> 2007util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isUint32Array</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Float</span>64<span class="hljs-built_in">Array</span>()); <span class="hljs-comment">// Returns false</span></code></pre> 2008<h4><code>util.types.isWeakMap(value)</code><span><a class="mark" href="#util_util_types_isweakmap_value" id="util_util_types_isweakmap_value">#</a></span></h4> 2009<div class="api_metadata"> 2010<span>Added in: v10.0.0</span> 2011</div> 2012<ul> 2013<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 2014<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2015</ul> 2016<p>Returns <code>true</code> if the value is a built-in <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap"><code>WeakMap</code></a> instance.</p> 2017<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isWeakMap</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">WeakMap</span>()); <span class="hljs-comment">// Returns true</span></code></pre> 2018<h4><code>util.types.isWeakSet(value)</code><span><a class="mark" href="#util_util_types_isweakset_value" id="util_util_types_isweakset_value">#</a></span></h4> 2019<div class="api_metadata"> 2020<span>Added in: v10.0.0</span> 2021</div> 2022<ul> 2023<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 2024<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2025</ul> 2026<p>Returns <code>true</code> if the value is a built-in <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet"><code>WeakSet</code></a> instance.</p> 2027<pre><code class="language-js">util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isWeakSet</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">WeakSet</span>()); <span class="hljs-comment">// Returns true</span></code></pre> 2028<h4><code>util.types.isWebAssemblyCompiledModule(value)</code><span><a class="mark" href="#util_util_types_iswebassemblycompiledmodule_value" id="util_util_types_iswebassemblycompiledmodule_value">#</a></span></h4> 2029<div class="api_metadata"> 2030<span>Added in: v10.0.0</span><span>Deprecated since: v14.0.0</span> 2031</div> 2032<p></p><div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">Stability: 0</a> - Deprecated: Use <code>value instanceof WebAssembly.Module</code> instead.</div><p></p> 2033<ul> 2034<li><code>value</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 2035<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2036</ul> 2037<p>Returns <code>true</code> if the value is a built-in <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/Module"><code>WebAssembly.Module</code></a> instance.</p> 2038<pre><code class="language-js"><span class="hljs-keyword">const</span> <span class="hljs-variable language_">module</span> = <span class="hljs-keyword">new</span> <span class="hljs-title class_">WebAssembly</span>.<span class="hljs-title class_">Module</span>(wasmBuffer); 2039util.<span class="hljs-property">types</span>.<span class="hljs-title function_">isWebAssemblyCompiledModule</span>(<span class="hljs-variable language_">module</span>); <span class="hljs-comment">// Returns true</span></code></pre> 2040</section><section><h3>Deprecated APIs<span><a class="mark" href="#util_deprecated_apis" id="util_deprecated_apis">#</a></span></h3> 2041<p>The following APIs are deprecated and should no longer be used. Existing 2042applications and modules should be updated to find alternative approaches.</p> 2043<h4><code>util._extend(target, source)</code><span><a class="mark" href="#util_util_extend_target_source" id="util_util_extend_target_source">#</a></span></h4> 2044<div class="api_metadata"> 2045<span>Added in: v0.7.5</span><span>Deprecated since: v6.0.0</span> 2046</div> 2047<p></p><div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">Stability: 0</a> - Deprecated: Use <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign"><code>Object.assign()</code></a> instead.</div><p></p> 2048<ul> 2049<li><code>target</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 2050<li><code>source</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 2051</ul> 2052<p>The <code>util._extend()</code> method was never intended to be used outside of internal 2053Node.js modules. The community found and used it anyway.</p> 2054<p>It is deprecated and should not be used in new code. JavaScript comes with very 2055similar 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> 2056<h4><code>util.isArray(object)</code><span><a class="mark" href="#util_util_isarray_object" id="util_util_isarray_object">#</a></span></h4> 2057<div class="api_metadata"> 2058<span>Added in: v0.6.0</span><span>Deprecated since: v4.0.0</span> 2059</div> 2060<p></p><div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">Stability: 0</a> - Deprecated: Use <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray"><code>Array.isArray()</code></a> instead.</div><p></p> 2061<ul> 2062<li><code>object</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 2063<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2064</ul> 2065<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> 2066<p>Returns <code>true</code> if the given <code>object</code> is an <code>Array</code>. Otherwise, returns <code>false</code>.</p> 2067<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 2068 2069util.<span class="hljs-title function_">isArray</span>([]); 2070<span class="hljs-comment">// Returns: true</span> 2071util.<span class="hljs-title function_">isArray</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Array</span>()); 2072<span class="hljs-comment">// Returns: true</span> 2073util.<span class="hljs-title function_">isArray</span>({}); 2074<span class="hljs-comment">// Returns: false</span></code></pre> 2075<h4><code>util.isBoolean(object)</code><span><a class="mark" href="#util_util_isboolean_object" id="util_util_isboolean_object">#</a></span></h4> 2076<div class="api_metadata"> 2077<span>Added in: v0.11.5</span><span>Deprecated since: v4.0.0</span> 2078</div> 2079<p></p><div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">Stability: 0</a> - Deprecated: Use <code>typeof value === 'boolean'</code> instead.</div><p></p> 2080<ul> 2081<li><code>object</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 2082<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2083</ul> 2084<p>Returns <code>true</code> if the given <code>object</code> is a <code>Boolean</code>. Otherwise, returns <code>false</code>.</p> 2085<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 2086 2087util.<span class="hljs-title function_">isBoolean</span>(<span class="hljs-number">1</span>); 2088<span class="hljs-comment">// Returns: false</span> 2089util.<span class="hljs-title function_">isBoolean</span>(<span class="hljs-number">0</span>); 2090<span class="hljs-comment">// Returns: false</span> 2091util.<span class="hljs-title function_">isBoolean</span>(<span class="hljs-literal">false</span>); 2092<span class="hljs-comment">// Returns: true</span></code></pre> 2093<h4><code>util.isBuffer(object)</code><span><a class="mark" href="#util_util_isbuffer_object" id="util_util_isbuffer_object">#</a></span></h4> 2094<div class="api_metadata"> 2095<span>Added in: v0.11.5</span><span>Deprecated since: v4.0.0</span> 2096</div> 2097<p></p><div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">Stability: 0</a> - Deprecated: Use <a href="buffer.html#buffer_static_method_buffer_isbuffer_obj"><code>Buffer.isBuffer()</code></a> instead.</div><p></p> 2098<ul> 2099<li><code>object</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 2100<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2101</ul> 2102<p>Returns <code>true</code> if the given <code>object</code> is a <code>Buffer</code>. Otherwise, returns <code>false</code>.</p> 2103<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 2104 2105util.<span class="hljs-title function_">isBuffer</span>({ <span class="hljs-attr">length</span>: <span class="hljs-number">0</span> }); 2106<span class="hljs-comment">// Returns: false</span> 2107util.<span class="hljs-title function_">isBuffer</span>([]); 2108<span class="hljs-comment">// Returns: false</span> 2109util.<span class="hljs-title function_">isBuffer</span>(<span class="hljs-title class_">Buffer</span>.<span class="hljs-title function_">from</span>(<span class="hljs-string">'hello world'</span>)); 2110<span class="hljs-comment">// Returns: true</span></code></pre> 2111<h4><code>util.isDate(object)</code><span><a class="mark" href="#util_util_isdate_object" id="util_util_isdate_object">#</a></span></h4> 2112<div class="api_metadata"> 2113<span>Added in: v0.6.0</span><span>Deprecated since: v4.0.0</span> 2114</div> 2115<p></p><div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">Stability: 0</a> - Deprecated: Use <a href="#util_util_types_isdate_value"><code>util.types.isDate()</code></a> instead.</div><p></p> 2116<ul> 2117<li><code>object</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 2118<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2119</ul> 2120<p>Returns <code>true</code> if the given <code>object</code> is a <code>Date</code>. Otherwise, returns <code>false</code>.</p> 2121<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 2122 2123util.<span class="hljs-title function_">isDate</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Date</span>()); 2124<span class="hljs-comment">// Returns: true</span> 2125util.<span class="hljs-title function_">isDate</span>(<span class="hljs-title class_">Date</span>()); 2126<span class="hljs-comment">// false (without 'new' returns a String)</span> 2127util.<span class="hljs-title function_">isDate</span>({}); 2128<span class="hljs-comment">// Returns: false</span></code></pre> 2129<h4><code>util.isError(object)</code><span><a class="mark" href="#util_util_iserror_object" id="util_util_iserror_object">#</a></span></h4> 2130<div class="api_metadata"> 2131<span>Added in: v0.6.0</span><span>Deprecated since: v4.0.0</span> 2132</div> 2133<p></p><div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">Stability: 0</a> - Deprecated: Use <a href="#util_util_types_isnativeerror_value"><code>util.types.isNativeError()</code></a> instead.</div><p></p> 2134<ul> 2135<li><code>object</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 2136<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2137</ul> 2138<p>Returns <code>true</code> if the given <code>object</code> is an <a href="errors.html#errors_class_error"><code>Error</code></a>. Otherwise, returns 2139<code>false</code>.</p> 2140<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 2141 2142util.<span class="hljs-title function_">isError</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Error</span>()); 2143<span class="hljs-comment">// Returns: true</span> 2144util.<span class="hljs-title function_">isError</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">TypeError</span>()); 2145<span class="hljs-comment">// Returns: true</span> 2146util.<span class="hljs-title function_">isError</span>({ <span class="hljs-attr">name</span>: <span class="hljs-string">'Error'</span>, <span class="hljs-attr">message</span>: <span class="hljs-string">'an error occurred'</span> }); 2147<span class="hljs-comment">// Returns: false</span></code></pre> 2148<p>This method relies on <code>Object.prototype.toString()</code> behavior. It is 2149possible to obtain an incorrect result when the <code>object</code> argument manipulates 2150<code>@@toStringTag</code>.</p> 2151<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 2152<span class="hljs-keyword">const</span> obj = { <span class="hljs-attr">name</span>: <span class="hljs-string">'Error'</span>, <span class="hljs-attr">message</span>: <span class="hljs-string">'an error occurred'</span> }; 2153 2154util.<span class="hljs-title function_">isError</span>(obj); 2155<span class="hljs-comment">// Returns: false</span> 2156obj[<span class="hljs-title class_">Symbol</span>.<span class="hljs-property">toStringTag</span>] = <span class="hljs-string">'Error'</span>; 2157util.<span class="hljs-title function_">isError</span>(obj); 2158<span class="hljs-comment">// Returns: true</span></code></pre> 2159<h4><code>util.isFunction(object)</code><span><a class="mark" href="#util_util_isfunction_object" id="util_util_isfunction_object">#</a></span></h4> 2160<div class="api_metadata"> 2161<span>Added in: v0.11.5</span><span>Deprecated since: v4.0.0</span> 2162</div> 2163<p></p><div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">Stability: 0</a> - Deprecated: Use <code>typeof value === 'function'</code> instead.</div><p></p> 2164<ul> 2165<li><code>object</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 2166<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2167</ul> 2168<p>Returns <code>true</code> if the given <code>object</code> is a <code>Function</code>. Otherwise, returns 2169<code>false</code>.</p> 2170<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 2171 2172<span class="hljs-keyword">function</span> <span class="hljs-title function_">Foo</span>(<span class="hljs-params"></span>) {} 2173<span class="hljs-keyword">const</span> <span class="hljs-title function_">Bar</span> = (<span class="hljs-params"></span>) => {}; 2174 2175util.<span class="hljs-title function_">isFunction</span>({}); 2176<span class="hljs-comment">// Returns: false</span> 2177util.<span class="hljs-title function_">isFunction</span>(<span class="hljs-title class_">Foo</span>); 2178<span class="hljs-comment">// Returns: true</span> 2179util.<span class="hljs-title function_">isFunction</span>(<span class="hljs-title class_">Bar</span>); 2180<span class="hljs-comment">// Returns: true</span></code></pre> 2181<h4><code>util.isNull(object)</code><span><a class="mark" href="#util_util_isnull_object" id="util_util_isnull_object">#</a></span></h4> 2182<div class="api_metadata"> 2183<span>Added in: v0.11.5</span><span>Deprecated since: v4.0.0</span> 2184</div> 2185<p></p><div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">Stability: 0</a> - Deprecated: Use <code>value === null</code> instead.</div><p></p> 2186<ul> 2187<li><code>object</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 2188<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2189</ul> 2190<p>Returns <code>true</code> if the given <code>object</code> is strictly <code>null</code>. Otherwise, returns 2191<code>false</code>.</p> 2192<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 2193 2194util.<span class="hljs-title function_">isNull</span>(<span class="hljs-number">0</span>); 2195<span class="hljs-comment">// Returns: false</span> 2196util.<span class="hljs-title function_">isNull</span>(<span class="hljs-literal">undefined</span>); 2197<span class="hljs-comment">// Returns: false</span> 2198util.<span class="hljs-title function_">isNull</span>(<span class="hljs-literal">null</span>); 2199<span class="hljs-comment">// Returns: true</span></code></pre> 2200<h4><code>util.isNullOrUndefined(object)</code><span><a class="mark" href="#util_util_isnullorundefined_object" id="util_util_isnullorundefined_object">#</a></span></h4> 2201<div class="api_metadata"> 2202<span>Added in: v0.11.5</span><span>Deprecated since: v4.0.0</span> 2203</div> 2204<p></p><div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">Stability: 0</a> - Deprecated: Use 2205<code>value === undefined || value === null</code> instead.</div><p></p> 2206<ul> 2207<li><code>object</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 2208<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2209</ul> 2210<p>Returns <code>true</code> if the given <code>object</code> is <code>null</code> or <code>undefined</code>. Otherwise, 2211returns <code>false</code>.</p> 2212<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 2213 2214util.<span class="hljs-title function_">isNullOrUndefined</span>(<span class="hljs-number">0</span>); 2215<span class="hljs-comment">// Returns: false</span> 2216util.<span class="hljs-title function_">isNullOrUndefined</span>(<span class="hljs-literal">undefined</span>); 2217<span class="hljs-comment">// Returns: true</span> 2218util.<span class="hljs-title function_">isNullOrUndefined</span>(<span class="hljs-literal">null</span>); 2219<span class="hljs-comment">// Returns: true</span></code></pre> 2220<h4><code>util.isNumber(object)</code><span><a class="mark" href="#util_util_isnumber_object" id="util_util_isnumber_object">#</a></span></h4> 2221<div class="api_metadata"> 2222<span>Added in: v0.11.5</span><span>Deprecated since: v4.0.0</span> 2223</div> 2224<p></p><div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">Stability: 0</a> - Deprecated: Use <code>typeof value === 'number'</code> instead.</div><p></p> 2225<ul> 2226<li><code>object</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 2227<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2228</ul> 2229<p>Returns <code>true</code> if the given <code>object</code> is a <code>Number</code>. Otherwise, returns <code>false</code>.</p> 2230<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 2231 2232util.<span class="hljs-title function_">isNumber</span>(<span class="hljs-literal">false</span>); 2233<span class="hljs-comment">// Returns: false</span> 2234util.<span class="hljs-title function_">isNumber</span>(<span class="hljs-title class_">Infinity</span>); 2235<span class="hljs-comment">// Returns: true</span> 2236util.<span class="hljs-title function_">isNumber</span>(<span class="hljs-number">0</span>); 2237<span class="hljs-comment">// Returns: true</span> 2238util.<span class="hljs-title function_">isNumber</span>(<span class="hljs-title class_">Na</span>N); 2239<span class="hljs-comment">// Returns: true</span></code></pre> 2240<h4><code>util.isObject(object)</code><span><a class="mark" href="#util_util_isobject_object" id="util_util_isobject_object">#</a></span></h4> 2241<div class="api_metadata"> 2242<span>Added in: v0.11.5</span><span>Deprecated since: v4.0.0</span> 2243</div> 2244<p></p><div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">Stability: 0</a> - Deprecated: 2245Use <code>value !== null && typeof value === 'object'</code> instead.</div><p></p> 2246<ul> 2247<li><code>object</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 2248<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2249</ul> 2250<p>Returns <code>true</code> if the given <code>object</code> is strictly an <code>Object</code> <strong>and</strong> not a 2251<code>Function</code> (even though functions are objects in JavaScript). 2252Otherwise, returns <code>false</code>.</p> 2253<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 2254 2255util.<span class="hljs-title function_">isObject</span>(<span class="hljs-number">5</span>); 2256<span class="hljs-comment">// Returns: false</span> 2257util.<span class="hljs-title function_">isObject</span>(<span class="hljs-literal">null</span>); 2258<span class="hljs-comment">// Returns: false</span> 2259util.<span class="hljs-title function_">isObject</span>({}); 2260<span class="hljs-comment">// Returns: true</span> 2261util.<span class="hljs-title function_">isObject</span>(<span class="hljs-function">() =></span> {}); 2262<span class="hljs-comment">// Returns: false</span></code></pre> 2263<h4><code>util.isPrimitive(object)</code><span><a class="mark" href="#util_util_isprimitive_object" id="util_util_isprimitive_object">#</a></span></h4> 2264<div class="api_metadata"> 2265<span>Added in: v0.11.5</span><span>Deprecated since: v4.0.0</span> 2266</div> 2267<p></p><div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">Stability: 0</a> - Deprecated: Use 2268<code>(typeof value !== 'object' && typeof value !== 'function') || value === null</code> 2269instead.</div><p></p> 2270<ul> 2271<li><code>object</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 2272<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2273</ul> 2274<p>Returns <code>true</code> if the given <code>object</code> is a primitive type. Otherwise, returns 2275<code>false</code>.</p> 2276<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 2277 2278util.<span class="hljs-title function_">isPrimitive</span>(<span class="hljs-number">5</span>); 2279<span class="hljs-comment">// Returns: true</span> 2280util.<span class="hljs-title function_">isPrimitive</span>(<span class="hljs-string">'foo'</span>); 2281<span class="hljs-comment">// Returns: true</span> 2282util.<span class="hljs-title function_">isPrimitive</span>(<span class="hljs-literal">false</span>); 2283<span class="hljs-comment">// Returns: true</span> 2284util.<span class="hljs-title function_">isPrimitive</span>(<span class="hljs-literal">null</span>); 2285<span class="hljs-comment">// Returns: true</span> 2286util.<span class="hljs-title function_">isPrimitive</span>(<span class="hljs-literal">undefined</span>); 2287<span class="hljs-comment">// Returns: true</span> 2288util.<span class="hljs-title function_">isPrimitive</span>({}); 2289<span class="hljs-comment">// Returns: false</span> 2290util.<span class="hljs-title function_">isPrimitive</span>(<span class="hljs-function">() =></span> {}); 2291<span class="hljs-comment">// Returns: false</span> 2292util.<span class="hljs-title function_">isPrimitive</span>(<span class="hljs-regexp">/^$/</span>); 2293<span class="hljs-comment">// Returns: false</span> 2294util.<span class="hljs-title function_">isPrimitive</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">Date</span>()); 2295<span class="hljs-comment">// Returns: false</span></code></pre> 2296<h4><code>util.isRegExp(object)</code><span><a class="mark" href="#util_util_isregexp_object" id="util_util_isregexp_object">#</a></span></h4> 2297<div class="api_metadata"> 2298<span>Added in: v0.6.0</span><span>Deprecated since: v4.0.0</span> 2299</div> 2300<p></p><div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">Stability: 0</a> - Deprecated</div><p></p> 2301<ul> 2302<li><code>object</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 2303<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2304</ul> 2305<p>Returns <code>true</code> if the given <code>object</code> is a <code>RegExp</code>. Otherwise, returns <code>false</code>.</p> 2306<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 2307 2308util.<span class="hljs-title function_">isRegExp</span>(<span class="hljs-regexp">/some regexp/</span>); 2309<span class="hljs-comment">// Returns: true</span> 2310util.<span class="hljs-title function_">isRegExp</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">RegExp</span>(<span class="hljs-string">'another regexp'</span>)); 2311<span class="hljs-comment">// Returns: true</span> 2312util.<span class="hljs-title function_">isRegExp</span>({}); 2313<span class="hljs-comment">// Returns: false</span></code></pre> 2314<h4><code>util.isString(object)</code><span><a class="mark" href="#util_util_isstring_object" id="util_util_isstring_object">#</a></span></h4> 2315<div class="api_metadata"> 2316<span>Added in: v0.11.5</span><span>Deprecated since: v4.0.0</span> 2317</div> 2318<p></p><div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">Stability: 0</a> - Deprecated: Use <code>typeof value === 'string'</code> instead.</div><p></p> 2319<ul> 2320<li><code>object</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 2321<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2322</ul> 2323<p>Returns <code>true</code> if the given <code>object</code> is a <code>string</code>. Otherwise, returns <code>false</code>.</p> 2324<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 2325 2326util.<span class="hljs-title function_">isString</span>(<span class="hljs-string">''</span>); 2327<span class="hljs-comment">// Returns: true</span> 2328util.<span class="hljs-title function_">isString</span>(<span class="hljs-string">'foo'</span>); 2329<span class="hljs-comment">// Returns: true</span> 2330util.<span class="hljs-title function_">isString</span>(<span class="hljs-title class_">String</span>(<span class="hljs-string">'foo'</span>)); 2331<span class="hljs-comment">// Returns: true</span> 2332util.<span class="hljs-title function_">isString</span>(<span class="hljs-number">5</span>); 2333<span class="hljs-comment">// Returns: false</span></code></pre> 2334<h4><code>util.isSymbol(object)</code><span><a class="mark" href="#util_util_issymbol_object" id="util_util_issymbol_object">#</a></span></h4> 2335<div class="api_metadata"> 2336<span>Added in: v0.11.5</span><span>Deprecated since: v4.0.0</span> 2337</div> 2338<p></p><div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">Stability: 0</a> - Deprecated: Use <code>typeof value === 'symbol'</code> instead.</div><p></p> 2339<ul> 2340<li><code>object</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 2341<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2342</ul> 2343<p>Returns <code>true</code> if the given <code>object</code> is a <code>Symbol</code>. Otherwise, returns <code>false</code>.</p> 2344<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 2345 2346util.<span class="hljs-title function_">isSymbol</span>(<span class="hljs-number">5</span>); 2347<span class="hljs-comment">// Returns: false</span> 2348util.<span class="hljs-title function_">isSymbol</span>(<span class="hljs-string">'foo'</span>); 2349<span class="hljs-comment">// Returns: false</span> 2350util.<span class="hljs-title function_">isSymbol</span>(<span class="hljs-title class_">Symbol</span>(<span class="hljs-string">'foo'</span>)); 2351<span class="hljs-comment">// Returns: true</span></code></pre> 2352<h4><code>util.isUndefined(object)</code><span><a class="mark" href="#util_util_isundefined_object" id="util_util_isundefined_object">#</a></span></h4> 2353<div class="api_metadata"> 2354<span>Added in: v0.11.5</span><span>Deprecated since: v4.0.0</span> 2355</div> 2356<p></p><div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">Stability: 0</a> - Deprecated: Use <code>value === undefined</code> instead.</div><p></p> 2357<ul> 2358<li><code>object</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types" class="type"><any></a></li> 2359<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 2360</ul> 2361<p>Returns <code>true</code> if the given <code>object</code> is <code>undefined</code>. Otherwise, returns <code>false</code>.</p> 2362<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 2363 2364<span class="hljs-keyword">const</span> foo = <span class="hljs-literal">undefined</span>; 2365util.<span class="hljs-title function_">isUndefined</span>(<span class="hljs-number">5</span>); 2366<span class="hljs-comment">// Returns: false</span> 2367util.<span class="hljs-title function_">isUndefined</span>(foo); 2368<span class="hljs-comment">// Returns: true</span> 2369util.<span class="hljs-title function_">isUndefined</span>(<span class="hljs-literal">null</span>); 2370<span class="hljs-comment">// Returns: false</span></code></pre> 2371<h4><code>util.log(string)</code><span><a class="mark" href="#util_util_log_string" id="util_util_log_string">#</a></span></h4> 2372<div class="api_metadata"> 2373<span>Added in: v0.3.0</span><span>Deprecated since: v6.0.0</span> 2374</div> 2375<p></p><div class="api_stability api_stability_0"><a href="documentation.html#documentation_stability_index">Stability: 0</a> - Deprecated: Use a third party module instead.</div><p></p> 2376<ul> 2377<li><code>string</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 2378</ul> 2379<p>The <code>util.log()</code> method prints the given <code>string</code> to <code>stdout</code> with an included 2380timestamp.</p> 2381<pre><code class="language-js"><span class="hljs-keyword">const</span> util = <span class="hljs-built_in">require</span>(<span class="hljs-string">'util'</span>); 2382 2383util.<span class="hljs-title function_">log</span>(<span class="hljs-string">'Timestamped message.'</span>);</code></pre></section> 2384 <!-- API END --> 2385 </div> 2386 </div> 2387 </div> 2388 <script> 2389 'use strict'; 2390 { 2391 const kCustomPreference = 'customDarkTheme'; 2392 const userSettings = sessionStorage.getItem(kCustomPreference); 2393 const themeToggleButton = document.getElementById('theme-toggle-btn'); 2394 if (userSettings === null && window.matchMedia) { 2395 const mq = window.matchMedia('(prefers-color-scheme: dark)'); 2396 if ('onchange' in mq) { 2397 function mqChangeListener(e) { 2398 document.body.classList.toggle('dark-mode', e.matches); 2399 } 2400 mq.addEventListener('change', mqChangeListener); 2401 if (themeToggleButton) { 2402 themeToggleButton.addEventListener('click', function() { 2403 mq.removeEventListener('change', mqChangeListener); 2404 }, { once: true }); 2405 } 2406 } 2407 if (mq.matches) { 2408 document.body.classList.add('dark-mode'); 2409 } 2410 } else if (userSettings === 'true') { 2411 document.body.classList.add('dark-mode'); 2412 } 2413 if (themeToggleButton) { 2414 themeToggleButton.hidden = false; 2415 themeToggleButton.addEventListener('click', function() { 2416 sessionStorage.setItem( 2417 kCustomPreference, 2418 document.body.classList.toggle('dark-mode') 2419 ); 2420 }); 2421 } 2422 } 2423 </script> 2424</body> 2425</html> 2426