路徑 | Node.js v25.0.0 文件 - Node.js 執行環境

路徑#

原始碼： lib/path.js

node:path 模組提供了用於處理檔案和目錄路徑的實用工具。可以透過以下方式訪問：

const path = require('node:path');import path from 'node:path';

Windows 與 POSIX#

node:path 模組的預設操作會根據 Node.js 應用程式執行的作業系統而有所不同。具體來說，當在 Windows 作業系統上執行時，node:path 模組會假定正在使用 Windows 風格的路徑。

因此，在 POSIX 和 Windows 上使用 path.basename() 可能會產生不同的結果。

在 POSIX 上

path.basename('C:\\temp\\myfile.html');
// Returns: 'C:\\temp\\myfile.html'

在 Windows 上

path.basename('C:\\temp\\myfile.html');
// Returns: 'myfile.html'

要在任何作業系統上處理 Windows 檔案路徑時獲得一致的結果，請使用 path.win32。

在 POSIX 和 Windows 上

path.win32.basename('C:\\temp\\myfile.html');
// Returns: 'myfile.html'

要在任何作業系統上處理 POSIX 檔案路徑時獲得一致的結果，請使用 path.posix。

在 POSIX 和 Windows 上

path.posix.basename('/tmp/myfile.html');
// Returns: 'myfile.html'

在 Windows 上，Node.js 遵循每個驅動器有各自工作目錄的概念。當使用不帶反斜槓的驅動器路徑時，可以觀察到此行為。例如，path.resolve('C:\\') 可能返回與 path.resolve('C:') 不同的結果。更多資訊，請參閱此 MSDN 頁面。

`path.basename(path[, suffix])`#

歷史

版本	變更
v6.0.0	現在，如果將非字串作為 `path` 引數傳遞，將會丟擲錯誤。
v0.1.25	引入於：v0.1.25

path <string>
suffix <string> 一個可選的要移除的字尾
返回: <string>

path.basename() 方法返回 path 的最後一部分，類似於 Unix 的 basename 命令。尾部的目錄分隔符會被忽略。

path.basename('/foo/bar/baz/asdf/quux.html');
// Returns: 'quux.html'

path.basename('/foo/bar/baz/asdf/quux.html', '.html');
// Returns: 'quux'

儘管 Windows 通常以不區分大小寫的方式處理檔名（包括副檔名），但此函式並非如此。例如，C:\\foo.html 和 C:\\foo.HTML 指的是同一個檔案，但 basename 將副檔名視為區分大小寫的字串。

path.win32.basename('C:\\foo.html', '.html');
// Returns: 'foo'

path.win32.basename('C:\\foo.HTML', '.html');
// Returns: 'foo.HTML'

如果 path 不是字串，或者提供了 suffix 但它不是字串，則會丟擲 TypeError。

`path.delimiter`#

引入於：v0.9.3

型別：<string>

提供特定於平臺的路徑定界符：

Windows 為 ;
POSIX 為 :

例如，在 POSIX 上：

console.log(process.env.PATH);
// Prints: '/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin'

process.env.PATH.split(path.delimiter);
// Returns: ['/usr/bin', '/bin', '/usr/sbin', '/sbin', '/usr/local/bin']

在 Windows 上

console.log(process.env.PATH);
// Prints: 'C:\Windows\system32;C:\Windows;C:\Program Files\node\'

process.env.PATH.split(path.delimiter);
// Returns ['C:\\Windows\\system32', 'C:\\Windows', 'C:\\Program Files\\node\\']

`path.dirname(path)`#

歷史

版本	變更
v6.0.0	現在，如果將非字串作為 `path` 引數傳遞，將會丟擲錯誤。
v0.1.16	引入於：v0.1.16

path <string>
返回: <string>

path.dirname() 方法返回一個 path 的目錄名，類似於 Unix 的 dirname 命令。尾部的目錄分隔符會被忽略，請參閱 path.sep。

path.dirname('/foo/bar/baz/asdf/quux');
// Returns: '/foo/bar/baz/asdf'

如果 path 不是字串，則會丟擲 TypeError。

`path.extname(path)`#

歷史

版本	變更
v6.0.0	現在，如果將非字串作為 `path` 引數傳遞，將會丟擲錯誤。
v0.1.25	引入於：v0.1.25

path <string>
返回: <string>

