11cb0ef41Sopenharmony_ci<!DOCTYPE html> 21cb0ef41Sopenharmony_ci<html lang="en"> 31cb0ef41Sopenharmony_ci<head> 41cb0ef41Sopenharmony_ci <meta charset="utf-8"> 51cb0ef41Sopenharmony_ci <meta name="viewport" content="width=device-width"> 61cb0ef41Sopenharmony_ci <meta name="nodejs.org:node-version" content="v18.20.1"> 71cb0ef41Sopenharmony_ci <title>Path | Node.js v18.20.1 Documentation</title> 81cb0ef41Sopenharmony_ci <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700,400italic&display=fallback"> 91cb0ef41Sopenharmony_ci <link rel="stylesheet" href="assets/style.css"> 101cb0ef41Sopenharmony_ci <link rel="stylesheet" href="assets/hljs.css"> 111cb0ef41Sopenharmony_ci <link rel="canonical" href="https://nodejs.org/api/path.html"> 121cb0ef41Sopenharmony_ci <script async defer src="assets/api.js" type="text/javascript"></script> 131cb0ef41Sopenharmony_ci 141cb0ef41Sopenharmony_ci</head> 151cb0ef41Sopenharmony_ci<body class="alt apidoc" id="api-section-path"> 161cb0ef41Sopenharmony_ci <div id="content" class="clearfix"> 171cb0ef41Sopenharmony_ci <div id="column2" class="interior"> 181cb0ef41Sopenharmony_ci <div id="intro" class="interior"> 191cb0ef41Sopenharmony_ci <a href="/" title="Go back to the home page"> 201cb0ef41Sopenharmony_ci Node.js 211cb0ef41Sopenharmony_ci </a> 221cb0ef41Sopenharmony_ci </div> 231cb0ef41Sopenharmony_ci <ul> 241cb0ef41Sopenharmony_ci<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 251cb0ef41Sopenharmony_ci<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 261cb0ef41Sopenharmony_ci</ul> 271cb0ef41Sopenharmony_ci<hr class="line"> 281cb0ef41Sopenharmony_ci<ul> 291cb0ef41Sopenharmony_ci<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 301cb0ef41Sopenharmony_ci<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 311cb0ef41Sopenharmony_ci<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 321cb0ef41Sopenharmony_ci<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 331cb0ef41Sopenharmony_ci<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 341cb0ef41Sopenharmony_ci<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 351cb0ef41Sopenharmony_ci<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 361cb0ef41Sopenharmony_ci<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 371cb0ef41Sopenharmony_ci<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 381cb0ef41Sopenharmony_ci<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 391cb0ef41Sopenharmony_ci<li><a href="console.html" class="nav-console">Console</a></li> 401cb0ef41Sopenharmony_ci<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 411cb0ef41Sopenharmony_ci<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 421cb0ef41Sopenharmony_ci<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 431cb0ef41Sopenharmony_ci<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 441cb0ef41Sopenharmony_ci<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 451cb0ef41Sopenharmony_ci<li><a href="dns.html" class="nav-dns">DNS</a></li> 461cb0ef41Sopenharmony_ci<li><a href="domain.html" class="nav-domain">Domain</a></li> 471cb0ef41Sopenharmony_ci<li><a href="errors.html" class="nav-errors">Errors</a></li> 481cb0ef41Sopenharmony_ci<li><a href="events.html" class="nav-events">Events</a></li> 491cb0ef41Sopenharmony_ci<li><a href="fs.html" class="nav-fs">File system</a></li> 501cb0ef41Sopenharmony_ci<li><a href="globals.html" class="nav-globals">Globals</a></li> 511cb0ef41Sopenharmony_ci<li><a href="http.html" class="nav-http">HTTP</a></li> 521cb0ef41Sopenharmony_ci<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 531cb0ef41Sopenharmony_ci<li><a href="https.html" class="nav-https">HTTPS</a></li> 541cb0ef41Sopenharmony_ci<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 551cb0ef41Sopenharmony_ci<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 561cb0ef41Sopenharmony_ci<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 571cb0ef41Sopenharmony_ci<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 581cb0ef41Sopenharmony_ci<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 591cb0ef41Sopenharmony_ci<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 601cb0ef41Sopenharmony_ci<li><a href="net.html" class="nav-net">Net</a></li> 611cb0ef41Sopenharmony_ci<li><a href="os.html" class="nav-os">OS</a></li> 621cb0ef41Sopenharmony_ci<li><a href="path.html" class="nav-path active">Path</a></li> 631cb0ef41Sopenharmony_ci<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 641cb0ef41Sopenharmony_ci<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 651cb0ef41Sopenharmony_ci<li><a href="process.html" class="nav-process">Process</a></li> 661cb0ef41Sopenharmony_ci<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 671cb0ef41Sopenharmony_ci<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 681cb0ef41Sopenharmony_ci<li><a href="readline.html" class="nav-readline">Readline</a></li> 691cb0ef41Sopenharmony_ci<li><a href="repl.html" class="nav-repl">REPL</a></li> 701cb0ef41Sopenharmony_ci<li><a href="report.html" class="nav-report">Report</a></li> 711cb0ef41Sopenharmony_ci<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 721cb0ef41Sopenharmony_ci<li><a href="stream.html" class="nav-stream">Stream</a></li> 731cb0ef41Sopenharmony_ci<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 741cb0ef41Sopenharmony_ci<li><a href="test.html" class="nav-test">Test runner</a></li> 751cb0ef41Sopenharmony_ci<li><a href="timers.html" class="nav-timers">Timers</a></li> 761cb0ef41Sopenharmony_ci<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 771cb0ef41Sopenharmony_ci<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 781cb0ef41Sopenharmony_ci<li><a href="tty.html" class="nav-tty">TTY</a></li> 791cb0ef41Sopenharmony_ci<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 801cb0ef41Sopenharmony_ci<li><a href="url.html" class="nav-url">URL</a></li> 811cb0ef41Sopenharmony_ci<li><a href="util.html" class="nav-util">Utilities</a></li> 821cb0ef41Sopenharmony_ci<li><a href="v8.html" class="nav-v8">V8</a></li> 831cb0ef41Sopenharmony_ci<li><a href="vm.html" class="nav-vm">VM</a></li> 841cb0ef41Sopenharmony_ci<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 851cb0ef41Sopenharmony_ci<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 861cb0ef41Sopenharmony_ci<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 871cb0ef41Sopenharmony_ci<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 881cb0ef41Sopenharmony_ci<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 891cb0ef41Sopenharmony_ci</ul> 901cb0ef41Sopenharmony_ci<hr class="line"> 911cb0ef41Sopenharmony_ci<ul> 921cb0ef41Sopenharmony_ci<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 931cb0ef41Sopenharmony_ci</ul> 941cb0ef41Sopenharmony_ci </div> 951cb0ef41Sopenharmony_ci 961cb0ef41Sopenharmony_ci <div id="column1" data-id="path" class="interior"> 971cb0ef41Sopenharmony_ci <header class="header"> 981cb0ef41Sopenharmony_ci <div class="header-container"> 991cb0ef41Sopenharmony_ci <h1>Node.js v18.20.1 documentation</h1> 1001cb0ef41Sopenharmony_ci <button class="theme-toggle-btn" id="theme-toggle-btn" title="Toggle dark mode/light mode" aria-label="Toggle dark mode/light mode" hidden> 1011cb0ef41Sopenharmony_ci <svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" height="24" width="24"> 1021cb0ef41Sopenharmony_ci <path fill="none" d="M0 0h24v24H0z" /> 1031cb0ef41Sopenharmony_ci <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"/> 1041cb0ef41Sopenharmony_ci <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"/> 1051cb0ef41Sopenharmony_ci </svg> 1061cb0ef41Sopenharmony_ci <svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" height="24" width="24"> 1071cb0ef41Sopenharmony_ci <path d="M0 0h24v24H0z" fill="none" /> 1081cb0ef41Sopenharmony_ci <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"/> 1091cb0ef41Sopenharmony_ci </svg> 1101cb0ef41Sopenharmony_ci </button> 1111cb0ef41Sopenharmony_ci </div> 1121cb0ef41Sopenharmony_ci <div id="gtoc"> 1131cb0ef41Sopenharmony_ci <ul> 1141cb0ef41Sopenharmony_ci <li class="pinned-header">Node.js v18.20.1</li> 1151cb0ef41Sopenharmony_ci 1161cb0ef41Sopenharmony_ci <li class="picker-header"> 1171cb0ef41Sopenharmony_ci <a href="#"> 1181cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 1191cb0ef41Sopenharmony_ci Table of contents 1201cb0ef41Sopenharmony_ci </a> 1211cb0ef41Sopenharmony_ci 1221cb0ef41Sopenharmony_ci <div class="picker"><div class="toc"><ul> 1231cb0ef41Sopenharmony_ci<li><span class="stability_2"><a href="#path">Path</a></span> 1241cb0ef41Sopenharmony_ci<ul> 1251cb0ef41Sopenharmony_ci<li><a href="#windows-vs-posix">Windows vs. POSIX</a></li> 1261cb0ef41Sopenharmony_ci<li><a href="#pathbasenamepath-suffix"><code>path.basename(path[, suffix])</code></a></li> 1271cb0ef41Sopenharmony_ci<li><a href="#pathdelimiter"><code>path.delimiter</code></a></li> 1281cb0ef41Sopenharmony_ci<li><a href="#pathdirnamepath"><code>path.dirname(path)</code></a></li> 1291cb0ef41Sopenharmony_ci<li><a href="#pathextnamepath"><code>path.extname(path)</code></a></li> 1301cb0ef41Sopenharmony_ci<li><a href="#pathformatpathobject"><code>path.format(pathObject)</code></a></li> 1311cb0ef41Sopenharmony_ci<li><a href="#pathisabsolutepath"><code>path.isAbsolute(path)</code></a></li> 1321cb0ef41Sopenharmony_ci<li><a href="#pathjoinpaths"><code>path.join([...paths])</code></a></li> 1331cb0ef41Sopenharmony_ci<li><a href="#pathnormalizepath"><code>path.normalize(path)</code></a></li> 1341cb0ef41Sopenharmony_ci<li><a href="#pathparsepath"><code>path.parse(path)</code></a></li> 1351cb0ef41Sopenharmony_ci<li><a href="#pathposix"><code>path.posix</code></a></li> 1361cb0ef41Sopenharmony_ci<li><a href="#pathrelativefrom-to"><code>path.relative(from, to)</code></a></li> 1371cb0ef41Sopenharmony_ci<li><a href="#pathresolvepaths"><code>path.resolve([...paths])</code></a></li> 1381cb0ef41Sopenharmony_ci<li><a href="#pathsep"><code>path.sep</code></a></li> 1391cb0ef41Sopenharmony_ci<li><a href="#pathtonamespacedpathpath"><code>path.toNamespacedPath(path)</code></a></li> 1401cb0ef41Sopenharmony_ci<li><a href="#pathwin32"><code>path.win32</code></a></li> 1411cb0ef41Sopenharmony_ci</ul> 1421cb0ef41Sopenharmony_ci</li> 1431cb0ef41Sopenharmony_ci</ul></div></div> 1441cb0ef41Sopenharmony_ci </li> 1451cb0ef41Sopenharmony_ci 1461cb0ef41Sopenharmony_ci 1471cb0ef41Sopenharmony_ci <li class="picker-header"> 1481cb0ef41Sopenharmony_ci <a href="#"> 1491cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 1501cb0ef41Sopenharmony_ci Index 1511cb0ef41Sopenharmony_ci </a> 1521cb0ef41Sopenharmony_ci 1531cb0ef41Sopenharmony_ci <div class="picker"><ul> 1541cb0ef41Sopenharmony_ci<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 1551cb0ef41Sopenharmony_ci<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 1561cb0ef41Sopenharmony_ci 1571cb0ef41Sopenharmony_ci <li> 1581cb0ef41Sopenharmony_ci <a href="index.html">Index</a> 1591cb0ef41Sopenharmony_ci </li> 1601cb0ef41Sopenharmony_ci </ul> 1611cb0ef41Sopenharmony_ci 1621cb0ef41Sopenharmony_ci<hr class="line"> 1631cb0ef41Sopenharmony_ci<ul> 1641cb0ef41Sopenharmony_ci<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 1651cb0ef41Sopenharmony_ci<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 1661cb0ef41Sopenharmony_ci<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 1671cb0ef41Sopenharmony_ci<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 1681cb0ef41Sopenharmony_ci<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 1691cb0ef41Sopenharmony_ci<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 1701cb0ef41Sopenharmony_ci<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 1711cb0ef41Sopenharmony_ci<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 1721cb0ef41Sopenharmony_ci<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 1731cb0ef41Sopenharmony_ci<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 1741cb0ef41Sopenharmony_ci<li><a href="console.html" class="nav-console">Console</a></li> 1751cb0ef41Sopenharmony_ci<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 1761cb0ef41Sopenharmony_ci<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 1771cb0ef41Sopenharmony_ci<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 1781cb0ef41Sopenharmony_ci<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 1791cb0ef41Sopenharmony_ci<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 1801cb0ef41Sopenharmony_ci<li><a href="dns.html" class="nav-dns">DNS</a></li> 1811cb0ef41Sopenharmony_ci<li><a href="domain.html" class="nav-domain">Domain</a></li> 1821cb0ef41Sopenharmony_ci<li><a href="errors.html" class="nav-errors">Errors</a></li> 1831cb0ef41Sopenharmony_ci<li><a href="events.html" class="nav-events">Events</a></li> 1841cb0ef41Sopenharmony_ci<li><a href="fs.html" class="nav-fs">File system</a></li> 1851cb0ef41Sopenharmony_ci<li><a href="globals.html" class="nav-globals">Globals</a></li> 1861cb0ef41Sopenharmony_ci<li><a href="http.html" class="nav-http">HTTP</a></li> 1871cb0ef41Sopenharmony_ci<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 1881cb0ef41Sopenharmony_ci<li><a href="https.html" class="nav-https">HTTPS</a></li> 1891cb0ef41Sopenharmony_ci<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 1901cb0ef41Sopenharmony_ci<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 1911cb0ef41Sopenharmony_ci<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 1921cb0ef41Sopenharmony_ci<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 1931cb0ef41Sopenharmony_ci<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 1941cb0ef41Sopenharmony_ci<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 1951cb0ef41Sopenharmony_ci<li><a href="net.html" class="nav-net">Net</a></li> 1961cb0ef41Sopenharmony_ci<li><a href="os.html" class="nav-os">OS</a></li> 1971cb0ef41Sopenharmony_ci<li><a href="path.html" class="nav-path active">Path</a></li> 1981cb0ef41Sopenharmony_ci<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 1991cb0ef41Sopenharmony_ci<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 2001cb0ef41Sopenharmony_ci<li><a href="process.html" class="nav-process">Process</a></li> 2011cb0ef41Sopenharmony_ci<li><a href="punycode.html" class="nav-punycode">Punycode</a></li> 2021cb0ef41Sopenharmony_ci<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 2031cb0ef41Sopenharmony_ci<li><a href="readline.html" class="nav-readline">Readline</a></li> 2041cb0ef41Sopenharmony_ci<li><a href="repl.html" class="nav-repl">REPL</a></li> 2051cb0ef41Sopenharmony_ci<li><a href="report.html" class="nav-report">Report</a></li> 2061cb0ef41Sopenharmony_ci<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 2071cb0ef41Sopenharmony_ci<li><a href="stream.html" class="nav-stream">Stream</a></li> 2081cb0ef41Sopenharmony_ci<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 2091cb0ef41Sopenharmony_ci<li><a href="test.html" class="nav-test">Test runner</a></li> 2101cb0ef41Sopenharmony_ci<li><a href="timers.html" class="nav-timers">Timers</a></li> 2111cb0ef41Sopenharmony_ci<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 2121cb0ef41Sopenharmony_ci<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 2131cb0ef41Sopenharmony_ci<li><a href="tty.html" class="nav-tty">TTY</a></li> 2141cb0ef41Sopenharmony_ci<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 2151cb0ef41Sopenharmony_ci<li><a href="url.html" class="nav-url">URL</a></li> 2161cb0ef41Sopenharmony_ci<li><a href="util.html" class="nav-util">Utilities</a></li> 2171cb0ef41Sopenharmony_ci<li><a href="v8.html" class="nav-v8">V8</a></li> 2181cb0ef41Sopenharmony_ci<li><a href="vm.html" class="nav-vm">VM</a></li> 2191cb0ef41Sopenharmony_ci<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 2201cb0ef41Sopenharmony_ci<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 2211cb0ef41Sopenharmony_ci<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 2221cb0ef41Sopenharmony_ci<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 2231cb0ef41Sopenharmony_ci<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 2241cb0ef41Sopenharmony_ci</ul> 2251cb0ef41Sopenharmony_ci<hr class="line"> 2261cb0ef41Sopenharmony_ci<ul> 2271cb0ef41Sopenharmony_ci<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 2281cb0ef41Sopenharmony_ci</ul></div> 2291cb0ef41Sopenharmony_ci </li> 2301cb0ef41Sopenharmony_ci 2311cb0ef41Sopenharmony_ci 2321cb0ef41Sopenharmony_ci <li class="picker-header"> 2331cb0ef41Sopenharmony_ci <a href="#"> 2341cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 2351cb0ef41Sopenharmony_ci Other versions 2361cb0ef41Sopenharmony_ci </a> 2371cb0ef41Sopenharmony_ci <div class="picker"><ol id="alt-docs"><li><a href="https://nodejs.org/docs/latest-v21.x/api/path.html">21.x</a></li> 2381cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v20.x/api/path.html">20.x <b>LTS</b></a></li> 2391cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v19.x/api/path.html">19.x</a></li> 2401cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v18.x/api/path.html">18.x <b>LTS</b></a></li> 2411cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v17.x/api/path.html">17.x</a></li> 2421cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v16.x/api/path.html">16.x</a></li> 2431cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v15.x/api/path.html">15.x</a></li> 2441cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v14.x/api/path.html">14.x</a></li> 2451cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v13.x/api/path.html">13.x</a></li> 2461cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v12.x/api/path.html">12.x</a></li> 2471cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v11.x/api/path.html">11.x</a></li> 2481cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v10.x/api/path.html">10.x</a></li> 2491cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v9.x/api/path.html">9.x</a></li> 2501cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v8.x/api/path.html">8.x</a></li> 2511cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v7.x/api/path.html">7.x</a></li> 2521cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v6.x/api/path.html">6.x</a></li> 2531cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v5.x/api/path.html">5.x</a></li> 2541cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v4.x/api/path.html">4.x</a></li> 2551cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v0.12.x/api/path.html">0.12.x</a></li> 2561cb0ef41Sopenharmony_ci<li><a href="https://nodejs.org/docs/latest-v0.10.x/api/path.html">0.10.x</a></li></ol></div> 2571cb0ef41Sopenharmony_ci </li> 2581cb0ef41Sopenharmony_ci 2591cb0ef41Sopenharmony_ci <li class="picker-header"> 2601cb0ef41Sopenharmony_ci <a href="#"> 2611cb0ef41Sopenharmony_ci <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 2621cb0ef41Sopenharmony_ci Options 2631cb0ef41Sopenharmony_ci </a> 2641cb0ef41Sopenharmony_ci 2651cb0ef41Sopenharmony_ci <div class="picker"> 2661cb0ef41Sopenharmony_ci <ul> 2671cb0ef41Sopenharmony_ci <li> 2681cb0ef41Sopenharmony_ci <a href="all.html">View on single page</a> 2691cb0ef41Sopenharmony_ci </li> 2701cb0ef41Sopenharmony_ci <li> 2711cb0ef41Sopenharmony_ci <a href="path.json">View as JSON</a> 2721cb0ef41Sopenharmony_ci </li> 2731cb0ef41Sopenharmony_ci <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/main/doc/api/path.md">Edit on GitHub</a></li> 2741cb0ef41Sopenharmony_ci </ul> 2751cb0ef41Sopenharmony_ci </div> 2761cb0ef41Sopenharmony_ci </li> 2771cb0ef41Sopenharmony_ci </ul> 2781cb0ef41Sopenharmony_ci </div> 2791cb0ef41Sopenharmony_ci <hr> 2801cb0ef41Sopenharmony_ci </header> 2811cb0ef41Sopenharmony_ci 2821cb0ef41Sopenharmony_ci <details id="toc" open><summary>Table of contents</summary><ul> 2831cb0ef41Sopenharmony_ci<li><span class="stability_2"><a href="#path">Path</a></span> 2841cb0ef41Sopenharmony_ci<ul> 2851cb0ef41Sopenharmony_ci<li><a href="#windows-vs-posix">Windows vs. POSIX</a></li> 2861cb0ef41Sopenharmony_ci<li><a href="#pathbasenamepath-suffix"><code>path.basename(path[, suffix])</code></a></li> 2871cb0ef41Sopenharmony_ci<li><a href="#pathdelimiter"><code>path.delimiter</code></a></li> 2881cb0ef41Sopenharmony_ci<li><a href="#pathdirnamepath"><code>path.dirname(path)</code></a></li> 2891cb0ef41Sopenharmony_ci<li><a href="#pathextnamepath"><code>path.extname(path)</code></a></li> 2901cb0ef41Sopenharmony_ci<li><a href="#pathformatpathobject"><code>path.format(pathObject)</code></a></li> 2911cb0ef41Sopenharmony_ci<li><a href="#pathisabsolutepath"><code>path.isAbsolute(path)</code></a></li> 2921cb0ef41Sopenharmony_ci<li><a href="#pathjoinpaths"><code>path.join([...paths])</code></a></li> 2931cb0ef41Sopenharmony_ci<li><a href="#pathnormalizepath"><code>path.normalize(path)</code></a></li> 2941cb0ef41Sopenharmony_ci<li><a href="#pathparsepath"><code>path.parse(path)</code></a></li> 2951cb0ef41Sopenharmony_ci<li><a href="#pathposix"><code>path.posix</code></a></li> 2961cb0ef41Sopenharmony_ci<li><a href="#pathrelativefrom-to"><code>path.relative(from, to)</code></a></li> 2971cb0ef41Sopenharmony_ci<li><a href="#pathresolvepaths"><code>path.resolve([...paths])</code></a></li> 2981cb0ef41Sopenharmony_ci<li><a href="#pathsep"><code>path.sep</code></a></li> 2991cb0ef41Sopenharmony_ci<li><a href="#pathtonamespacedpathpath"><code>path.toNamespacedPath(path)</code></a></li> 3001cb0ef41Sopenharmony_ci<li><a href="#pathwin32"><code>path.win32</code></a></li> 3011cb0ef41Sopenharmony_ci</ul> 3021cb0ef41Sopenharmony_ci</li> 3031cb0ef41Sopenharmony_ci</ul></details> 3041cb0ef41Sopenharmony_ci 3051cb0ef41Sopenharmony_ci <div id="apicontent"> 3061cb0ef41Sopenharmony_ci <h2>Path<span><a class="mark" href="#path" id="path">#</a></span><a aria-hidden="true" class="legacy" id="path_path"></a></h2> 3071cb0ef41Sopenharmony_ci 3081cb0ef41Sopenharmony_ci<p></p><div class="api_stability api_stability_2"><a href="documentation.html#stability-index">Stability: 2</a> - Stable</div><p></p> 3091cb0ef41Sopenharmony_ci<p><strong>Source Code:</strong> <a href="https://github.com/nodejs/node/blob/v18.20.1/lib/path.js">lib/path.js</a></p> 3101cb0ef41Sopenharmony_ci<p>The <code>node:path</code> module provides utilities for working with file and directory 3111cb0ef41Sopenharmony_cipaths. It can be accessed using:</p> 3121cb0ef41Sopenharmony_ci<pre><code class="language-js"><span class="hljs-keyword">const</span> path = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node:path'</span>);</code> <button class="copy-button">copy</button></pre> 3131cb0ef41Sopenharmony_ci<section><h3>Windows vs. POSIX<span><a class="mark" href="#windows-vs-posix" id="windows-vs-posix">#</a></span><a aria-hidden="true" class="legacy" id="path_windows_vs_posix"></a></h3> 3141cb0ef41Sopenharmony_ci<p>The default operation of the <code>node:path</code> module varies based on the operating 3151cb0ef41Sopenharmony_cisystem on which a Node.js application is running. Specifically, when running on 3161cb0ef41Sopenharmony_cia Windows operating system, the <code>node:path</code> module will assume that 3171cb0ef41Sopenharmony_ciWindows-style paths are being used.</p> 3181cb0ef41Sopenharmony_ci<p>So using <code>path.basename()</code> might yield different results on POSIX and Windows:</p> 3191cb0ef41Sopenharmony_ci<p>On POSIX:</p> 3201cb0ef41Sopenharmony_ci<pre><code class="language-js">path.<span class="hljs-title function_">basename</span>(<span class="hljs-string">'C:\\temp\\myfile.html'</span>); 3211cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: 'C:\\temp\\myfile.html'</span></code> <button class="copy-button">copy</button></pre> 3221cb0ef41Sopenharmony_ci<p>On Windows:</p> 3231cb0ef41Sopenharmony_ci<pre><code class="language-js">path.<span class="hljs-title function_">basename</span>(<span class="hljs-string">'C:\\temp\\myfile.html'</span>); 3241cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: 'myfile.html'</span></code> <button class="copy-button">copy</button></pre> 3251cb0ef41Sopenharmony_ci<p>To achieve consistent results when working with Windows file paths on any 3261cb0ef41Sopenharmony_cioperating system, use <a href="#pathwin32"><code>path.win32</code></a>:</p> 3271cb0ef41Sopenharmony_ci<p>On POSIX and Windows:</p> 3281cb0ef41Sopenharmony_ci<pre><code class="language-js">path.<span class="hljs-property">win32</span>.<span class="hljs-title function_">basename</span>(<span class="hljs-string">'C:\\temp\\myfile.html'</span>); 3291cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: 'myfile.html'</span></code> <button class="copy-button">copy</button></pre> 3301cb0ef41Sopenharmony_ci<p>To achieve consistent results when working with POSIX file paths on any 3311cb0ef41Sopenharmony_cioperating system, use <a href="#pathposix"><code>path.posix</code></a>:</p> 3321cb0ef41Sopenharmony_ci<p>On POSIX and Windows:</p> 3331cb0ef41Sopenharmony_ci<pre><code class="language-js">path.<span class="hljs-property">posix</span>.<span class="hljs-title function_">basename</span>(<span class="hljs-string">'/tmp/myfile.html'</span>); 3341cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: 'myfile.html'</span></code> <button class="copy-button">copy</button></pre> 3351cb0ef41Sopenharmony_ci<p>On Windows Node.js follows the concept of per-drive working directory. 3361cb0ef41Sopenharmony_ciThis behavior can be observed when using a drive path without a backslash. For 3371cb0ef41Sopenharmony_ciexample, <code>path.resolve('C:\\')</code> can potentially return a different result than 3381cb0ef41Sopenharmony_ci<code>path.resolve('C:')</code>. For more information, see 3391cb0ef41Sopenharmony_ci<a href="https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#fully-qualified-vs-relative-paths">this MSDN page</a>.</p> 3401cb0ef41Sopenharmony_ci</section><section><h3><code>path.basename(path[, suffix])</code><span><a class="mark" href="#pathbasenamepath-suffix" id="pathbasenamepath-suffix">#</a></span><a aria-hidden="true" class="legacy" id="path_path_basename_path_suffix"></a></h3> 3411cb0ef41Sopenharmony_ci<div class="api_metadata"> 3421cb0ef41Sopenharmony_ci<details class="changelog"><summary>History</summary> 3431cb0ef41Sopenharmony_ci<table> 3441cb0ef41Sopenharmony_ci<tbody><tr><th>Version</th><th>Changes</th></tr> 3451cb0ef41Sopenharmony_ci<tr><td>v6.0.0</td> 3461cb0ef41Sopenharmony_ci<td><p>Passing a non-string as the <code>path</code> argument will throw now.</p></td></tr> 3471cb0ef41Sopenharmony_ci<tr><td>v0.1.25</td> 3481cb0ef41Sopenharmony_ci<td><p><span>Added in: v0.1.25</span></p></td></tr> 3491cb0ef41Sopenharmony_ci</tbody></table> 3501cb0ef41Sopenharmony_ci</details> 3511cb0ef41Sopenharmony_ci</div> 3521cb0ef41Sopenharmony_ci<ul> 3531cb0ef41Sopenharmony_ci<li><code>path</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3541cb0ef41Sopenharmony_ci<li><code>suffix</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> An optional suffix to remove</li> 3551cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3561cb0ef41Sopenharmony_ci</ul> 3571cb0ef41Sopenharmony_ci<p>The <code>path.basename()</code> method returns the last portion of a <code>path</code>, similar to 3581cb0ef41Sopenharmony_cithe Unix <code>basename</code> command. Trailing <a href="#pathsep">directory separators</a> are 3591cb0ef41Sopenharmony_ciignored.</p> 3601cb0ef41Sopenharmony_ci<pre><code class="language-js">path.<span class="hljs-title function_">basename</span>(<span class="hljs-string">'/foo/bar/baz/asdf/quux.html'</span>); 3611cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: 'quux.html'</span> 3621cb0ef41Sopenharmony_ci 3631cb0ef41Sopenharmony_cipath.<span class="hljs-title function_">basename</span>(<span class="hljs-string">'/foo/bar/baz/asdf/quux.html'</span>, <span class="hljs-string">'.html'</span>); 3641cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: 'quux'</span></code> <button class="copy-button">copy</button></pre> 3651cb0ef41Sopenharmony_ci<p>Although Windows usually treats file names, including file extensions, in a 3661cb0ef41Sopenharmony_cicase-insensitive manner, this function does not. For example, <code>C:\\foo.html</code> and 3671cb0ef41Sopenharmony_ci<code>C:\\foo.HTML</code> refer to the same file, but <code>basename</code> treats the extension as a 3681cb0ef41Sopenharmony_cicase-sensitive string:</p> 3691cb0ef41Sopenharmony_ci<pre><code class="language-js">path.<span class="hljs-property">win32</span>.<span class="hljs-title function_">basename</span>(<span class="hljs-string">'C:\\foo.html'</span>, <span class="hljs-string">'.html'</span>); 3701cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: 'foo'</span> 3711cb0ef41Sopenharmony_ci 3721cb0ef41Sopenharmony_cipath.<span class="hljs-property">win32</span>.<span class="hljs-title function_">basename</span>(<span class="hljs-string">'C:\\foo.HTML'</span>, <span class="hljs-string">'.html'</span>); 3731cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: 'foo.HTML'</span></code> <button class="copy-button">copy</button></pre> 3741cb0ef41Sopenharmony_ci<p>A <a href="errors.html#class-typeerror"><code>TypeError</code></a> is thrown if <code>path</code> is not a string or if <code>suffix</code> is given 3751cb0ef41Sopenharmony_ciand is not a string.</p> 3761cb0ef41Sopenharmony_ci</section><section><h3><code>path.delimiter</code><span><a class="mark" href="#pathdelimiter" id="pathdelimiter">#</a></span><a aria-hidden="true" class="legacy" id="path_path_delimiter"></a></h3> 3771cb0ef41Sopenharmony_ci<div class="api_metadata"> 3781cb0ef41Sopenharmony_ci<span>Added in: v0.9.3</span> 3791cb0ef41Sopenharmony_ci</div> 3801cb0ef41Sopenharmony_ci<ul> 3811cb0ef41Sopenharmony_ci<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 3821cb0ef41Sopenharmony_ci</ul> 3831cb0ef41Sopenharmony_ci<p>Provides the platform-specific path delimiter:</p> 3841cb0ef41Sopenharmony_ci<ul> 3851cb0ef41Sopenharmony_ci<li><code>;</code> for Windows</li> 3861cb0ef41Sopenharmony_ci<li><code>:</code> for POSIX</li> 3871cb0ef41Sopenharmony_ci</ul> 3881cb0ef41Sopenharmony_ci<p>For example, on POSIX:</p> 3891cb0ef41Sopenharmony_ci<pre><code class="language-js"><span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(process.<span class="hljs-property">env</span>.<span class="hljs-property">PATH</span>); 3901cb0ef41Sopenharmony_ci<span class="hljs-comment">// Prints: '/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin'</span> 3911cb0ef41Sopenharmony_ci 3921cb0ef41Sopenharmony_ciprocess.<span class="hljs-property">env</span>.<span class="hljs-property">PATH</span>.<span class="hljs-title function_">split</span>(path.<span class="hljs-property">delimiter</span>); 3931cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: ['/usr/bin', '/bin', '/usr/sbin', '/sbin', '/usr/local/bin']</span></code> <button class="copy-button">copy</button></pre> 3941cb0ef41Sopenharmony_ci<p>On Windows:</p> 3951cb0ef41Sopenharmony_ci<pre><code class="language-js"><span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(process.<span class="hljs-property">env</span>.<span class="hljs-property">PATH</span>); 3961cb0ef41Sopenharmony_ci<span class="hljs-comment">// Prints: 'C:\Windows\system32;C:\Windows;C:\Program Files\node\'</span> 3971cb0ef41Sopenharmony_ci 3981cb0ef41Sopenharmony_ciprocess.<span class="hljs-property">env</span>.<span class="hljs-property">PATH</span>.<span class="hljs-title function_">split</span>(path.<span class="hljs-property">delimiter</span>); 3991cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns ['C:\\Windows\\system32', 'C:\\Windows', 'C:\\Program Files\\node\\']</span></code> <button class="copy-button">copy</button></pre> 4001cb0ef41Sopenharmony_ci</section><section><h3><code>path.dirname(path)</code><span><a class="mark" href="#pathdirnamepath" id="pathdirnamepath">#</a></span><a aria-hidden="true" class="legacy" id="path_path_dirname_path"></a></h3> 4011cb0ef41Sopenharmony_ci<div class="api_metadata"> 4021cb0ef41Sopenharmony_ci<details class="changelog"><summary>History</summary> 4031cb0ef41Sopenharmony_ci<table> 4041cb0ef41Sopenharmony_ci<tbody><tr><th>Version</th><th>Changes</th></tr> 4051cb0ef41Sopenharmony_ci<tr><td>v6.0.0</td> 4061cb0ef41Sopenharmony_ci<td><p>Passing a non-string as the <code>path</code> argument will throw now.</p></td></tr> 4071cb0ef41Sopenharmony_ci<tr><td>v0.1.16</td> 4081cb0ef41Sopenharmony_ci<td><p><span>Added in: v0.1.16</span></p></td></tr> 4091cb0ef41Sopenharmony_ci</tbody></table> 4101cb0ef41Sopenharmony_ci</details> 4111cb0ef41Sopenharmony_ci</div> 4121cb0ef41Sopenharmony_ci<ul> 4131cb0ef41Sopenharmony_ci<li><code>path</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 4141cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 4151cb0ef41Sopenharmony_ci</ul> 4161cb0ef41Sopenharmony_ci<p>The <code>path.dirname()</code> method returns the directory name of a <code>path</code>, similar to 4171cb0ef41Sopenharmony_cithe Unix <code>dirname</code> command. Trailing directory separators are ignored, see 4181cb0ef41Sopenharmony_ci<a href="#pathsep"><code>path.sep</code></a>.</p> 4191cb0ef41Sopenharmony_ci<pre><code class="language-js">path.<span class="hljs-title function_">dirname</span>(<span class="hljs-string">'/foo/bar/baz/asdf/quux'</span>); 4201cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: '/foo/bar/baz/asdf'</span></code> <button class="copy-button">copy</button></pre> 4211cb0ef41Sopenharmony_ci<p>A <a href="errors.html#class-typeerror"><code>TypeError</code></a> is thrown if <code>path</code> is not a string.</p> 4221cb0ef41Sopenharmony_ci</section><section><h3><code>path.extname(path)</code><span><a class="mark" href="#pathextnamepath" id="pathextnamepath">#</a></span><a aria-hidden="true" class="legacy" id="path_path_extname_path"></a></h3> 4231cb0ef41Sopenharmony_ci<div class="api_metadata"> 4241cb0ef41Sopenharmony_ci<details class="changelog"><summary>History</summary> 4251cb0ef41Sopenharmony_ci<table> 4261cb0ef41Sopenharmony_ci<tbody><tr><th>Version</th><th>Changes</th></tr> 4271cb0ef41Sopenharmony_ci<tr><td>v6.0.0</td> 4281cb0ef41Sopenharmony_ci<td><p>Passing a non-string as the <code>path</code> argument will throw now.</p></td></tr> 4291cb0ef41Sopenharmony_ci<tr><td>v0.1.25</td> 4301cb0ef41Sopenharmony_ci<td><p><span>Added in: v0.1.25</span></p></td></tr> 4311cb0ef41Sopenharmony_ci</tbody></table> 4321cb0ef41Sopenharmony_ci</details> 4331cb0ef41Sopenharmony_ci</div> 4341cb0ef41Sopenharmony_ci<ul> 4351cb0ef41Sopenharmony_ci<li><code>path</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 4361cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 4371cb0ef41Sopenharmony_ci</ul> 4381cb0ef41Sopenharmony_ci<p>The <code>path.extname()</code> method returns the extension of the <code>path</code>, from the last 4391cb0ef41Sopenharmony_cioccurrence of the <code>.</code> (period) character to end of string in the last portion of 4401cb0ef41Sopenharmony_cithe <code>path</code>. If there is no <code>.</code> in the last portion of the <code>path</code>, or if 4411cb0ef41Sopenharmony_cithere are no <code>.</code> characters other than the first character of 4421cb0ef41Sopenharmony_cithe basename of <code>path</code> (see <code>path.basename()</code>) , an empty string is returned.</p> 4431cb0ef41Sopenharmony_ci<pre><code class="language-js">path.<span class="hljs-title function_">extname</span>(<span class="hljs-string">'index.html'</span>); 4441cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: '.html'</span> 4451cb0ef41Sopenharmony_ci 4461cb0ef41Sopenharmony_cipath.<span class="hljs-title function_">extname</span>(<span class="hljs-string">'index.coffee.md'</span>); 4471cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: '.md'</span> 4481cb0ef41Sopenharmony_ci 4491cb0ef41Sopenharmony_cipath.<span class="hljs-title function_">extname</span>(<span class="hljs-string">'index.'</span>); 4501cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: '.'</span> 4511cb0ef41Sopenharmony_ci 4521cb0ef41Sopenharmony_cipath.<span class="hljs-title function_">extname</span>(<span class="hljs-string">'index'</span>); 4531cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: ''</span> 4541cb0ef41Sopenharmony_ci 4551cb0ef41Sopenharmony_cipath.<span class="hljs-title function_">extname</span>(<span class="hljs-string">'.index'</span>); 4561cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: ''</span> 4571cb0ef41Sopenharmony_ci 4581cb0ef41Sopenharmony_cipath.<span class="hljs-title function_">extname</span>(<span class="hljs-string">'.index.md'</span>); 4591cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: '.md'</span></code> <button class="copy-button">copy</button></pre> 4601cb0ef41Sopenharmony_ci<p>A <a href="errors.html#class-typeerror"><code>TypeError</code></a> is thrown if <code>path</code> is not a string.</p> 4611cb0ef41Sopenharmony_ci</section><section><h3><code>path.format(pathObject)</code><span><a class="mark" href="#pathformatpathobject" id="pathformatpathobject">#</a></span><a aria-hidden="true" class="legacy" id="path_path_format_pathobject"></a></h3> 4621cb0ef41Sopenharmony_ci<div class="api_metadata"> 4631cb0ef41Sopenharmony_ci<span>Added in: v0.11.15</span> 4641cb0ef41Sopenharmony_ci</div> 4651cb0ef41Sopenharmony_ci<ul> 4661cb0ef41Sopenharmony_ci<li><code>pathObject</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> Any JavaScript object having the following properties: 4671cb0ef41Sopenharmony_ci<ul> 4681cb0ef41Sopenharmony_ci<li><code>dir</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 4691cb0ef41Sopenharmony_ci<li><code>root</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 4701cb0ef41Sopenharmony_ci<li><code>base</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 4711cb0ef41Sopenharmony_ci<li><code>name</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 4721cb0ef41Sopenharmony_ci<li><code>ext</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 4731cb0ef41Sopenharmony_ci</ul> 4741cb0ef41Sopenharmony_ci</li> 4751cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 4761cb0ef41Sopenharmony_ci</ul> 4771cb0ef41Sopenharmony_ci<p>The <code>path.format()</code> method returns a path string from an object. This is the 4781cb0ef41Sopenharmony_ciopposite of <a href="#pathparsepath"><code>path.parse()</code></a>.</p> 4791cb0ef41Sopenharmony_ci<p>When providing properties to the <code>pathObject</code> remember that there are 4801cb0ef41Sopenharmony_cicombinations where one property has priority over another:</p> 4811cb0ef41Sopenharmony_ci<ul> 4821cb0ef41Sopenharmony_ci<li><code>pathObject.root</code> is ignored if <code>pathObject.dir</code> is provided</li> 4831cb0ef41Sopenharmony_ci<li><code>pathObject.ext</code> and <code>pathObject.name</code> are ignored if <code>pathObject.base</code> exists</li> 4841cb0ef41Sopenharmony_ci</ul> 4851cb0ef41Sopenharmony_ci<p>For example, on POSIX:</p> 4861cb0ef41Sopenharmony_ci<pre><code class="language-js"><span class="hljs-comment">// If `dir`, `root` and `base` are provided,</span> 4871cb0ef41Sopenharmony_ci<span class="hljs-comment">// `${dir}${path.sep}${base}`</span> 4881cb0ef41Sopenharmony_ci<span class="hljs-comment">// will be returned. `root` is ignored.</span> 4891cb0ef41Sopenharmony_cipath.<span class="hljs-title function_">format</span>({ 4901cb0ef41Sopenharmony_ci <span class="hljs-attr">root</span>: <span class="hljs-string">'/ignored'</span>, 4911cb0ef41Sopenharmony_ci <span class="hljs-attr">dir</span>: <span class="hljs-string">'/home/user/dir'</span>, 4921cb0ef41Sopenharmony_ci <span class="hljs-attr">base</span>: <span class="hljs-string">'file.txt'</span>, 4931cb0ef41Sopenharmony_ci}); 4941cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: '/home/user/dir/file.txt'</span> 4951cb0ef41Sopenharmony_ci 4961cb0ef41Sopenharmony_ci<span class="hljs-comment">// `root` will be used if `dir` is not specified.</span> 4971cb0ef41Sopenharmony_ci<span class="hljs-comment">// If only `root` is provided or `dir` is equal to `root` then the</span> 4981cb0ef41Sopenharmony_ci<span class="hljs-comment">// platform separator will not be included. `ext` will be ignored.</span> 4991cb0ef41Sopenharmony_cipath.<span class="hljs-title function_">format</span>({ 5001cb0ef41Sopenharmony_ci <span class="hljs-attr">root</span>: <span class="hljs-string">'/'</span>, 5011cb0ef41Sopenharmony_ci <span class="hljs-attr">base</span>: <span class="hljs-string">'file.txt'</span>, 5021cb0ef41Sopenharmony_ci <span class="hljs-attr">ext</span>: <span class="hljs-string">'ignored'</span>, 5031cb0ef41Sopenharmony_ci}); 5041cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: '/file.txt'</span> 5051cb0ef41Sopenharmony_ci 5061cb0ef41Sopenharmony_ci<span class="hljs-comment">// `name` + `ext` will be used if `base` is not specified.</span> 5071cb0ef41Sopenharmony_cipath.<span class="hljs-title function_">format</span>({ 5081cb0ef41Sopenharmony_ci <span class="hljs-attr">root</span>: <span class="hljs-string">'/'</span>, 5091cb0ef41Sopenharmony_ci <span class="hljs-attr">name</span>: <span class="hljs-string">'file'</span>, 5101cb0ef41Sopenharmony_ci <span class="hljs-attr">ext</span>: <span class="hljs-string">'.txt'</span>, 5111cb0ef41Sopenharmony_ci}); 5121cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: '/file.txt'</span></code> <button class="copy-button">copy</button></pre> 5131cb0ef41Sopenharmony_ci<p>On Windows:</p> 5141cb0ef41Sopenharmony_ci<pre><code class="language-js">path.<span class="hljs-title function_">format</span>({ 5151cb0ef41Sopenharmony_ci <span class="hljs-attr">dir</span>: <span class="hljs-string">'C:\\path\\dir'</span>, 5161cb0ef41Sopenharmony_ci <span class="hljs-attr">base</span>: <span class="hljs-string">'file.txt'</span>, 5171cb0ef41Sopenharmony_ci}); 5181cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: 'C:\\path\\dir\\file.txt'</span></code> <button class="copy-button">copy</button></pre> 5191cb0ef41Sopenharmony_ci</section><section><h3><code>path.isAbsolute(path)</code><span><a class="mark" href="#pathisabsolutepath" id="pathisabsolutepath">#</a></span><a aria-hidden="true" class="legacy" id="path_path_isabsolute_path"></a></h3> 5201cb0ef41Sopenharmony_ci<div class="api_metadata"> 5211cb0ef41Sopenharmony_ci<span>Added in: v0.11.2</span> 5221cb0ef41Sopenharmony_ci</div> 5231cb0ef41Sopenharmony_ci<ul> 5241cb0ef41Sopenharmony_ci<li><code>path</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 5251cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> 5261cb0ef41Sopenharmony_ci</ul> 5271cb0ef41Sopenharmony_ci<p>The <code>path.isAbsolute()</code> method determines if <code>path</code> is an absolute path.</p> 5281cb0ef41Sopenharmony_ci<p>If the given <code>path</code> is a zero-length string, <code>false</code> will be returned.</p> 5291cb0ef41Sopenharmony_ci<p>For example, on POSIX:</p> 5301cb0ef41Sopenharmony_ci<pre><code class="language-js">path.<span class="hljs-title function_">isAbsolute</span>(<span class="hljs-string">'/foo/bar'</span>); <span class="hljs-comment">// true</span> 5311cb0ef41Sopenharmony_cipath.<span class="hljs-title function_">isAbsolute</span>(<span class="hljs-string">'/baz/..'</span>); <span class="hljs-comment">// true</span> 5321cb0ef41Sopenharmony_cipath.<span class="hljs-title function_">isAbsolute</span>(<span class="hljs-string">'qux/'</span>); <span class="hljs-comment">// false</span> 5331cb0ef41Sopenharmony_cipath.<span class="hljs-title function_">isAbsolute</span>(<span class="hljs-string">'.'</span>); <span class="hljs-comment">// false</span></code> <button class="copy-button">copy</button></pre> 5341cb0ef41Sopenharmony_ci<p>On Windows:</p> 5351cb0ef41Sopenharmony_ci<pre><code class="language-js">path.<span class="hljs-title function_">isAbsolute</span>(<span class="hljs-string">'//server'</span>); <span class="hljs-comment">// true</span> 5361cb0ef41Sopenharmony_cipath.<span class="hljs-title function_">isAbsolute</span>(<span class="hljs-string">'\\\\server'</span>); <span class="hljs-comment">// true</span> 5371cb0ef41Sopenharmony_cipath.<span class="hljs-title function_">isAbsolute</span>(<span class="hljs-string">'C:/foo/..'</span>); <span class="hljs-comment">// true</span> 5381cb0ef41Sopenharmony_cipath.<span class="hljs-title function_">isAbsolute</span>(<span class="hljs-string">'C:\\foo\\..'</span>); <span class="hljs-comment">// true</span> 5391cb0ef41Sopenharmony_cipath.<span class="hljs-title function_">isAbsolute</span>(<span class="hljs-string">'bar\\baz'</span>); <span class="hljs-comment">// false</span> 5401cb0ef41Sopenharmony_cipath.<span class="hljs-title function_">isAbsolute</span>(<span class="hljs-string">'bar/baz'</span>); <span class="hljs-comment">// false</span> 5411cb0ef41Sopenharmony_cipath.<span class="hljs-title function_">isAbsolute</span>(<span class="hljs-string">'.'</span>); <span class="hljs-comment">// false</span></code> <button class="copy-button">copy</button></pre> 5421cb0ef41Sopenharmony_ci<p>A <a href="errors.html#class-typeerror"><code>TypeError</code></a> is thrown if <code>path</code> is not a string.</p> 5431cb0ef41Sopenharmony_ci</section><section><h3><code>path.join([...paths])</code><span><a class="mark" href="#pathjoinpaths" id="pathjoinpaths">#</a></span><a aria-hidden="true" class="legacy" id="path_path_join_paths"></a></h3> 5441cb0ef41Sopenharmony_ci<div class="api_metadata"> 5451cb0ef41Sopenharmony_ci<span>Added in: v0.1.16</span> 5461cb0ef41Sopenharmony_ci</div> 5471cb0ef41Sopenharmony_ci<ul> 5481cb0ef41Sopenharmony_ci<li><code>...paths</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> A sequence of path segments</li> 5491cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 5501cb0ef41Sopenharmony_ci</ul> 5511cb0ef41Sopenharmony_ci<p>The <code>path.join()</code> method joins all given <code>path</code> segments together using the 5521cb0ef41Sopenharmony_ciplatform-specific separator as a delimiter, then normalizes the resulting path.</p> 5531cb0ef41Sopenharmony_ci<p>Zero-length <code>path</code> segments are ignored. If the joined path string is a 5541cb0ef41Sopenharmony_cizero-length string then <code>'.'</code> will be returned, representing the current 5551cb0ef41Sopenharmony_ciworking directory.</p> 5561cb0ef41Sopenharmony_ci<pre><code class="language-js">path.<span class="hljs-title function_">join</span>(<span class="hljs-string">'/foo'</span>, <span class="hljs-string">'bar'</span>, <span class="hljs-string">'baz/asdf'</span>, <span class="hljs-string">'quux'</span>, <span class="hljs-string">'..'</span>); 5571cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: '/foo/bar/baz/asdf'</span> 5581cb0ef41Sopenharmony_ci 5591cb0ef41Sopenharmony_cipath.<span class="hljs-title function_">join</span>(<span class="hljs-string">'foo'</span>, {}, <span class="hljs-string">'bar'</span>); 5601cb0ef41Sopenharmony_ci<span class="hljs-comment">// Throws 'TypeError: Path must be a string. Received {}'</span></code> <button class="copy-button">copy</button></pre> 5611cb0ef41Sopenharmony_ci<p>A <a href="errors.html#class-typeerror"><code>TypeError</code></a> is thrown if any of the path segments is not a string.</p> 5621cb0ef41Sopenharmony_ci</section><section><h3><code>path.normalize(path)</code><span><a class="mark" href="#pathnormalizepath" id="pathnormalizepath">#</a></span><a aria-hidden="true" class="legacy" id="path_path_normalize_path"></a></h3> 5631cb0ef41Sopenharmony_ci<div class="api_metadata"> 5641cb0ef41Sopenharmony_ci<span>Added in: v0.1.23</span> 5651cb0ef41Sopenharmony_ci</div> 5661cb0ef41Sopenharmony_ci<ul> 5671cb0ef41Sopenharmony_ci<li><code>path</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 5681cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 5691cb0ef41Sopenharmony_ci</ul> 5701cb0ef41Sopenharmony_ci<p>The <code>path.normalize()</code> method normalizes the given <code>path</code>, resolving <code>'..'</code> and 5711cb0ef41Sopenharmony_ci<code>'.'</code> segments.</p> 5721cb0ef41Sopenharmony_ci<p>When multiple, sequential path segment separation characters are found (e.g. 5731cb0ef41Sopenharmony_ci<code>/</code> on POSIX and either <code>\</code> or <code>/</code> on Windows), they are replaced by a single 5741cb0ef41Sopenharmony_ciinstance of the platform-specific path segment separator (<code>/</code> on POSIX and 5751cb0ef41Sopenharmony_ci<code>\</code> on Windows). Trailing separators are preserved.</p> 5761cb0ef41Sopenharmony_ci<p>If the <code>path</code> is a zero-length string, <code>'.'</code> is returned, representing the 5771cb0ef41Sopenharmony_cicurrent working directory.</p> 5781cb0ef41Sopenharmony_ci<p>For example, on POSIX:</p> 5791cb0ef41Sopenharmony_ci<pre><code class="language-js">path.<span class="hljs-title function_">normalize</span>(<span class="hljs-string">'/foo/bar//baz/asdf/quux/..'</span>); 5801cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: '/foo/bar/baz/asdf'</span></code> <button class="copy-button">copy</button></pre> 5811cb0ef41Sopenharmony_ci<p>On Windows:</p> 5821cb0ef41Sopenharmony_ci<pre><code class="language-js">path.<span class="hljs-title function_">normalize</span>(<span class="hljs-string">'C:\\temp\\\\foo\\bar\\..\\'</span>); 5831cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: 'C:\\temp\\foo\\'</span></code> <button class="copy-button">copy</button></pre> 5841cb0ef41Sopenharmony_ci<p>Since Windows recognizes multiple path separators, both separators will be 5851cb0ef41Sopenharmony_cireplaced by instances of the Windows preferred separator (<code>\</code>):</p> 5861cb0ef41Sopenharmony_ci<pre><code class="language-js">path.<span class="hljs-property">win32</span>.<span class="hljs-title function_">normalize</span>(<span class="hljs-string">'C:////temp\\\\/\\/\\/foo/bar'</span>); 5871cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: 'C:\\temp\\foo\\bar'</span></code> <button class="copy-button">copy</button></pre> 5881cb0ef41Sopenharmony_ci<p>A <a href="errors.html#class-typeerror"><code>TypeError</code></a> is thrown if <code>path</code> is not a string.</p> 5891cb0ef41Sopenharmony_ci</section><section><h3><code>path.parse(path)</code><span><a class="mark" href="#pathparsepath" id="pathparsepath">#</a></span><a aria-hidden="true" class="legacy" id="path_path_parse_path"></a></h3> 5901cb0ef41Sopenharmony_ci<div class="api_metadata"> 5911cb0ef41Sopenharmony_ci<span>Added in: v0.11.15</span> 5921cb0ef41Sopenharmony_ci</div> 5931cb0ef41Sopenharmony_ci<ul> 5941cb0ef41Sopenharmony_ci<li><code>path</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 5951cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 5961cb0ef41Sopenharmony_ci</ul> 5971cb0ef41Sopenharmony_ci<p>The <code>path.parse()</code> method returns an object whose properties represent 5981cb0ef41Sopenharmony_cisignificant elements of the <code>path</code>. Trailing directory separators are ignored, 5991cb0ef41Sopenharmony_cisee <a href="#pathsep"><code>path.sep</code></a>.</p> 6001cb0ef41Sopenharmony_ci<p>The returned object will have the following properties:</p> 6011cb0ef41Sopenharmony_ci<ul> 6021cb0ef41Sopenharmony_ci<li><code>dir</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 6031cb0ef41Sopenharmony_ci<li><code>root</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 6041cb0ef41Sopenharmony_ci<li><code>base</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 6051cb0ef41Sopenharmony_ci<li><code>name</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 6061cb0ef41Sopenharmony_ci<li><code>ext</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 6071cb0ef41Sopenharmony_ci</ul> 6081cb0ef41Sopenharmony_ci<p>For example, on POSIX:</p> 6091cb0ef41Sopenharmony_ci<pre><code class="language-js">path.<span class="hljs-title function_">parse</span>(<span class="hljs-string">'/home/user/dir/file.txt'</span>); 6101cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns:</span> 6111cb0ef41Sopenharmony_ci<span class="hljs-comment">// { root: '/',</span> 6121cb0ef41Sopenharmony_ci<span class="hljs-comment">// dir: '/home/user/dir',</span> 6131cb0ef41Sopenharmony_ci<span class="hljs-comment">// base: 'file.txt',</span> 6141cb0ef41Sopenharmony_ci<span class="hljs-comment">// ext: '.txt',</span> 6151cb0ef41Sopenharmony_ci<span class="hljs-comment">// name: 'file' }</span></code> <button class="copy-button">copy</button></pre> 6161cb0ef41Sopenharmony_ci<pre><code class="language-text">┌─────────────────────┬────────────┐ 6171cb0ef41Sopenharmony_ci│ dir │ base │ 6181cb0ef41Sopenharmony_ci├──────┬ ├──────┬─────┤ 6191cb0ef41Sopenharmony_ci│ root │ │ name │ ext │ 6201cb0ef41Sopenharmony_ci" / home/user/dir / file .txt " 6211cb0ef41Sopenharmony_ci└──────┴──────────────┴──────┴─────┘ 6221cb0ef41Sopenharmony_ci(All spaces in the "" line should be ignored. They are purely for formatting.)</code> <button class="copy-button">copy</button></pre> 6231cb0ef41Sopenharmony_ci<p>On Windows:</p> 6241cb0ef41Sopenharmony_ci<pre><code class="language-js">path.<span class="hljs-title function_">parse</span>(<span class="hljs-string">'C:\\path\\dir\\file.txt'</span>); 6251cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns:</span> 6261cb0ef41Sopenharmony_ci<span class="hljs-comment">// { root: 'C:\\',</span> 6271cb0ef41Sopenharmony_ci<span class="hljs-comment">// dir: 'C:\\path\\dir',</span> 6281cb0ef41Sopenharmony_ci<span class="hljs-comment">// base: 'file.txt',</span> 6291cb0ef41Sopenharmony_ci<span class="hljs-comment">// ext: '.txt',</span> 6301cb0ef41Sopenharmony_ci<span class="hljs-comment">// name: 'file' }</span></code> <button class="copy-button">copy</button></pre> 6311cb0ef41Sopenharmony_ci<pre><code class="language-text">┌─────────────────────┬────────────┐ 6321cb0ef41Sopenharmony_ci│ dir │ base │ 6331cb0ef41Sopenharmony_ci├──────┬ ├──────┬─────┤ 6341cb0ef41Sopenharmony_ci│ root │ │ name │ ext │ 6351cb0ef41Sopenharmony_ci" C:\ path\dir \ file .txt " 6361cb0ef41Sopenharmony_ci└──────┴──────────────┴──────┴─────┘ 6371cb0ef41Sopenharmony_ci(All spaces in the "" line should be ignored. They are purely for formatting.)</code> <button class="copy-button">copy</button></pre> 6381cb0ef41Sopenharmony_ci<p>A <a href="errors.html#class-typeerror"><code>TypeError</code></a> is thrown if <code>path</code> is not a string.</p> 6391cb0ef41Sopenharmony_ci</section><section><h3><code>path.posix</code><span><a class="mark" href="#pathposix" id="pathposix">#</a></span><a aria-hidden="true" class="legacy" id="path_path_posix"></a></h3> 6401cb0ef41Sopenharmony_ci<div class="api_metadata"> 6411cb0ef41Sopenharmony_ci<details class="changelog"><summary>History</summary> 6421cb0ef41Sopenharmony_ci<table> 6431cb0ef41Sopenharmony_ci<tbody><tr><th>Version</th><th>Changes</th></tr> 6441cb0ef41Sopenharmony_ci<tr><td>v15.3.0</td> 6451cb0ef41Sopenharmony_ci<td><p>Exposed as <code>require('path/posix')</code>.</p></td></tr> 6461cb0ef41Sopenharmony_ci<tr><td>v0.11.15</td> 6471cb0ef41Sopenharmony_ci<td><p><span>Added in: v0.11.15</span></p></td></tr> 6481cb0ef41Sopenharmony_ci</tbody></table> 6491cb0ef41Sopenharmony_ci</details> 6501cb0ef41Sopenharmony_ci</div> 6511cb0ef41Sopenharmony_ci<ul> 6521cb0ef41Sopenharmony_ci<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 6531cb0ef41Sopenharmony_ci</ul> 6541cb0ef41Sopenharmony_ci<p>The <code>path.posix</code> property provides access to POSIX specific implementations 6551cb0ef41Sopenharmony_ciof the <code>path</code> methods.</p> 6561cb0ef41Sopenharmony_ci<p>The API is accessible via <code>require('node:path').posix</code> or <code>require('node:path/posix')</code>.</p> 6571cb0ef41Sopenharmony_ci</section><section><h3><code>path.relative(from, to)</code><span><a class="mark" href="#pathrelativefrom-to" id="pathrelativefrom-to">#</a></span><a aria-hidden="true" class="legacy" id="path_path_relative_from_to"></a></h3> 6581cb0ef41Sopenharmony_ci<div class="api_metadata"> 6591cb0ef41Sopenharmony_ci<details class="changelog"><summary>History</summary> 6601cb0ef41Sopenharmony_ci<table> 6611cb0ef41Sopenharmony_ci<tbody><tr><th>Version</th><th>Changes</th></tr> 6621cb0ef41Sopenharmony_ci<tr><td>v6.8.0</td> 6631cb0ef41Sopenharmony_ci<td><p>On Windows, the leading slashes for UNC paths are now included in the return value.</p></td></tr> 6641cb0ef41Sopenharmony_ci<tr><td>v0.5.0</td> 6651cb0ef41Sopenharmony_ci<td><p><span>Added in: v0.5.0</span></p></td></tr> 6661cb0ef41Sopenharmony_ci</tbody></table> 6671cb0ef41Sopenharmony_ci</details> 6681cb0ef41Sopenharmony_ci</div> 6691cb0ef41Sopenharmony_ci<ul> 6701cb0ef41Sopenharmony_ci<li><code>from</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 6711cb0ef41Sopenharmony_ci<li><code>to</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 6721cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 6731cb0ef41Sopenharmony_ci</ul> 6741cb0ef41Sopenharmony_ci<p>The <code>path.relative()</code> method returns the relative path from <code>from</code> to <code>to</code> based 6751cb0ef41Sopenharmony_cion the current working directory. If <code>from</code> and <code>to</code> each resolve to the same 6761cb0ef41Sopenharmony_cipath (after calling <code>path.resolve()</code> on each), a zero-length string is returned.</p> 6771cb0ef41Sopenharmony_ci<p>If a zero-length string is passed as <code>from</code> or <code>to</code>, the current working 6781cb0ef41Sopenharmony_cidirectory will be used instead of the zero-length strings.</p> 6791cb0ef41Sopenharmony_ci<p>For example, on POSIX:</p> 6801cb0ef41Sopenharmony_ci<pre><code class="language-js">path.<span class="hljs-title function_">relative</span>(<span class="hljs-string">'/data/orandea/test/aaa'</span>, <span class="hljs-string">'/data/orandea/impl/bbb'</span>); 6811cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: '../../impl/bbb'</span></code> <button class="copy-button">copy</button></pre> 6821cb0ef41Sopenharmony_ci<p>On Windows:</p> 6831cb0ef41Sopenharmony_ci<pre><code class="language-js">path.<span class="hljs-title function_">relative</span>(<span class="hljs-string">'C:\\orandea\\test\\aaa'</span>, <span class="hljs-string">'C:\\orandea\\impl\\bbb'</span>); 6841cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: '..\\..\\impl\\bbb'</span></code> <button class="copy-button">copy</button></pre> 6851cb0ef41Sopenharmony_ci<p>A <a href="errors.html#class-typeerror"><code>TypeError</code></a> is thrown if either <code>from</code> or <code>to</code> is not a string.</p> 6861cb0ef41Sopenharmony_ci</section><section><h3><code>path.resolve([...paths])</code><span><a class="mark" href="#pathresolvepaths" id="pathresolvepaths">#</a></span><a aria-hidden="true" class="legacy" id="path_path_resolve_paths"></a></h3> 6871cb0ef41Sopenharmony_ci<div class="api_metadata"> 6881cb0ef41Sopenharmony_ci<span>Added in: v0.3.4</span> 6891cb0ef41Sopenharmony_ci</div> 6901cb0ef41Sopenharmony_ci<ul> 6911cb0ef41Sopenharmony_ci<li><code>...paths</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> A sequence of paths or path segments</li> 6921cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 6931cb0ef41Sopenharmony_ci</ul> 6941cb0ef41Sopenharmony_ci<p>The <code>path.resolve()</code> method resolves a sequence of paths or path segments into 6951cb0ef41Sopenharmony_cian absolute path.</p> 6961cb0ef41Sopenharmony_ci<p>The given sequence of paths is processed from right to left, with each 6971cb0ef41Sopenharmony_cisubsequent <code>path</code> prepended until an absolute path is constructed. 6981cb0ef41Sopenharmony_ciFor instance, given the sequence of path segments: <code>/foo</code>, <code>/bar</code>, <code>baz</code>, 6991cb0ef41Sopenharmony_cicalling <code>path.resolve('/foo', '/bar', 'baz')</code> would return <code>/bar/baz</code> 7001cb0ef41Sopenharmony_cibecause <code>'baz'</code> is not an absolute path but <code>'/bar' + '/' + 'baz'</code> is.</p> 7011cb0ef41Sopenharmony_ci<p>If, after processing all given <code>path</code> segments, an absolute path has not yet 7021cb0ef41Sopenharmony_cibeen generated, the current working directory is used.</p> 7031cb0ef41Sopenharmony_ci<p>The resulting path is normalized and trailing slashes are removed unless the 7041cb0ef41Sopenharmony_cipath is resolved to the root directory.</p> 7051cb0ef41Sopenharmony_ci<p>Zero-length <code>path</code> segments are ignored.</p> 7061cb0ef41Sopenharmony_ci<p>If no <code>path</code> segments are passed, <code>path.resolve()</code> will return the absolute path 7071cb0ef41Sopenharmony_ciof the current working directory.</p> 7081cb0ef41Sopenharmony_ci<pre><code class="language-js">path.<span class="hljs-title function_">resolve</span>(<span class="hljs-string">'/foo/bar'</span>, <span class="hljs-string">'./baz'</span>); 7091cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: '/foo/bar/baz'</span> 7101cb0ef41Sopenharmony_ci 7111cb0ef41Sopenharmony_cipath.<span class="hljs-title function_">resolve</span>(<span class="hljs-string">'/foo/bar'</span>, <span class="hljs-string">'/tmp/file/'</span>); 7121cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: '/tmp/file'</span> 7131cb0ef41Sopenharmony_ci 7141cb0ef41Sopenharmony_cipath.<span class="hljs-title function_">resolve</span>(<span class="hljs-string">'wwwroot'</span>, <span class="hljs-string">'static_files/png/'</span>, <span class="hljs-string">'../gif/image.gif'</span>); 7151cb0ef41Sopenharmony_ci<span class="hljs-comment">// If the current working directory is /home/myself/node,</span> 7161cb0ef41Sopenharmony_ci<span class="hljs-comment">// this returns '/home/myself/node/wwwroot/static_files/gif/image.gif'</span></code> <button class="copy-button">copy</button></pre> 7171cb0ef41Sopenharmony_ci<p>A <a href="errors.html#class-typeerror"><code>TypeError</code></a> is thrown if any of the arguments is not a string.</p> 7181cb0ef41Sopenharmony_ci</section><section><h3><code>path.sep</code><span><a class="mark" href="#pathsep" id="pathsep">#</a></span><a aria-hidden="true" class="legacy" id="path_path_sep"></a></h3> 7191cb0ef41Sopenharmony_ci<div class="api_metadata"> 7201cb0ef41Sopenharmony_ci<span>Added in: v0.7.9</span> 7211cb0ef41Sopenharmony_ci</div> 7221cb0ef41Sopenharmony_ci<ul> 7231cb0ef41Sopenharmony_ci<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 7241cb0ef41Sopenharmony_ci</ul> 7251cb0ef41Sopenharmony_ci<p>Provides the platform-specific path segment separator:</p> 7261cb0ef41Sopenharmony_ci<ul> 7271cb0ef41Sopenharmony_ci<li><code>\</code> on Windows</li> 7281cb0ef41Sopenharmony_ci<li><code>/</code> on POSIX</li> 7291cb0ef41Sopenharmony_ci</ul> 7301cb0ef41Sopenharmony_ci<p>For example, on POSIX:</p> 7311cb0ef41Sopenharmony_ci<pre><code class="language-js"><span class="hljs-string">'foo/bar/baz'</span>.<span class="hljs-title function_">split</span>(path.<span class="hljs-property">sep</span>); 7321cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: ['foo', 'bar', 'baz']</span></code> <button class="copy-button">copy</button></pre> 7331cb0ef41Sopenharmony_ci<p>On Windows:</p> 7341cb0ef41Sopenharmony_ci<pre><code class="language-js"><span class="hljs-string">'foo\\bar\\baz'</span>.<span class="hljs-title function_">split</span>(path.<span class="hljs-property">sep</span>); 7351cb0ef41Sopenharmony_ci<span class="hljs-comment">// Returns: ['foo', 'bar', 'baz']</span></code> <button class="copy-button">copy</button></pre> 7361cb0ef41Sopenharmony_ci<p>On Windows, both the forward slash (<code>/</code>) and backward slash (<code>\</code>) are accepted 7371cb0ef41Sopenharmony_cias path segment separators; however, the <code>path</code> methods only add backward 7381cb0ef41Sopenharmony_cislashes (<code>\</code>).</p> 7391cb0ef41Sopenharmony_ci</section><section><h3><code>path.toNamespacedPath(path)</code><span><a class="mark" href="#pathtonamespacedpathpath" id="pathtonamespacedpathpath">#</a></span><a aria-hidden="true" class="legacy" id="path_path_tonamespacedpath_path"></a></h3> 7401cb0ef41Sopenharmony_ci<div class="api_metadata"> 7411cb0ef41Sopenharmony_ci<span>Added in: v9.0.0</span> 7421cb0ef41Sopenharmony_ci</div> 7431cb0ef41Sopenharmony_ci<ul> 7441cb0ef41Sopenharmony_ci<li><code>path</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 7451cb0ef41Sopenharmony_ci<li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 7461cb0ef41Sopenharmony_ci</ul> 7471cb0ef41Sopenharmony_ci<p>On Windows systems only, returns an equivalent <a href="https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#namespaces">namespace-prefixed path</a> for 7481cb0ef41Sopenharmony_cithe given <code>path</code>. If <code>path</code> is not a string, <code>path</code> will be returned without 7491cb0ef41Sopenharmony_cimodifications.</p> 7501cb0ef41Sopenharmony_ci<p>This method is meaningful only on Windows systems. On POSIX systems, the 7511cb0ef41Sopenharmony_cimethod is non-operational and always returns <code>path</code> without modifications.</p> 7521cb0ef41Sopenharmony_ci</section><section><h3><code>path.win32</code><span><a class="mark" href="#pathwin32" id="pathwin32">#</a></span><a aria-hidden="true" class="legacy" id="path_path_win32"></a></h3> 7531cb0ef41Sopenharmony_ci<div class="api_metadata"> 7541cb0ef41Sopenharmony_ci<details class="changelog"><summary>History</summary> 7551cb0ef41Sopenharmony_ci<table> 7561cb0ef41Sopenharmony_ci<tbody><tr><th>Version</th><th>Changes</th></tr> 7571cb0ef41Sopenharmony_ci<tr><td>v15.3.0</td> 7581cb0ef41Sopenharmony_ci<td><p>Exposed as <code>require('path/win32')</code>.</p></td></tr> 7591cb0ef41Sopenharmony_ci<tr><td>v0.11.15</td> 7601cb0ef41Sopenharmony_ci<td><p><span>Added in: v0.11.15</span></p></td></tr> 7611cb0ef41Sopenharmony_ci</tbody></table> 7621cb0ef41Sopenharmony_ci</details> 7631cb0ef41Sopenharmony_ci</div> 7641cb0ef41Sopenharmony_ci<ul> 7651cb0ef41Sopenharmony_ci<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> 7661cb0ef41Sopenharmony_ci</ul> 7671cb0ef41Sopenharmony_ci<p>The <code>path.win32</code> property provides access to Windows-specific implementations 7681cb0ef41Sopenharmony_ciof the <code>path</code> methods.</p> 7691cb0ef41Sopenharmony_ci<p>The API is accessible via <code>require('node:path').win32</code> or <code>require('node:path/win32')</code>.</p></section> 7701cb0ef41Sopenharmony_ci <!-- API END --> 7711cb0ef41Sopenharmony_ci </div> 7721cb0ef41Sopenharmony_ci </div> 7731cb0ef41Sopenharmony_ci </div> 7741cb0ef41Sopenharmony_ci</body> 7751cb0ef41Sopenharmony_ci</html> 776
