/
usr
/
share
/
doc
/
nodejs
/
api
/
/usr/share/doc/nodejs/api
mkdir
upload
Name
Size
Mode
Actions
assets/
-
0755
rm
addons.html
85172
0644
edit
dl
rm
addons.json.gz
11188
0644
edit
dl
rm
addons.md
41013
0644
edit
dl
rm
all.html
4598048
0644
edit
dl
rm
all.json.gz
681643
0644
edit
dl
rm
assert.html
110665
0644
edit
dl
rm
assert.json.gz
12007
0644
edit
dl
rm
assert.md
47147
0644
edit
dl
rm
async_hooks.html
83599
0644
edit
dl
rm
async_hooks.json.gz
14085
0644
edit
dl
rm
async_hooks.md
38888
0644
edit
dl
rm
buffer.html
245762
0644
edit
dl
rm
buffer.json.gz
24105
0644
edit
dl
rm
buffer.md
105044
0644
edit
dl
rm
child_process.html
136767
0644
edit
dl
rm
child_process.json.gz
19399
0644
edit
dl
rm
child_process.md
62919
0644
edit
dl
rm
cli.html
87936
0644
edit
dl
rm
cli.json.gz
16615
0644
edit
dl
rm
cli.md
42263
0644
edit
dl
rm
cluster.html
60116
0644
edit
dl
rm
cluster.json.gz
9557
0644
edit
dl
rm
cluster.md
25426
0644
edit
dl
rm
console.html
46093
0644
edit
dl
rm
console.json.gz
6056
0644
edit
dl
rm
console.md
16431
0644
edit
dl
rm
crypto.html
283043
0644
edit
dl
rm
crypto.json.gz
32118
0644
edit
dl
rm
crypto.md
125198
0644
edit
dl
rm
debugger.html
18089
0644
edit
dl
rm
debugger.json.gz
2820
0644
edit
dl
rm
debugger.md
6133
0644
edit
dl
rm
deprecations.html
138537
0644
edit
dl
rm
deprecations.json.gz
18470
0644
edit
dl
rm
deprecations.md
79120
0644
edit
dl
rm
dgram.html
62425
0644
edit
dl
rm
dgram.json.gz
9630
0644
edit
dl
rm
dgram.md
27746
0644
edit
dl
rm
dns.html
98289
0644
edit
dl
rm
dns.json.gz
13838
0644
edit
dl
rm
dns.md
40799
0644
edit
dl
rm
documentation.html
10978
0644
edit
dl
rm
documentation.json
3328
0644
edit
dl
rm
documentation.md
2247
0644
edit
dl
rm
domain.html
36301
0644
edit
dl
rm
domain.json.gz
6355
0644
edit
dl
rm
domain.md
15521
0644
edit
dl
rm
embedding.html
18165
0644
edit
dl
rm
embedding.json.gz
3625
0644
edit
dl
rm
embedding.md
8811
0644
edit
dl
rm
errors.html
182982
0644
edit
dl
rm
errors.json.gz
36479
0644
edit
dl
rm
errors.md
81734
0644
edit
dl
rm
esm.html
92490
0644
edit
dl
rm
esm.json.gz
15054
0644
edit
dl
rm
esm.md
48466
0644
edit
dl
rm
events.html
75986
0644
edit
dl
rm
events.json.gz
9561
0644
edit
dl
rm
events.md
28823
0644
edit
dl
rm
fs.html
437179
0644
edit
dl
rm
fs.json.gz
47095
0644
edit
dl
rm
fs.md
187735
0644
edit
dl
rm
globals.html
19795
0644
edit
dl
rm
globals.json.gz
2525
0644
edit
dl
rm
globals.md
5838
0644
edit
dl
rm
http.html
164378
0644
edit
dl
rm
http.json.gz
25888
0644
edit
dl
rm
http.md
74465
0644
edit
dl
rm
http2.html
256451
0644
edit
dl
rm
http2.json.gz
37157
0644
edit
dl
rm
http2.md
121722
0644
edit
dl
rm
https.html
38345
0644
edit
dl
rm
https.json.gz
4847
0644
edit
dl
rm
https.md
13942
0644
edit
dl
rm
index.html
10087
0644
edit
dl
rm
index.json
54
0644
edit
dl
rm
index.md
1825
0644
edit
dl
rm
inspector.html
22433
0644
edit
dl
rm
inspector.json.gz
3338
0644
edit
dl
rm
inspector.md
6825
0644
edit
dl
rm
intl.html
23154
0644
edit
dl
rm
intl.json.gz
4038
0644
edit
dl
rm
intl.md
11092
0644
edit
dl
rm
module.html
21739
0644
edit
dl
rm
module.json.gz
2821
0644
edit
dl
rm
module.md
5341
0644
edit
dl
rm
modules.html
61333
0644
edit
dl
rm
modules.json.gz
11897
0644
edit
dl
rm
modules.md
30610
0644
edit
dl
rm
n-api.html
340382
0644
edit
dl
rm
n-api.json.gz
48682
0644
edit
dl
rm
n-api.md
206268
0644
edit
dl
rm
net.html
95113
0644
edit
dl
rm
net.json.gz
14265
0644
edit
dl
rm
net.md
40473
0644
edit
dl
rm
os.html
58658
0644
edit
dl
rm
os.json.gz
8576
0644
edit
dl
rm
os.md
34632
0644
edit
dl
rm
packages.html
65483
0644
edit
dl
rm
packages.json.gz
12401
0644
edit
dl
rm
packages.md
36538
0644
edit
dl
rm
path.html
39321
0644
edit
dl
rm
path.json.gz
4873
0644
edit
dl
rm
path.md
14750
0644
edit
dl
rm
perf_hooks.html
56215
0644
edit
dl
rm
perf_hooks.json.gz
6973
0644
edit
dl
rm
perf_hooks.md
20116
0644
edit
dl
rm
policy.html
15908
0644
edit
dl
rm
policy.json.gz
2908
0644
edit
dl
rm
policy.md
6324
0644
edit
dl
rm
process.html
169341
0644
edit
dl
rm
process.json.gz
27734
0644
edit
dl
rm
process.md
82162
0644
edit
dl
rm
punycode.html
16904
0644
edit
dl
rm
punycode.json.gz
1939
0644
edit
dl
rm
punycode.md
4063
0644
edit
dl
rm
querystring.html
19334
0644
edit
dl
rm
querystring.json.gz
2519
0644
edit
dl
rm
querystring.md
5423
0644
edit
dl
rm
readline.html
58434
0644
edit
dl
rm
readline.json.gz
8835
0644
edit
dl
rm
readline.md
25133
0644
edit
dl
rm
repl.html
54152
0644
edit
dl
rm
repl.json.gz
10053
0644
edit
dl
rm
repl.md
23754
0644
edit
dl
rm
report.html
44941
0644
edit
dl
rm
report.json.gz
6227
0644
edit
dl
rm
report.md
18287
0644
edit
dl
rm
stream.html
200501
0644
edit
dl
rm
stream.json.gz
34485
0644
edit
dl
rm
stream.md
98619
0644
edit
dl
rm
string_decoder.html
14415
0644
edit
dl
rm
string_decoder.json.gz
1545
0644
edit
dl
rm
string_decoder.md
2934
0644
edit
dl
rm
synopsis.html
11475
0644
edit
dl
rm
synopsis.json
3013
0644
edit
dl
rm
synopsis.md
2129
0644
edit
dl
rm
timers.html
27467
0644
edit
dl
rm
timers.json.gz
3637
0644
edit
dl
rm
timers.md
9738
0644
edit
dl
rm
tls.html
148381
0644
edit
dl
rm
tls.json.gz
29988
0644
edit
dl
rm
tls.md
81388
0644
edit
dl
rm
tracing.html
19586
0644
edit
dl
rm
tracing.json.gz
2829
0644
edit
dl
rm
tracing.md
6756
0644
edit
dl
rm
tty.html
26930
0644
edit
dl
rm
tty.json.gz
3758
0644
edit
dl
rm
tty.md
8989
0644
edit
dl
rm
url.html
97495
0644
edit
dl
rm
url.json.gz
13611
0644
edit
dl
rm
url.md
44869
0644
edit
dl
rm
util.html
178081
0644
edit
dl
rm
util.json.gz
20542
0644
edit
dl
rm
util.md
71255
0644
edit
dl
rm
v8.html
44688
0644
edit
dl
rm
v8.json.gz
6082
0644
edit
dl
rm
v8.md
15533
0644
edit
dl
rm
vm.html
103392
0644
edit
dl
rm
vm.json.gz
14023
0644
edit
dl
rm
vm.md
48293
0644
edit
dl
rm
wasi.html
17088
0644
edit
dl
rm
wasi.json.gz
2814
0644
edit
dl
rm
wasi.md
5932
0644
edit
dl
rm
worker_threads.html
70808
0644
edit
dl
rm
worker_threads.json.gz
11326
0644
edit
dl
rm
worker_threads.md
33883
0644
edit
dl
rm
zlib.html
90124
0644
edit
dl
rm
zlib.json.gz
10569
0644
edit
dl
rm
zlib.md
35697
0644
edit
dl
rm
Edit:
/usr/share/doc/nodejs/api/path.html
(39321B)
<!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width"> <meta name="nodejs.org:node-version" content="v12.20.0"> <title>Path | Node.js v12.20.0 Documentation</title> <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700,400italic&display=fallback"> <link rel="stylesheet" href="assets/style.css"> <link rel="stylesheet" href="assets/hljs.css"> <link rel="canonical" href="https://nodejs.org/api/path.html"> </head> <body class="alt apidoc" id="api-section-path"> <div id="content" class="clearfix"> <div id="column2" class="interior"> <div id="intro" class="interior"> <a href="/" title="Go back to the home page"> Node.js </a> </div> <ul> <li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> <li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> </ul> <hr class="line"> <ul> <li><a href="assert.html" class="nav-assert">Assertion testing</a></li> <li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> <li><a href="buffer.html" class="nav-buffer">Buffer</a></li> <li><a href="addons.html" class="nav-addons">C++ Addons</a></li> <li><a href="n-api.html" class="nav-n-api">C/C++ Addons with N-API</a></li> <li><a href="embedding.html" class="nav-embedding">C++ Embedder API</a></li> <li><a href="child_process.html" class="nav-child_process">Child Processes</a></li> <li><a href="cluster.html" class="nav-cluster">Cluster</a></li> <li><a href="cli.html" class="nav-cli">Command line options</a></li> <li><a href="console.html" class="nav-console">Console</a></li> <li><a href="crypto.html" class="nav-crypto">Crypto</a></li> <li><a href="debugger.html" class="nav-debugger">Debugger</a></li> <li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> <li><a href="dns.html" class="nav-dns">DNS</a></li> <li><a href="domain.html" class="nav-domain">Domain</a></li> <li><a href="errors.html" class="nav-errors">Errors</a></li> <li><a href="events.html" class="nav-events">Events</a></li> <li><a href="fs.html" class="nav-fs">File system</a></li> <li><a href="globals.html" class="nav-globals">Globals</a></li> <li><a href="http.html" class="nav-http">HTTP</a></li> <li><a href="http2.html" class="nav-http2">HTTP/2</a></li> <li><a href="https.html" class="nav-https">HTTPS</a></li> <li><a href="inspector.html" class="nav-inspector">Inspector</a></li> <li><a href="intl.html" class="nav-intl">Internationalization</a></li> <li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> <li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> <li><a href="module.html" class="nav-module">Modules: <code>module</code> API</a></li> <li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> <li><a href="net.html" class="nav-net">Net</a></li> <li><a href="os.html" class="nav-os">OS</a></li> <li><a href="path.html" class="nav-path active">Path</a></li> <li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> <li><a href="policy.html" class="nav-policy">Policies</a></li> <li><a href="process.html" class="nav-process">Process</a></li> <li><a href="punycode.html" class="nav-punycode">Punycode</a></li> <li><a href="querystring.html" class="nav-querystring">Query strings</a></li> <li><a href="readline.html" class="nav-readline">Readline</a></li> <li><a href="repl.html" class="nav-repl">REPL</a></li> <li><a href="report.html" class="nav-report">Report</a></li> <li><a href="stream.html" class="nav-stream">Stream</a></li> <li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> <li><a href="timers.html" class="nav-timers">Timers</a></li> <li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> <li><a href="tracing.html" class="nav-tracing">Trace events</a></li> <li><a href="tty.html" class="nav-tty">TTY</a></li> <li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> <li><a href="url.html" class="nav-url">URL</a></li> <li><a href="util.html" class="nav-util">Utilities</a></li> <li><a href="v8.html" class="nav-v8">V8</a></li> <li><a href="vm.html" class="nav-vm">VM</a></li> <li><a href="wasi.html" class="nav-wasi">WASI</a></li> <li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> <li><a href="zlib.html" class="nav-zlib">Zlib</a></li> </ul> <hr class="line"> <ul> <li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> </ul> </div> <div id="column1" data-id="path" class="interior"> <header> <h1>Node.js v12.20.0 Documentation</h1> <div id="gtoc"> <ul> <li> <a href="index.html">Index</a> </li> <li> <a href="all.html">View on single page</a> </li> <li> <a href="path.json">View as JSON</a> </li> <li class="version-picker"> <a href="#">View another version <span>▼</span></a> <ol class="version-picker"><li><a href="https://nodejs.org/docs/latest-v15.x/api/path.html">15.x</a></li> <li><a href="https://nodejs.org/docs/latest-v14.x/api/path.html">14.x <b>LTS</b></a></li> <li><a href="https://nodejs.org/docs/latest-v13.x/api/path.html">13.x</a></li> <li><a href="https://nodejs.org/docs/latest-v12.x/api/path.html">12.x <b>LTS</b></a></li> <li><a href="https://nodejs.org/docs/latest-v11.x/api/path.html">11.x</a></li> <li><a href="https://nodejs.org/docs/latest-v10.x/api/path.html">10.x <b>LTS</b></a></li> <li><a href="https://nodejs.org/docs/latest-v9.x/api/path.html">9.x</a></li> <li><a href="https://nodejs.org/docs/latest-v8.x/api/path.html">8.x</a></li> <li><a href="https://nodejs.org/docs/latest-v7.x/api/path.html">7.x</a></li> <li><a href="https://nodejs.org/docs/latest-v6.x/api/path.html">6.x</a></li> <li><a href="https://nodejs.org/docs/latest-v5.x/api/path.html">5.x</a></li> <li><a href="https://nodejs.org/docs/latest-v4.x/api/path.html">4.x</a></li> <li><a href="https://nodejs.org/docs/latest-v0.12.x/api/path.html">0.12.x</a></li> <li><a href="https://nodejs.org/docs/latest-v0.10.x/api/path.html">0.10.x</a></li></ol> </li> <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/master/doc/api/path.md"><span class="github_icon"><svg height="16" width="16" viewBox="0 0 16.1 16.1" fill="currentColor"><path d="M8 0a8 8 0 0 0-2.5 15.6c.4 0 .5-.2.5-.4v-1.5c-2 .4-2.5-.5-2.7-1 0-.1-.5-.9-.8-1-.3-.2-.7-.6 0-.6.6 0 1 .6 1.2.8.7 1.2 1.9 1 2.4.7 0-.5.2-.9.5-1-1.8-.3-3.7-1-3.7-4 0-.9.3-1.6.8-2.2 0-.2-.3-1 .1-2 0 0 .7-.3 2.2.7a7.4 7.4 0 0 1 4 0c1.5-1 2.2-.8 2.2-.8.5 1.1.2 2 .1 2.1.5.6.8 1.3.8 2.2 0 3-1.9 3.7-3.6 4 .3.2.5.7.5 1.4v2.2c0 .2.1.5.5.4A8 8 0 0 0 16 8a8 8 0 0 0-8-8z"/></svg></span>Edit on GitHub</a></li> </ul> </div> <hr> </header> <div id="toc"> <h2>Table of Contents</h2> <ul> <li><span class="stability_2"><a href="#path_path">Path</a></span> <ul> <li><a href="#path_windows_vs_posix">Windows vs. POSIX</a></li> <li><a href="#path_path_basename_path_ext"><code>path.basename(path[, ext])</code></a></li> <li><a href="#path_path_delimiter"><code>path.delimiter</code></a></li> <li><a href="#path_path_dirname_path"><code>path.dirname(path)</code></a></li> <li><a href="#path_path_extname_path"><code>path.extname(path)</code></a></li> <li><a href="#path_path_format_pathobject"><code>path.format(pathObject)</code></a></li> <li><a href="#path_path_isabsolute_path"><code>path.isAbsolute(path)</code></a></li> <li><a href="#path_path_join_paths"><code>path.join([...paths])</code></a></li> <li><a href="#path_path_normalize_path"><code>path.normalize(path)</code></a></li> <li><a href="#path_path_parse_path"><code>path.parse(path)</code></a></li> <li><a href="#path_path_posix"><code>path.posix</code></a></li> <li><a href="#path_path_relative_from_to"><code>path.relative(from, to)</code></a></li> <li><a href="#path_path_resolve_paths"><code>path.resolve([...paths])</code></a></li> <li><a href="#path_path_sep"><code>path.sep</code></a></li> <li><a href="#path_path_tonamespacedpath_path"><code>path.toNamespacedPath(path)</code></a></li> <li><a href="#path_path_win32"><code>path.win32</code></a></li> </ul> </li> </ul> </div> <div id="apicontent"> <h1>Path<span><a class="mark" href="#path_path" id="path_path">#</a></span></h1> <p></p><div class="api_stability api_stability_2"><a href="documentation.html#documentation_stability_index">Stability: 2</a> - Stable</div><p></p> <p><strong>Source Code:</strong> <a href="https://github.com/nodejs/node/blob/v12.20.0/lib/path.js">lib/path.js</a></p> <p>The <code>path</code> module provides utilities for working with file and directory paths. It can be accessed using:</p> <pre><code class="language-js"><span class="hljs-keyword">const</span> path = <span class="hljs-built_in">require</span>(<span class="hljs-string">'path'</span>);</code></pre> <h2>Windows vs. POSIX<span><a class="mark" href="#path_windows_vs_posix" id="path_windows_vs_posix">#</a></span></h2> <p>The default operation of the <code>path</code> module varies based on the operating system on which a Node.js application is running. Specifically, when running on a Windows operating system, the <code>path</code> module will assume that Windows-style paths are being used.</p> <p>So using <code>path.basename()</code> might yield different results on POSIX and Windows:</p> <p>On POSIX:</p> <pre><code class="language-js">path.basename(<span class="hljs-string">'C:\\temp\\myfile.html'</span>); <span class="hljs-comment">// Returns: 'C:\\temp\\myfile.html'</span></code></pre> <p>On Windows:</p> <pre><code class="language-js">path.basename(<span class="hljs-string">'C:\\temp\\myfile.html'</span>); <span class="hljs-comment">// Returns: 'myfile.html'</span></code></pre> <p>To achieve consistent results when working with Windows file paths on any operating system, use <a href="#path_path_win32"><code>path.win32</code></a>:</p> <p>On POSIX and Windows:</p> <pre><code class="language-js">path.win32.basename(<span class="hljs-string">'C:\\temp\\myfile.html'</span>); <span class="hljs-comment">// Returns: 'myfile.html'</span></code></pre> <p>To achieve consistent results when working with POSIX file paths on any operating system, use <a href="#path_path_posix"><code>path.posix</code></a>:</p> <p>On POSIX and Windows:</p> <pre><code class="language-js">path.posix.basename(<span class="hljs-string">'/tmp/myfile.html'</span>); <span class="hljs-comment">// Returns: 'myfile.html'</span></code></pre> <p>On Windows Node.js follows the concept of per-drive working directory. This behavior can be observed when using a drive path without a backslash. For example, <code>path.resolve('C:\\')</code> can potentially return a different result than <code>path.resolve('C:')</code>. For more information, see <a href="https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#fully-qualified-vs-relative-paths">this MSDN page</a>.</p> <h2><code>path.basename(path[, ext])</code><span><a class="mark" href="#path_path_basename_path_ext" id="path_path_basename_path_ext">#</a></span></h2> <div class="api_metadata"> <details class="changelog"><summary>History</summary> <table> <tbody><tr><th>Version</th><th>Changes</th></tr> <tr><td>v6.0.0</td> <td><p>Passing a non-string as the <code>path</code> argument will throw now.</p></td></tr> <tr><td>v0.1.25</td> <td><p><span>Added in: v0.1.25</span></p></td></tr> </tbody></table> </details> </div> <ul> <li><code>path</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> <li><code>ext</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a> An optional file extension</li> <li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> </ul> <p>The <code>path.basename()</code> method returns the last portion of a <code>path</code>, similar to the Unix <code>basename</code> command. Trailing directory separators are ignored, see <a href="#path_path_sep"><code>path.sep</code></a>.</p> <pre><code class="language-js">path.basename(<span class="hljs-string">'/foo/bar/baz/asdf/quux.html'</span>); <span class="hljs-comment">// Returns: 'quux.html'</span> path.basename(<span class="hljs-string">'/foo/bar/baz/asdf/quux.html'</span>, <span class="hljs-string">'.html'</span>); <span class="hljs-comment">// Returns: 'quux'</span></code></pre> <p>Although Windows usually treats file names, including file extensions, in a case-insensitive manner, this function does not. For example, <code>C:\\foo.html</code> and <code>C:\\foo.HTML</code> refer to the same file, but <code>basename</code> treats the extension as a case-sensitive string:</p> <pre><code class="language-js">path.win32.basename(<span class="hljs-string">'C:\\foo.html'</span>, <span class="hljs-string">'.html'</span>); <span class="hljs-comment">// Returns: 'foo'</span> path.win32.basename(<span class="hljs-string">'C:\\foo.HTML'</span>, <span class="hljs-string">'.html'</span>); <span class="hljs-comment">// Returns: 'foo.HTML'</span></code></pre> <p>A <a href="errors.html#errors_class_typeerror"><code>TypeError</code></a> is thrown if <code>path</code> is not a string or if <code>ext</code> is given and is not a string.</p> <h2><code>path.delimiter</code><span><a class="mark" href="#path_path_delimiter" id="path_path_delimiter">#</a></span></h2> <div class="api_metadata"> <span>Added in: v0.9.3</span> </div> <ul> <li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> </ul> <p>Provides the platform-specific path delimiter:</p> <ul> <li><code>;</code> for Windows</li> <li><code>:</code> for POSIX</li> </ul> <p>For example, on POSIX:</p> <pre><code class="language-js"><span class="hljs-built_in">console</span>.log(process.env.PATH); <span class="hljs-comment">// Prints: '/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin'</span> process.env.PATH.split(path.delimiter); <span class="hljs-comment">// Returns: ['/usr/bin', '/bin', '/usr/sbin', '/sbin', '/usr/local/bin']</span></code></pre> <p>On Windows:</p> <pre><code class="language-js"><span class="hljs-built_in">console</span>.log(process.env.PATH); <span class="hljs-comment">// Prints: 'C:\Windows\system32;C:\Windows;C:\Program Files\node\'</span> process.env.PATH.split(path.delimiter); <span class="hljs-comment">// Returns ['C:\\Windows\\system32', 'C:\\Windows', 'C:\\Program Files\\node\\']</span></code></pre> <h2><code>path.dirname(path)</code><span><a class="mark" href="#path_path_dirname_path" id="path_path_dirname_path">#</a></span></h2> <div class="api_metadata"> <details class="changelog"><summary>History</summary> <table> <tbody><tr><th>Version</th><th>Changes</th></tr> <tr><td>v6.0.0</td> <td><p>Passing a non-string as the <code>path</code> argument will throw now.</p></td></tr> <tr><td>v0.1.16</td> <td><p><span>Added in: v0.1.16</span></p></td></tr> </tbody></table> </details> </div> <ul> <li><code>path</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> <li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> </ul> <p>The <code>path.dirname()</code> method returns the directory name of a <code>path</code>, similar to the Unix <code>dirname</code> command. Trailing directory separators are ignored, see <a href="#path_path_sep"><code>path.sep</code></a>.</p> <pre><code class="language-js">path.dirname(<span class="hljs-string">'/foo/bar/baz/asdf/quux'</span>); <span class="hljs-comment">// Returns: '/foo/bar/baz/asdf'</span></code></pre> <p>A <a href="errors.html#errors_class_typeerror"><code>TypeError</code></a> is thrown if <code>path</code> is not a string.</p> <h2><code>path.extname(path)</code><span><a class="mark" href="#path_path_extname_path" id="path_path_extname_path">#</a></span></h2> <div class="api_metadata"> <details class="changelog"><summary>History</summary> <table> <tbody><tr><th>Version</th><th>Changes</th></tr> <tr><td>v6.0.0</td> <td><p>Passing a non-string as the <code>path</code> argument will throw now.</p></td></tr> <tr><td>v0.1.25</td> <td><p><span>Added in: v0.1.25</span></p></td></tr> </tbody></table> </details> </div> <ul> <li><code>path</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> <li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> </ul> <p>The <code>path.extname()</code> method returns the extension of the <code>path</code>, from the last occurrence of the <code>.</code> (period) character to end of string in the last portion of the <code>path</code>. If there is no <code>.</code> in the last portion of the <code>path</code>, or if there are no <code>.</code> characters other than the first character of the basename of <code>path</code> (see <code>path.basename()</code>) , an empty string is returned.</p> <pre><code class="language-js">path.extname(<span class="hljs-string">'index.html'</span>); <span class="hljs-comment">// Returns: '.html'</span> path.extname(<span class="hljs-string">'index.coffee.md'</span>); <span class="hljs-comment">// Returns: '.md'</span> path.extname(<span class="hljs-string">'index.'</span>); <span class="hljs-comment">// Returns: '.'</span> path.extname(<span class="hljs-string">'index'</span>); <span class="hljs-comment">// Returns: ''</span> path.extname(<span class="hljs-string">'.index'</span>); <span class="hljs-comment">// Returns: ''</span> path.extname(<span class="hljs-string">'.index.md'</span>); <span class="hljs-comment">// Returns: '.md'</span></code></pre> <p>A <a href="errors.html#errors_class_typeerror"><code>TypeError</code></a> is thrown if <code>path</code> is not a string.</p> <h2><code>path.format(pathObject)</code><span><a class="mark" href="#path_path_format_pathobject" id="path_path_format_pathobject">#</a></span></h2> <div class="api_metadata"> <span>Added in: v0.11.15</span> </div> <ul> <li><code>pathObject</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> <ul> <li><code>dir</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> <li><code>root</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> <li><code>base</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> <li><code>name</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> <li><code>ext</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> </ul> </li> <li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> </ul> <p>The <code>path.format()</code> method returns a path string from an object. This is the opposite of <a href="#path_path_parse_path"><code>path.parse()</code></a>.</p> <p>When providing properties to the <code>pathObject</code> remember that there are combinations where one property has priority over another:</p> <ul> <li><code>pathObject.root</code> is ignored if <code>pathObject.dir</code> is provided</li> <li><code>pathObject.ext</code> and <code>pathObject.name</code> are ignored if <code>pathObject.base</code> exists</li> </ul> <p>For example, on POSIX:</p> <pre><code class="language-js"><span class="hljs-comment">// If `dir`, `root` and `base` are provided,</span> <span class="hljs-comment">// `${dir}${path.sep}${base}`</span> <span class="hljs-comment">// will be returned. `root` is ignored.</span> path.format({ <span class="hljs-attr">root</span>: <span class="hljs-string">'/ignored'</span>, <span class="hljs-attr">dir</span>: <span class="hljs-string">'/home/user/dir'</span>, <span class="hljs-attr">base</span>: <span class="hljs-string">'file.txt'</span> }); <span class="hljs-comment">// Returns: '/home/user/dir/file.txt'</span> <span class="hljs-comment">// `root` will be used if `dir` is not specified.</span> <span class="hljs-comment">// If only `root` is provided or `dir` is equal to `root` then the</span> <span class="hljs-comment">// platform separator will not be included. `ext` will be ignored.</span> path.format({ <span class="hljs-attr">root</span>: <span class="hljs-string">'/'</span>, <span class="hljs-attr">base</span>: <span class="hljs-string">'file.txt'</span>, <span class="hljs-attr">ext</span>: <span class="hljs-string">'ignored'</span> }); <span class="hljs-comment">// Returns: '/file.txt'</span> <span class="hljs-comment">// `name` + `ext` will be used if `base` is not specified.</span> path.format({ <span class="hljs-attr">root</span>: <span class="hljs-string">'/'</span>, <span class="hljs-attr">name</span>: <span class="hljs-string">'file'</span>, <span class="hljs-attr">ext</span>: <span class="hljs-string">'.txt'</span> }); <span class="hljs-comment">// Returns: '/file.txt'</span></code></pre> <p>On Windows:</p> <pre><code class="language-js">path.format({ <span class="hljs-attr">dir</span>: <span class="hljs-string">'C:\\path\\dir'</span>, <span class="hljs-attr">base</span>: <span class="hljs-string">'file.txt'</span> }); <span class="hljs-comment">// Returns: 'C:\\path\\dir\\file.txt'</span></code></pre> <h2><code>path.isAbsolute(path)</code><span><a class="mark" href="#path_path_isabsolute_path" id="path_path_isabsolute_path">#</a></span></h2> <div class="api_metadata"> <span>Added in: v0.11.2</span> </div> <ul> <li><code>path</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> <li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type" class="type"><boolean></a></li> </ul> <p>The <code>path.isAbsolute()</code> method determines if <code>path</code> is an absolute path.</p> <p>If the given <code>path</code> is a zero-length string, <code>false</code> will be returned.</p> <p>For example, on POSIX:</p> <pre><code class="language-js">path.isAbsolute(<span class="hljs-string">'/foo/bar'</span>); <span class="hljs-comment">// true</span> path.isAbsolute(<span class="hljs-string">'/baz/..'</span>); <span class="hljs-comment">// true</span> path.isAbsolute(<span class="hljs-string">'qux/'</span>); <span class="hljs-comment">// false</span> path.isAbsolute(<span class="hljs-string">'.'</span>); <span class="hljs-comment">// false</span></code></pre> <p>On Windows:</p> <pre><code class="language-js">path.isAbsolute(<span class="hljs-string">'//server'</span>); <span class="hljs-comment">// true</span> path.isAbsolute(<span class="hljs-string">'\\\\server'</span>); <span class="hljs-comment">// true</span> path.isAbsolute(<span class="hljs-string">'C:/foo/..'</span>); <span class="hljs-comment">// true</span> path.isAbsolute(<span class="hljs-string">'C:\\foo\\..'</span>); <span class="hljs-comment">// true</span> path.isAbsolute(<span class="hljs-string">'bar\\baz'</span>); <span class="hljs-comment">// false</span> path.isAbsolute(<span class="hljs-string">'bar/baz'</span>); <span class="hljs-comment">// false</span> path.isAbsolute(<span class="hljs-string">'.'</span>); <span class="hljs-comment">// false</span></code></pre> <p>A <a href="errors.html#errors_class_typeerror"><code>TypeError</code></a> is thrown if <code>path</code> is not a string.</p> <h2><code>path.join([...paths])</code><span><a class="mark" href="#path_path_join_paths" id="path_path_join_paths">#</a></span></h2> <div class="api_metadata"> <span>Added in: v0.1.16</span> </div> <ul> <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> <li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> </ul> <p>The <code>path.join()</code> method joins all given <code>path</code> segments together using the platform-specific separator as a delimiter, then normalizes the resulting path.</p> <p>Zero-length <code>path</code> segments are ignored. If the joined path string is a zero-length string then <code>'.'</code> will be returned, representing the current working directory.</p> <pre><code class="language-js">path.join(<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>); <span class="hljs-comment">// Returns: '/foo/bar/baz/asdf'</span> path.join(<span class="hljs-string">'foo'</span>, {}, <span class="hljs-string">'bar'</span>); <span class="hljs-comment">// Throws 'TypeError: Path must be a string. Received {}'</span></code></pre> <p>A <a href="errors.html#errors_class_typeerror"><code>TypeError</code></a> is thrown if any of the path segments is not a string.</p> <h2><code>path.normalize(path)</code><span><a class="mark" href="#path_path_normalize_path" id="path_path_normalize_path">#</a></span></h2> <div class="api_metadata"> <span>Added in: v0.1.23</span> </div> <ul> <li><code>path</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> <li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> </ul> <p>The <code>path.normalize()</code> method normalizes the given <code>path</code>, resolving <code>'..'</code> and <code>'.'</code> segments.</p> <p>When multiple, sequential path segment separation characters are found (e.g. <code>/</code> on POSIX and either <code>\</code> or <code>/</code> on Windows), they are replaced by a single instance of the platform-specific path segment separator (<code>/</code> on POSIX and <code>\</code> on Windows). Trailing separators are preserved.</p> <p>If the <code>path</code> is a zero-length string, <code>'.'</code> is returned, representing the current working directory.</p> <p>For example, on POSIX:</p> <pre><code class="language-js">path.normalize(<span class="hljs-string">'/foo/bar//baz/asdf/quux/..'</span>); <span class="hljs-comment">// Returns: '/foo/bar/baz/asdf'</span></code></pre> <p>On Windows:</p> <pre><code class="language-js">path.normalize(<span class="hljs-string">'C:\\temp\\\\foo\\bar\\..\\'</span>); <span class="hljs-comment">// Returns: 'C:\\temp\\foo\\'</span></code></pre> <p>Since Windows recognizes multiple path separators, both separators will be replaced by instances of the Windows preferred separator (<code>\</code>):</p> <pre><code class="language-js">path.win32.normalize(<span class="hljs-string">'C:////temp\\\\/\\/\\/foo/bar'</span>); <span class="hljs-comment">// Returns: 'C:\\temp\\foo\\bar'</span></code></pre> <p>A <a href="errors.html#errors_class_typeerror"><code>TypeError</code></a> is thrown if <code>path</code> is not a string.</p> <h2><code>path.parse(path)</code><span><a class="mark" href="#path_path_parse_path" id="path_path_parse_path">#</a></span></h2> <div class="api_metadata"> <span>Added in: v0.11.15</span> </div> <ul> <li><code>path</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> <li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> </ul> <p>The <code>path.parse()</code> method returns an object whose properties represent significant elements of the <code>path</code>. Trailing directory separators are ignored, see <a href="#path_path_sep"><code>path.sep</code></a>.</p> <p>The returned object will have the following properties:</p> <ul> <li><code>dir</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> <li><code>root</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> <li><code>base</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> <li><code>name</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> <li><code>ext</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> </ul> <p>For example, on POSIX:</p> <pre><code class="language-js">path.parse(<span class="hljs-string">'/home/user/dir/file.txt'</span>); <span class="hljs-comment">// Returns:</span> <span class="hljs-comment">// { root: '/',</span> <span class="hljs-comment">// dir: '/home/user/dir',</span> <span class="hljs-comment">// base: 'file.txt',</span> <span class="hljs-comment">// ext: '.txt',</span> <span class="hljs-comment">// name: 'file' }</span></code></pre> <pre><code class="language-text">┌─────────────────────┬────────────┐ │ dir │ base │ ├──────┬ ├──────┬─────┤ │ root │ │ name │ ext │ " / home/user/dir / file .txt " └──────┴──────────────┴──────┴─────┘ (All spaces in the "" line should be ignored. They are purely for formatting.)</code></pre> <p>On Windows:</p> <pre><code class="language-js">path.parse(<span class="hljs-string">'C:\\path\\dir\\file.txt'</span>); <span class="hljs-comment">// Returns:</span> <span class="hljs-comment">// { root: 'C:\\',</span> <span class="hljs-comment">// dir: 'C:\\path\\dir',</span> <span class="hljs-comment">// base: 'file.txt',</span> <span class="hljs-comment">// ext: '.txt',</span> <span class="hljs-comment">// name: 'file' }</span></code></pre> <pre><code class="language-text">┌─────────────────────┬────────────┐ │ dir │ base │ ├──────┬ ├──────┬─────┤ │ root │ │ name │ ext │ " C:\ path\dir \ file .txt " └──────┴──────────────┴──────┴─────┘ (All spaces in the "" line should be ignored. They are purely for formatting.)</code></pre> <p>A <a href="errors.html#errors_class_typeerror"><code>TypeError</code></a> is thrown if <code>path</code> is not a string.</p> <h2><code>path.posix</code><span><a class="mark" href="#path_path_posix" id="path_path_posix">#</a></span></h2> <div class="api_metadata"> <span>Added in: v0.11.15</span> </div> <ul> <li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> </ul> <p>The <code>path.posix</code> property provides access to POSIX specific implementations of the <code>path</code> methods.</p> <h2><code>path.relative(from, to)</code><span><a class="mark" href="#path_path_relative_from_to" id="path_path_relative_from_to">#</a></span></h2> <div class="api_metadata"> <details class="changelog"><summary>History</summary> <table> <tbody><tr><th>Version</th><th>Changes</th></tr> <tr><td>v6.8.0</td> <td><p>On Windows, the leading slashes for UNC paths are now included in the return value.</p></td></tr> <tr><td>v0.5.0</td> <td><p><span>Added in: v0.5.0</span></p></td></tr> </tbody></table> </details> </div> <ul> <li><code>from</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> <li><code>to</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> <li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> </ul> <p>The <code>path.relative()</code> method returns the relative path from <code>from</code> to <code>to</code> based on the current working directory. If <code>from</code> and <code>to</code> each resolve to the same path (after calling <code>path.resolve()</code> on each), a zero-length string is returned.</p> <p>If a zero-length string is passed as <code>from</code> or <code>to</code>, the current working directory will be used instead of the zero-length strings.</p> <p>For example, on POSIX:</p> <pre><code class="language-js">path.relative(<span class="hljs-string">'/data/orandea/test/aaa'</span>, <span class="hljs-string">'/data/orandea/impl/bbb'</span>); <span class="hljs-comment">// Returns: '../../impl/bbb'</span></code></pre> <p>On Windows:</p> <pre><code class="language-js">path.relative(<span class="hljs-string">'C:\\orandea\\test\\aaa'</span>, <span class="hljs-string">'C:\\orandea\\impl\\bbb'</span>); <span class="hljs-comment">// Returns: '..\\..\\impl\\bbb'</span></code></pre> <p>A <a href="errors.html#errors_class_typeerror"><code>TypeError</code></a> is thrown if either <code>from</code> or <code>to</code> is not a string.</p> <h2><code>path.resolve([...paths])</code><span><a class="mark" href="#path_path_resolve_paths" id="path_path_resolve_paths">#</a></span></h2> <div class="api_metadata"> <span>Added in: v0.3.4</span> </div> <ul> <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> <li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> </ul> <p>The <code>path.resolve()</code> method resolves a sequence of paths or path segments into an absolute path.</p> <p>The given sequence of paths is processed from right to left, with each subsequent <code>path</code> prepended until an absolute path is constructed. For instance, given the sequence of path segments: <code>/foo</code>, <code>/bar</code>, <code>baz</code>, calling <code>path.resolve('/foo', '/bar', 'baz')</code> would return <code>/bar/baz</code> because <code>'baz'</code> is not an absolute path but <code>'/bar' + '/' + 'baz'</code> is.</p> <p>If, after processing all given <code>path</code> segments, an absolute path has not yet been generated, the current working directory is used.</p> <p>The resulting path is normalized and trailing slashes are removed unless the path is resolved to the root directory.</p> <p>Zero-length <code>path</code> segments are ignored.</p> <p>If no <code>path</code> segments are passed, <code>path.resolve()</code> will return the absolute path of the current working directory.</p> <pre><code class="language-js">path.resolve(<span class="hljs-string">'/foo/bar'</span>, <span class="hljs-string">'./baz'</span>); <span class="hljs-comment">// Returns: '/foo/bar/baz'</span> path.resolve(<span class="hljs-string">'/foo/bar'</span>, <span class="hljs-string">'/tmp/file/'</span>); <span class="hljs-comment">// Returns: '/tmp/file'</span> path.resolve(<span class="hljs-string">'wwwroot'</span>, <span class="hljs-string">'static_files/png/'</span>, <span class="hljs-string">'../gif/image.gif'</span>); <span class="hljs-comment">// If the current working directory is /home/myself/node,</span> <span class="hljs-comment">// this returns '/home/myself/node/wwwroot/static_files/gif/image.gif'</span></code></pre> <p>A <a href="errors.html#errors_class_typeerror"><code>TypeError</code></a> is thrown if any of the arguments is not a string.</p> <h2><code>path.sep</code><span><a class="mark" href="#path_path_sep" id="path_path_sep">#</a></span></h2> <div class="api_metadata"> <span>Added in: v0.7.9</span> </div> <ul> <li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> </ul> <p>Provides the platform-specific path segment separator:</p> <ul> <li><code>\</code> on Windows</li> <li><code>/</code> on POSIX</li> </ul> <p>For example, on POSIX:</p> <pre><code class="language-js"><span class="hljs-string">'foo/bar/baz'</span>.split(path.sep); <span class="hljs-comment">// Returns: ['foo', 'bar', 'baz']</span></code></pre> <p>On Windows:</p> <pre><code class="language-js"><span class="hljs-string">'foo\\bar\\baz'</span>.split(path.sep); <span class="hljs-comment">// Returns: ['foo', 'bar', 'baz']</span></code></pre> <p>On Windows, both the forward slash (<code>/</code>) and backward slash (<code>\</code>) are accepted as path segment separators; however, the <code>path</code> methods only add backward slashes (<code>\</code>).</p> <h2><code>path.toNamespacedPath(path)</code><span><a class="mark" href="#path_path_tonamespacedpath_path" id="path_path_tonamespacedpath_path">#</a></span></h2> <div class="api_metadata"> <span>Added in: v9.0.0</span> </div> <ul> <li><code>path</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> <li>Returns: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> </ul> <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 the given <code>path</code>. If <code>path</code> is not a string, <code>path</code> will be returned without modifications.</p> <p>This method is meaningful only on Windows systems. On POSIX systems, the method is non-operational and always returns <code>path</code> without modifications.</p> <h2><code>path.win32</code><span><a class="mark" href="#path_path_win32" id="path_path_win32">#</a></span></h2> <div class="api_metadata"> <span>Added in: v0.11.15</span> </div> <ul> <li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> </ul> <p>The <code>path.win32</code> property provides access to Windows-specific implementations of the <code>path</code> methods.</p> <!-- API END --> </div> </div> </div> </body> </html>
Save
cmd:
run