path.extname() 方法返回 path 的副檔名，即從 path 最後一部分中最後一次出現的 . (句點) 字元到字串末尾的部分。如果 path 的最後一部分沒有 .，或者除了 path 的基本名稱（參見 path.basename()）的第一個字元外沒有其他 . 字元，則返回一個空字串。

path.extname('index.html');
// Returns: '.html'

path.extname('index.coffee.md');
// Returns: '.md'

path.extname('index.');
// Returns: '.'

path.extname('index');
// Returns: ''

path.extname('.index');
// Returns: ''

path.extname('.index.md');
// Returns: '.md'

如果 path 不是字串，則會丟擲 TypeError。

`path.format(pathObject)`#

歷史

版本	變更
v19.0.0	如果 `ext` 中未指定，將會新增點（.）。
v0.11.15	添加於：v0.11.15

pathObject <Object> 任何具有以下屬性的 JavaScript 物件
- dir <string>
- root <string>
- base <string>
- name <string>
- ext <string>
返回: <string>

path.format() 方法從一個物件返回一個路徑字串。這與 path.parse() 相反。

當為 pathObject 提供屬性時，請記住在某些組合中，一個屬性的優先順序高於另一個：

如果提供了 pathObject.dir，則忽略 pathObject.root。
如果存在 pathObject.base，則忽略 pathObject.ext 和 pathObject.name。

例如，在 POSIX 上：

// If `dir`, `root` and `base` are provided,
// `${dir}${path.sep}${base}`
// will be returned. `root` is ignored.
path.format({
  root: '/ignored',
  dir: '/home/user/dir',
  base: 'file.txt',
});
// Returns: '/home/user/dir/file.txt'

// `root` will be used if `dir` is not specified.
// If only `root` is provided or `dir` is equal to `root` then the
// platform separator will not be included. `ext` will be ignored.
path.format({
  root: '/',
  base: 'file.txt',
  ext: 'ignored',
});
// Returns: '/file.txt'

// `name` + `ext` will be used if `base` is not specified.
path.format({
  root: '/',
  name: 'file',
  ext: '.txt',
});
// Returns: '/file.txt'

// The dot will be added if it is not specified in `ext`.
path.format({
  root: '/',
  name: 'file',
  ext: 'txt',
});
// Returns: '/file.txt'

在 Windows 上

path.format({
  dir: 'C:\\path\\dir',
  base: 'file.txt',
});
// Returns: 'C:\\path\\dir\\file.txt'

`path.matchesGlob(path, pattern)`#

歷史

版本	變更
v24.8.0, v22.20.0	將 API 標記為穩定。
v22.5.0, v20.17.0	引入於：v22.5.0, v20.17.0

path <string> 用於進行 glob 匹配的路徑。
pattern <string> 用於檢查路徑的 glob 模式。
返回: <boolean> path 是否匹配 pattern。

path.matchesGlob() 方法判斷 path 是否匹配 pattern。

例如：

path.matchesGlob('/foo/bar', '/foo/*'); // true
path.matchesGlob('/foo/bar*', 'foo/bird'); // false

如果 path 或 pattern 不是字串，則丟擲 TypeError。

`path.isAbsolute(path)`#

引入於：v0.11.2

path <string>
返回：<boolean>

path.isAbsolute() 方法判斷字面意義上的 path 是否為絕對路徑。因此，它對於防範路徑遍歷攻擊並不安全。

如果給定的 path 是一個零長度字串，將返回 false。

例如，在 POSIX 上：

path.isAbsolute('/foo/bar');   // true
path.isAbsolute('/baz/..');    // true
path.isAbsolute('/baz/../..'); // true
path.isAbsolute('qux/');       // false
path.isAbsolute('.');          // false

在 Windows 上

path.isAbsolute('//server');    // true
path.isAbsolute('\\\\server');  // true
path.isAbsolute('C:/foo/..');   // true
path.isAbsolute('C:\\foo\\..'); // true
path.isAbsolute('bar\\baz');    // false
path.isAbsolute('bar/baz');     // false
path.isAbsolute('.');           // false

如果 path 不是字串，則會丟擲 TypeError。

`path.join([...paths])`#

引入於：v0.1.16

...paths <string> 一系列路徑片段
返回: <string>

