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="v18.18.2"> 7 <title>Modules: node:module API | Node.js v18.18.2 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/module.html"> 12 <script async defer src="assets/api.js" type="text/javascript"></script> 13 <style>@media(max-width:430px){.with-26-chars>.js-flavor-selector{float:none;margin:0 0 1em auto;}}</style> 14</head> 15<body class="alt apidoc" id="api-section-module"> 16 <div id="content" class="clearfix"> 17 <div id="column2" class="interior"> 18 <div id="intro" class="interior"> 19 <a href="/" title="Go back to the home page"> 20 Node.js 21 </a> 22 </div> 23 <ul> 24<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 25<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 26</ul> 27<hr class="line"> 28<ul> 29<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 30<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 31<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 32<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 33<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 34<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 35<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 36<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 37<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 38<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 39<li><a href="console.html" class="nav-console">Console</a></li> 40<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 41<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 42<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 43<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 44<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 45<li><a href="dns.html" class="nav-dns">DNS</a></li> 46<li><a href="domain.html" class="nav-domain">Domain</a></li> 47<li><a href="errors.html" class="nav-errors">Errors</a></li> 48<li><a href="events.html" class="nav-events">Events</a></li> 49<li><a href="fs.html" class="nav-fs">File system</a></li> 50<li><a href="globals.html" class="nav-globals">Globals</a></li> 51<li><a href="http.html" class="nav-http">HTTP</a></li> 52<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 53<li><a href="https.html" class="nav-https">HTTPS</a></li> 54<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 55<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 56<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 57<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 58<li><a href="module.html" class="nav-module active">Modules: <code>node:module</code> API</a></li> 59<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 60<li><a href="net.html" class="nav-net">Net</a></li> 61<li><a href="os.html" class="nav-os">OS</a></li> 62<li><a href="path.html" class="nav-path">Path</a></li> 63<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 64<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 65<li><a href="process.html" class="nav-process">Process</a></li> 66<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 67<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 68<li><a href="readline.html" class="nav-readline">Readline</a></li> 69<li><a href="repl.html" class="nav-repl">REPL</a></li> 70<li><a href="report.html" class="nav-report">Report</a></li> 71<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 72<li><a href="stream.html" class="nav-stream">Stream</a></li> 73<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 74<li><a href="test.html" class="nav-test">Test runner</a></li> 75<li><a href="timers.html" class="nav-timers">Timers</a></li> 76<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 77<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 78<li><a href="tty.html" class="nav-tty">TTY</a></li> 79<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 80<li><a href="url.html" class="nav-url">URL</a></li> 81<li><a href="util.html" class="nav-util">Utilities</a></li> 82<li><a href="v8.html" class="nav-v8">V8</a></li> 83<li><a href="vm.html" class="nav-vm">VM</a></li> 84<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 85<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 86<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 87<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 88<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 89</ul> 90<hr class="line"> 91<ul> 92<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 93</ul> 94 </div> 95 96 <div id="column1" data-id="module" class="interior"> 97 <header class="header"> 98 <div class="header-container"> 99 <h1>Node.js v18.18.2 documentation</h1> 100 <button class="theme-toggle-btn" id="theme-toggle-btn" title="Toggle dark mode/light mode" aria-label="Toggle dark mode/light mode" hidden> 101 <svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" height="24" width="24"> 102 <path fill="none" d="M0 0h24v24H0z" /> 103 <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"/> 104 <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"/> 105 </svg> 106 <svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" height="24" width="24"> 107 <path d="M0 0h24v24H0z" fill="none" /> 108 <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"/> 109 </svg> 110 </button> 111 </div> 112 <div id="gtoc"> 113 <ul> 114 <li class="pinned-header">Node.js v18.18.2</li> 115 116 <li class="picker-header"> 117 <a href="#"> 118 <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 119 Table of contents 120 </a> 121 122 <div class="picker"><div class="toc"><ul> 123<li><a href="#modules-nodemodule-api">Modules: <code>node:module</code> API</a> 124<ul> 125<li><a href="#the-module-object">The <code>Module</code> object</a> 126<ul> 127<li><a href="#modulebuiltinmodules"><code>module.builtinModules</code></a></li> 128<li><a href="#modulecreaterequirefilename"><code>module.createRequire(filename)</code></a></li> 129<li><a href="#moduleisbuiltinmodulename"><code>module.isBuiltin(moduleName)</code></a></li> 130<li><a href="#modulesyncbuiltinesmexports"><code>module.syncBuiltinESMExports()</code></a></li> 131</ul> 132</li> 133<li><span class="stability_1"><a href="#source-map-v3-support">Source map v3 support</a></span> 134<ul> 135<li><a href="#modulefindsourcemappath"><code>module.findSourceMap(path)</code></a></li> 136<li><a href="#class-modulesourcemap">Class: <code>module.SourceMap</code></a> 137<ul> 138<li><a href="#new-sourcemappayload"><code>new SourceMap(payload)</code></a></li> 139<li><a href="#sourcemappayload"><code>sourceMap.payload</code></a></li> 140<li><a href="#sourcemapfindentrylineoffset-columnoffset"><code>sourceMap.findEntry(lineOffset, columnOffset)</code></a></li> 141<li><a href="#sourcemapfindoriginlinenumber-columnnumber"><code>sourceMap.findOrigin(lineNumber, columnNumber)</code></a></li> 142</ul> 143</li> 144</ul> 145</li> 146</ul> 147</li> 148</ul></div></div> 149 </li> 150 151 152 <li class="picker-header"> 153 <a href="#"> 154 <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 155 Index 156 </a> 157 158 <div class="picker"><ul> 159<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 160<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 161 162 <li> 163 <a href="index.html">Index</a> 164 </li> 165 </ul> 166 167<hr class="line"> 168<ul> 169<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 170<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 171<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 172<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 173<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 174<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 175<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 176<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 177<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 178<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 179<li><a href="console.html" class="nav-console">Console</a></li> 180<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 181<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 182<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 183<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 184<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 185<li><a href="dns.html" class="nav-dns">DNS</a></li> 186<li><a href="domain.html" class="nav-domain">Domain</a></li> 187<li><a href="errors.html" class="nav-errors">Errors</a></li> 188<li><a href="events.html" class="nav-events">Events</a></li> 189<li><a href="fs.html" class="nav-fs">File system</a></li> 190<li><a href="globals.html" class="nav-globals">Globals</a></li> 191<li><a href="http.html" class="nav-http">HTTP</a></li> 192<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 193<li><a href="https.html" class="nav-https">HTTPS</a></li> 194<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 195<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 196<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 197<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 198<li><a href="module.html" class="nav-module active">Modules: <code>node:module</code> API</a></li> 199<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 200<li><a href="net.html" class="nav-net">Net</a></li> 201<li><a href="os.html" class="nav-os">OS</a></li> 202<li><a href="path.html" class="nav-path">Path</a></li> 203<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 204<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 205<li><a href="process.html" class="nav-process">Process</a></li> 206<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 207<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 208<li><a href="readline.html" class="nav-readline">Readline</a></li> 209<li><a href="repl.html" class="nav-repl">REPL</a></li> 210<li><a href="report.html" class="nav-report">Report</a></li> 211<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 212<li><a href="stream.html" class="nav-stream">Stream</a></li> 213<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 214<li><a href="test.html" class="nav-test">Test runner</a></li> 215<li><a href="timers.html" class="nav-timers">Timers</a></li> 216<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 217<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 218<li><a href="tty.html" class="nav-tty">TTY</a></li> 219<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 220<li><a href="url.html" class="nav-url">URL</a></li> 221<li><a href="util.html" class="nav-util">Utilities</a></li> 222<li><a href="v8.html" class="nav-v8">V8</a></li> 223<li><a href="vm.html" class="nav-vm">VM</a></li> 224<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 225<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 226<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 227<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 228<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 229</ul> 230<hr class="line"> 231<ul> 232<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 233</ul></div> 234 </li> 235 236 237 <li class="picker-header"> 238 <a href="#"> 239 <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 240 Other versions 241 </a> 242 <div class="picker"><ol id="alt-docs"><li><a href="https://nodejs.org/docs/latest-v20.x/api/module.html">20.x</a></li> 243<li><a href="https://nodejs.org/docs/latest-v19.x/api/module.html">19.x</a></li> 244<li><a href="https://nodejs.org/docs/latest-v18.x/api/module.html">18.x <b>LTS</b></a></li> 245<li><a href="https://nodejs.org/docs/latest-v17.x/api/module.html">17.x</a></li> 246<li><a href="https://nodejs.org/docs/latest-v16.x/api/module.html">16.x</a></li> 247<li><a href="https://nodejs.org/docs/latest-v15.x/api/module.html">15.x</a></li> 248<li><a href="https://nodejs.org/docs/latest-v14.x/api/module.html">14.x</a></li> 249<li><a href="https://nodejs.org/docs/latest-v13.x/api/module.html">13.x</a></li> 250<li><a href="https://nodejs.org/docs/latest-v12.x/api/module.html">12.x</a></li></ol></div> 251 </li> 252 253 <li class="picker-header"> 254 <a href="#"> 255 <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 256 Options 257 </a> 258 259 <div class="picker"> 260 <ul> 261 <li> 262 <a href="all.html">View on single page</a> 263 </li> 264 <li> 265 <a href="module.json">View as JSON</a> 266 </li> 267 <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/main/doc/api/module.md">Edit on GitHub</a></li> 268 </ul> 269 </div> 270 </li> 271 </ul> 272 </div> 273 <hr> 274 </header> 275 276 <details id="toc" open><summary>Table of contents</summary><ul> 277<li><a href="#modules-nodemodule-api">Modules: <code>node:module</code> API</a> 278<ul> 279<li><a href="#the-module-object">The <code>Module</code> object</a> 280<ul> 281<li><a href="#modulebuiltinmodules"><code>module.builtinModules</code></a></li> 282<li><a href="#modulecreaterequirefilename"><code>module.createRequire(filename)</code></a></li> 283<li><a href="#moduleisbuiltinmodulename"><code>module.isBuiltin(moduleName)</code></a></li> 284<li><a href="#modulesyncbuiltinesmexports"><code>module.syncBuiltinESMExports()</code></a></li> 285</ul> 286</li> 287<li><span class="stability_1"><a href="#source-map-v3-support">Source map v3 support</a></span> 288<ul> 289<li><a href="#modulefindsourcemappath"><code>module.findSourceMap(path)</code></a></li> 290<li><a href="#class-modulesourcemap">Class: <code>module.SourceMap</code></a> 291<ul> 292<li><a href="#new-sourcemappayload"><code>new SourceMap(payload)</code></a></li> 293<li><a href="#sourcemappayload"><code>sourceMap.payload</code></a></li> 294<li><a href="#sourcemapfindentrylineoffset-columnoffset"><code>sourceMap.findEntry(lineOffset, columnOffset)</code></a></li> 295<li><a href="#sourcemapfindoriginlinenumber-columnnumber"><code>sourceMap.findOrigin(lineNumber, columnNumber)</code></a></li> 296</ul> 297</li> 298</ul> 299</li> 300</ul> 301</li> 302</ul></details> 303 304 <div id="apicontent"> 305 <h2>Modules: <code>node:module</code> API<span><a class="mark" href="#modules-nodemodule-api" id="modules-nodemodule-api">#</a></span><a aria-hidden="true" class="legacy" id="module_modules_node_module_api"></a></h2> 306 307<div class="api_metadata"> 308<span>Added in: v0.3.7</span> 309</div> 310<section><h3>The <code>Module</code> object<span><a class="mark" href="#the-module-object" id="the-module-object">#</a></span><a aria-hidden="true" class="legacy" id="module_the_module_object"></a></h3> 311<ul> 312<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 313</ul> 314<p>Provides general utility methods when interacting with instances of 315<code>Module</code>, the <a href="modules.html#the-module-object"><code>module</code></a> variable often seen in <a href="modules.html">CommonJS</a> modules. Accessed 316via <code>import 'node:module'</code> or <code>require('node:module')</code>.</p> 317<h4><code>module.builtinModules</code><span><a class="mark" href="#modulebuiltinmodules" id="modulebuiltinmodules">#</a></span><a aria-hidden="true" class="legacy" id="module_module_builtinmodules"></a></h4> 318<div class="api_metadata"> 319<span>Added in: v9.3.0, v8.10.0, v6.13.0</span> 320</div> 321<ul> 322<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string[]></a></li> 323</ul> 324<p>A list of the names of all modules provided by Node.js. Can be used to verify 325if a module is maintained by a third party or not.</p> 326<p><code>module</code> in this context isn't the same object that's provided 327by the <a href="modules.html#the-module-wrapper">module wrapper</a>. To access it, require the <code>Module</code> module:</p> 328 329<pre class="with-26-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-comment">// module.mjs</span> 330<span class="hljs-comment">// In an ECMAScript module</span> 331<span class="hljs-keyword">import</span> { builtinModules <span class="hljs-keyword">as</span> builtin } <span class="hljs-keyword">from</span> <span class="hljs-string">'node:module'</span>;</code><code class="language-js cjs"><span class="hljs-comment">// module.cjs</span> 332<span class="hljs-comment">// In a CommonJS module</span> 333<span class="hljs-keyword">const</span> builtin = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:module'</span>).<span class="hljs-property">builtinModules</span>;</code><button class="copy-button">copy</button></pre> 334<h4><code>module.createRequire(filename)</code><span><a class="mark" href="#modulecreaterequirefilename" id="modulecreaterequirefilename">#</a></span><a aria-hidden="true" class="legacy" id="module_module_createrequire_filename"></a></h4> 335<div class="api_metadata"> 336<span>Added in: v12.2.0</span> 337</div> 338<ul> 339<li><code>filename</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> | <a href="url.html#the-whatwg-url-api" class="type"><URL></a> Filename to be used to construct the require 340function. Must be a file URL object, file URL string, or absolute path 341string.</li> 342<li>Returns: <a href="modules.html#requireid" class="type"><require></a> Require function</li> 343</ul> 344<pre><code class="language-js mjs"><span class="hljs-keyword">import</span> { createRequire } <span class="hljs-keyword">from</span> <span class="hljs-string">'node:module'</span>; 345<span class="hljs-keyword">const</span> <span class="hljs-built_in">require</span> = <span class="hljs-title function_">createRequire</span>(<span class="hljs-keyword">import</span>.<span class="hljs-property">meta</span>.<span class="hljs-property">url</span>); 346 347<span class="hljs-comment">// sibling-module.js is a CommonJS module.</span> 348<span class="hljs-keyword">const</span> siblingModule = <span class="hljs-built_in">require</span>(<span class="hljs-string">'./sibling-module'</span>);</code> <button class="copy-button">copy</button></pre> 349<h4><code>module.isBuiltin(moduleName)</code><span><a class="mark" href="#moduleisbuiltinmodulename" id="moduleisbuiltinmodulename">#</a></span><a aria-hidden="true" class="legacy" id="module_module_isbuiltin_modulename"></a></h4> 350<div class="api_metadata"> 351<span>Added in: v18.6.0</span> 352</div> 353<ul> 354<li><code>moduleName</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> name of the module</li> 355<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a> returns true if the module is builtin else returns false</li> 356</ul> 357<pre><code class="language-js mjs"><span class="hljs-keyword">import</span> { isBuiltin } <span class="hljs-keyword">from</span> <span class="hljs-string">'node:module'</span>; 358<span class="hljs-title function_">isBuiltin</span>(<span class="hljs-string">'node:fs'</span>); <span class="hljs-comment">// true</span> 359<span class="hljs-title function_">isBuiltin</span>(<span class="hljs-string">'fs'</span>); <span class="hljs-comment">// true</span> 360<span class="hljs-title function_">isBuiltin</span>(<span class="hljs-string">'wss'</span>); <span class="hljs-comment">// false</span></code> <button class="copy-button">copy</button></pre> 361<h4><code>module.syncBuiltinESMExports()</code><span><a class="mark" href="#modulesyncbuiltinesmexports" id="modulesyncbuiltinesmexports">#</a></span><a aria-hidden="true" class="legacy" id="module_module_syncbuiltinesmexports"></a></h4> 362<div class="api_metadata"> 363<span>Added in: v12.12.0</span> 364</div> 365<p>The <code>module.syncBuiltinESMExports()</code> method updates all the live bindings for 366builtin <a href="esm.html">ES Modules</a> to match the properties of the <a href="modules.html">CommonJS</a> exports. It 367does not add or remove exported names from the <a href="esm.html">ES Modules</a>.</p> 368<pre><code class="language-js"><span class="hljs-keyword">const</span> fs = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:fs'</span>); 369<span class="hljs-keyword">const</span> assert = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:assert'</span>); 370<span class="hljs-keyword">const</span> { syncBuiltinESMExports } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:module'</span>); 371 372fs.<span class="hljs-property">readFile</span> = newAPI; 373 374<span class="hljs-keyword">delete</span> fs.<span class="hljs-property">readFileSync</span>; 375 376<span class="hljs-keyword">function</span> <span class="hljs-title function_">newAPI</span>(<span class="hljs-params"></span>) { 377 <span class="hljs-comment">// ...</span> 378} 379 380fs.<span class="hljs-property">newAPI</span> = newAPI; 381 382<span class="hljs-title function_">syncBuiltinESMExports</span>(); 383 384<span class="hljs-keyword">import</span>(<span class="hljs-string">'node:fs'</span>).<span class="hljs-title function_">then</span>(<span class="hljs-function">(<span class="hljs-params">esmFS</span>) =></span> { 385 <span class="hljs-comment">// It syncs the existing readFile property with the new value</span> 386 assert.<span class="hljs-title function_">strictEqual</span>(esmFS.<span class="hljs-property">readFile</span>, newAPI); 387 <span class="hljs-comment">// readFileSync has been deleted from the required fs</span> 388 assert.<span class="hljs-title function_">strictEqual</span>(<span class="hljs-string">'readFileSync'</span> <span class="hljs-keyword">in</span> fs, <span class="hljs-literal">false</span>); 389 <span class="hljs-comment">// syncBuiltinESMExports() does not remove readFileSync from esmFS</span> 390 assert.<span class="hljs-title function_">strictEqual</span>(<span class="hljs-string">'readFileSync'</span> <span class="hljs-keyword">in</span> esmFS, <span class="hljs-literal">true</span>); 391 <span class="hljs-comment">// syncBuiltinESMExports() does not add names</span> 392 assert.<span class="hljs-title function_">strictEqual</span>(esmFS.<span class="hljs-property">newAPI</span>, <span class="hljs-literal">undefined</span>); 393});</code> <button class="copy-button">copy</button></pre> 394</section><section><h3>Source map v3 support<span><a class="mark" href="#source-map-v3-support" id="source-map-v3-support">#</a></span><a aria-hidden="true" class="legacy" id="module_source_map_v3_support"></a></h3> 395<div class="api_metadata"> 396<span>Added in: v13.7.0, v12.17.0</span> 397</div> 398<p></p><div class="api_stability api_stability_1"><a href="documentation.html#stability-index">Stability: 1</a> - Experimental</div><p></p> 399<p>Helpers for interacting with the source map cache. This cache is 400populated when source map parsing is enabled and 401<a href="https://sourcemaps.info/spec.html#h.lmz475t4mvbx">source map include directives</a> are found in a modules' footer.</p> 402<p>To enable source map parsing, Node.js must be run with the flag 403<a href="cli.html#--enable-source-maps"><code>--enable-source-maps</code></a>, or with code coverage enabled by setting 404<a href="cli.html#node_v8_coveragedir"><code>NODE_V8_COVERAGE=dir</code></a>.</p> 405 406<pre class="with-26-chars"><input class="js-flavor-selector" type="checkbox" checked aria-label="Show modern ES modules syntax"><code class="language-js mjs"><span class="hljs-comment">// module.mjs</span> 407<span class="hljs-comment">// In an ECMAScript module</span> 408<span class="hljs-keyword">import</span> { findSourceMap, <span class="hljs-title class_">SourceMap</span> } <span class="hljs-keyword">from</span> <span class="hljs-string">'node:module'</span>;</code><code class="language-js cjs"><span class="hljs-comment">// module.cjs</span> 409<span class="hljs-comment">// In a CommonJS module</span> 410<span class="hljs-keyword">const</span> { findSourceMap, <span class="hljs-title class_">SourceMap</span> } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:module'</span>);</code><button class="copy-button">copy</button></pre> 411<!-- Anchors to make sure old links find a target --> 412<p><a id="module_module_findsourcemap_path_error"></a></p> 413<h4><code>module.findSourceMap(path)</code><span><a class="mark" href="#modulefindsourcemappath" id="modulefindsourcemappath">#</a></span><a aria-hidden="true" class="legacy" id="module_module_findsourcemap_path"></a></h4> 414<div class="api_metadata"> 415<span>Added in: v13.7.0, v12.17.0</span> 416</div> 417<ul> 418<li><code>path</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 419<li>Returns: <a href="module.html#class-modulesourcemap" class="type"><module.SourceMap></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Undefined_type" class="type"><undefined></a> Returns <code>module.SourceMap</code> if a source 420map is found, <code>undefined</code> otherwise.</li> 421</ul> 422<p><code>path</code> is the resolved path for the file for which a corresponding source map 423should be fetched.</p> 424<h4>Class: <code>module.SourceMap</code><span><a class="mark" href="#class-modulesourcemap" id="class-modulesourcemap">#</a></span><a aria-hidden="true" class="legacy" id="module_class_module_sourcemap"></a></h4> 425<div class="api_metadata"> 426<span>Added in: v13.7.0, v12.17.0</span> 427</div> 428<h5><code>new SourceMap(payload)</code><span><a class="mark" href="#new-sourcemappayload" id="new-sourcemappayload">#</a></span><a aria-hidden="true" class="legacy" id="module_new_sourcemap_payload"></a></h5> 429<ul> 430<li><code>payload</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 431</ul> 432<p>Creates a new <code>sourceMap</code> instance.</p> 433<p><code>payload</code> is an object with keys matching the <a href="https://sourcemaps.info/spec.html#h.mofvlxcwqzej">Source map v3 format</a>:</p> 434<ul> 435<li><code>file</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 436<li><code>version</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a></li> 437<li><code>sources</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string[]></a></li> 438<li><code>sourcesContent</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string[]></a></li> 439<li><code>names</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string[]></a></li> 440<li><code>mappings</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 441<li><code>sourceRoot</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 442</ul> 443<h5><code>sourceMap.payload</code><span><a class="mark" href="#sourcemappayload" id="sourcemappayload">#</a></span><a aria-hidden="true" class="legacy" id="module_sourcemap_payload"></a></h5> 444<ul> 445<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 446</ul> 447<p>Getter for the payload used to construct the <a href="#class-modulesourcemap"><code>SourceMap</code></a> instance.</p> 448<h5><code>sourceMap.findEntry(lineOffset, columnOffset)</code><span><a class="mark" href="#sourcemapfindentrylineoffset-columnoffset" id="sourcemapfindentrylineoffset-columnoffset">#</a></span><a aria-hidden="true" class="legacy" id="module_sourcemap_findentry_lineoffset_columnoffset"></a></h5> 449<ul> 450<li><code>lineOffset</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The zero-indexed line number offset in 451the generated source</li> 452<li><code>columnOffset</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The zero-indexed column number offset 453in the generated source</li> 454<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 455</ul> 456<p>Given a line offset and column offset in the generated source 457file, returns an object representing the SourceMap range in the 458original file if found, or an empty object if not.</p> 459<p>The object returned contains the following keys:</p> 460<ul> 461<li>generatedLine: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The line offset of the start of the 462range in the generated source</li> 463<li>generatedColumn: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The column offset of start of the 464range in the generated source</li> 465<li>originalSource: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> The file name of the original source, 466as reported in the SourceMap</li> 467<li>originalLine: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The line offset of the start of the 468range in the original source</li> 469<li>originalColumn: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The column offset of start of the 470range in the original source</li> 471<li>name: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 472</ul> 473<p>The returned value represents the raw range as it appears in the 474SourceMap, based on zero-indexed offsets, <em>not</em> 1-indexed line and 475column numbers as they appear in Error messages and CallSite 476objects.</p> 477<p>To get the corresponding 1-indexed line and column numbers from a 478lineNumber and columnNumber as they are reported by Error stacks 479and CallSite objects, use <code>sourceMap.findOrigin(lineNumber, columnNumber)</code></p> 480<h5><code>sourceMap.findOrigin(lineNumber, columnNumber)</code><span><a class="mark" href="#sourcemapfindoriginlinenumber-columnnumber" id="sourcemapfindoriginlinenumber-columnnumber">#</a></span><a aria-hidden="true" class="legacy" id="module_sourcemap_findorigin_linenumber_columnnumber"></a></h5> 481<ul> 482<li><code>lineNumber</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The 1-indexed line number of the call 483site in the generated source</li> 484<li><code>columnOffset</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The 1-indexed column number 485of the call site in the generated source</li> 486<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 487</ul> 488<p>Given a 1-indexed lineNumber and columnNumber from a call site in 489the generated source, find the corresponding call site location 490in the original source.</p> 491<p>If the lineNumber and columnNumber provided are not found in any 492source map, then an empty object is returned. Otherwise, the 493returned object contains the following keys:</p> 494<ul> 495<li>name: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Undefined_type" class="type"><undefined></a> The name of the range in the 496source map, if one was provided</li> 497<li>fileName: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> The file name of the original source, as 498reported in the SourceMap</li> 499<li>lineNumber: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The 1-indexed lineNumber of the 500corresponding call site in the original source</li> 501<li>columnNumber: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><number></a> The 1-indexed columnNumber of the 502corresponding call site in the original source</li> 503</ul></section> 504 <!-- API END --> 505 </div> 506 </div> 507 </div> 508</body> 509</html> 510