path.join() 方法使用平臺特定的分隔符作為定界符，將所有給定的 path 片段連線在一起，然後對結果路徑進行規範化。

零長度的 path 片段會被忽略。如果連線後的路徑字串是零長度字串，則會返回 '.'，表示當前工作目錄。

path.join('/foo', 'bar', 'baz/asdf', 'quux', '..');
// Returns: '/foo/bar/baz/asdf'

path.join('foo', {}, 'bar');
// Throws 'TypeError: Path must be a string. Received {}'

如果任何路徑片段不是字串，則會丟擲 TypeError。

`path.normalize(path)`#

引入於：v0.1.23

path <string>
返回: <string>

path.normalize() 方法規範化給定的 path，解析 '..' 和 '.' 片段。

當發現多個連續的路徑片段分隔符時（例如，在 POSIX 上的 /，在 Windows 上的 \ 或 /），它們會被替換為平臺特定的單個路徑片段分隔符（在 POSIX 上是 /，在 Windows 上是 \）。尾部的分隔符會被保留。

如果 path 是一個零長度字串，則返回 '.'，表示當前工作目錄。

在 POSIX 上，此函式應用的規範化型別不嚴格遵守 POSIX 規範。例如，此函式會將兩個前導斜槓替換為單個斜槓，就像它是一個常規的絕對路徑一樣，而少數 POSIX 系統對以恰好兩個前導斜槓開頭的路徑賦予特殊含義。同樣，此函式執行的其他替換，例如移除 .. 片段，可能會改變底層系統解析該路徑的方式。

例如，在 POSIX 上：

path.normalize('/foo/bar//baz/asdf/quux/..');
// Returns: '/foo/bar/baz/asdf'

在 Windows 上

path.normalize('C:\\temp\\\\foo\\bar\\..\\');
// Returns: 'C:\\temp\\foo\\'

由於 Windows 識別多種路徑分隔符，這兩種分隔符都將被替換為 Windows 首選分隔符 (\) 的例項。

path.win32.normalize('C:////temp\\\\/\\/\\/foo/bar');
// Returns: 'C:\\temp\\foo\\bar'

如果 path 不是字串，則會丟擲 TypeError。

`path.parse(path)`#

添加於：v0.11.15

path <string>
返回：<Object>

path.parse() 方法返回一個物件，其屬性表示 path 的重要元素。尾部的目錄分隔符會被忽略，請參閱 path.sep。

返回的物件將具有以下屬性：

dir <string>
root <string>
base <string>
name <string>
ext <string>

例如，在 POSIX 上：

path.parse('/home/user/dir/file.txt');
// Returns:
// { root: '/',
//   dir: '/home/user/dir',
//   base: 'file.txt',
//   ext: '.txt',
//   name: 'file' }

┌─────────────────────┬────────────┐
│          dir        │    base    │
├──────┬              ├──────┬─────┤
│ root │              │ name │ ext │
"  /    home/user/dir / file  .txt "
└──────┴──────────────┴──────┴─────┘
(All spaces in the "" line should be ignored. They are purely for formatting.)

在 Windows 上

path.parse('C:\\path\\dir\\file.txt');
// Returns:
// { root: 'C:\\',
//   dir: 'C:\\path\\dir',
//   base: 'file.txt',
//   ext: '.txt',
//   name: 'file' }

┌─────────────────────┬────────────┐
│          dir        │    base    │
├──────┬              ├──────┬─────┤
│ root │              │ name │ ext │
" C:\      path\dir   \ file  .txt "
└──────┴──────────────┴──────┴─────┘
(All spaces in the "" line should be ignored. They are purely for formatting.)

如果 path 不是字串，則會丟擲 TypeError。

`path.posix`#

歷史

版本	變更
v15.3.0	作為 `require('path/posix')` 暴露。
v0.11.15	添加於：v0.11.15

型別：<Object>

path.posix 屬性提供了對 path 方法的 POSIX 特定實現的訪問。

該 API 可透過 require('node:path').posix 或 require('node:path/posix') 訪問。

`path.relative(from, to)`#

歷史

版本	變更
v6.8.0	在 Windows 上，UNC 路徑的前導斜槓現在包含在返回值中。
v0.5.0	引入於：v0.5.0

from <string>
to <string>
返回: <string>

path.relative() 方法根據當前工作目錄返回從 from 到 to 的相對路徑。如果 from 和 to 解析到相同的路徑（在分別呼叫 path.resolve() 之後），則返回一個零長度字串。

如果將零長度字串作為 from 或 to 傳入，則將使用當前工作目錄代替零長度字串。

例如，在 POSIX 上：

path.relative('/data/orandea/test/aaa', '/data/orandea/impl/bbb');
// Returns: '../../impl/bbb'

在 Windows 上

path.relative('C:\\orandea\\test\\aaa', 'C:\\orandea\\impl\\bbb');
// Returns: '..\\..\\impl\\bbb'

如果 from 或 to 不是字串，則會丟擲 TypeError。

`path.resolve([...paths])`#

引入於：v0.3.4

...paths <string> 一系列路徑或路徑片段
返回: <string>

path.resolve() 方法將一系列路徑或路徑片段解析為一個絕對路徑。

給定的路徑序列從右到左進行處理，每個後續的 path 都會被前置，直到構造出一個絕對路徑。例如，給定路徑片段序列：/foo、/bar、baz，呼叫 path.resolve('/foo', '/bar', 'baz') 將返回 /bar/baz，因為 'baz' 不是絕對路徑，但 '/bar' + '/' + 'baz' 是。

如果在處理完所有給定的 path 片段後，仍未生成絕對路徑，則使用當前工作目錄。

結果路徑會被規範化，並且除非路徑解析為根目錄，否則尾部的斜槓會被移除。

零長度的 path 片段會被忽略。

如果沒有傳入 path 片段，path.resolve() 將返回當前工作目錄的絕對路徑。

path.resolve('/foo/bar', './baz');
// Returns: '/foo/bar/baz'

path.resolve('/foo/bar', '/tmp/file/');
// Returns: '/tmp/file'

path.resolve('wwwroot', 'static_files/png/', '../gif/image.gif');
// If the current working directory is /home/myself/node,
// this returns '/home/myself/node/wwwroot/static_files/gif/image.gif'

如果任何引數不是字串，則會丟擲 TypeError。

`path.sep`#

引入於：v0.7.9

型別：<string>

提供特定於平臺的路徑片段分隔符：

Windows 上是 \
POSIX 上是 /

例如，在 POSIX 上：

'foo/bar/baz'.split(path.sep);
// Returns: ['foo', 'bar', 'baz']

在 Windows 上

'foo\\bar\\baz'.split(path.sep);
// Returns: ['foo', 'bar', 'baz']

在 Windows 上，正斜槓 (/) 和反斜槓 (\) 都被接受為路徑片段分隔符；但是，path 方法只會新增反斜槓 (\)。

`path.toNamespacedPath(path)`#

添加於：v9.0.0

path <string>
返回: <string>

僅在 Windows 系統上，為給定的 path 返回一個等效的名稱空間字首路徑。如果 path 不是字串，則會不加修改地返回 path。

此方法僅在 Windows 系統上有意義。在 POSIX 系統上，此方法不起作用，並且總是返回未經修改的 path。

`path.win32`#

歷史

版本	變更
v15.3.0	作為 `require('path/win32')` 暴露。
v0.11.15	添加於：v0.11.15

型別：<Object>

path.win32 屬性提供了對 path 方法的 Windows 特定實現的訪問。

該 API 可透過 require('node:path').win32 或 require('node:path/win32') 訪問。

路徑#

Windows 與 POSIX#

path.basename(path[, suffix])#

path.delimiter#

path.dirname(path)#

path.extname(path)#

path.format(pathObject)#

path.matchesGlob(path, pattern)#

path.isAbsolute(path)#

path.join([...paths])#

path.normalize(path)#

path.parse(path)#

path.posix#

path.relative(from, to)#

path.resolve([...paths])#

path.sep#

path.toNamespacedPath(path)#

path.win32#

`path.basename(path[, suffix])`#

`path.delimiter`#

`path.dirname(path)`#

`path.extname(path)`#

`path.format(pathObject)`#

`path.matchesGlob(path, pattern)`#

`path.isAbsolute(path)`#

`path.join([...paths])`#

`path.normalize(path)`#

`path.parse(path)`#

`path.posix`#

`path.relative(from, to)`#

`path.resolve([...paths])`#

`path.sep`#

`path.toNamespacedPath(path)`#

`path.win32`#