路徑 | Node.js v21.7.2 文件 - Node.js 繁體中文

路徑#

原始碼： lib/path.js

node:path 模組提供用於處理檔案和目錄路徑的公用程式。可以使用下列方式存取：

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

Windows 與 POSIX#

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

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

在 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 <字串>
suffix <字串> 要移除的選用字尾
傳回：<字串>

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

<字串>

提供特定於平台的路徑分隔符號

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 <字串>
傳回：<字串>

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 <字串>
傳回：<字串>

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>
傳回：<字串>

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.isAbsolute(path)`#

新增於：v0.11.2

path <字串>
傳回：<boolean>

path.isAbsolute() 方法判斷 path 是否為絕對路徑。

如果給定的 path 為零長度字串，則會傳回 false。

例如，在 POSIX 中

path.isAbsolute('/foo/bar'); // 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> 路徑區段序列
傳回：<字串>

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 <字串>
傳回：<字串>

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

當找到多個連續的路徑區段分隔字元（例如 POSIX 上的 /，或 Windows 上的 \ 或 /）時，它們會被替換為特定於平台的路徑區段分隔字元（POSIX 上的 / 和 Windows 上的 \）的單一實例。保留尾隨分隔字元。

如果路徑是零長度字串，則傳回'.'，代表目前的作業目錄。

在 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 <字串>
傳回：<物件>

path.parse() 方法傳回一個物件，其屬性代表路徑的重要元素。尾隨的目錄分隔符號會被忽略，請參閱 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

<物件>

path.posix 屬性提供對 path 方法的 POSIX 特定實作的存取。

可透過 require('node:path').posix 或 require('node:path/posix') 存取 API。

`path.relative(from, to)`#

歷程記錄

版本	變更
v6.8.0	在 Windows 上，UNC 路徑的開頭斜線現在包含在傳回值中。
v0.5.0	新增於：v0.5.0

from <字串>
to <字串>
傳回：<字串>

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 <字串> 路徑或路徑區段的序列
傳回：<字串>

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

<字串>

提供特定於平台的路徑區段分隔符號

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 <字串>
傳回：<字串>

僅在 Windows 系統上，傳回給定 path 的等效命名空間前綴路徑。如果 path 不是字串，則會傳回未修改的 path。

此方法僅在 Windows 系統上才有意義。在 POSIX 系統上，此方法無法運作，且總是傳回未修改的 path。

`path.win32`#

歷程記錄

版本	變更
v15.3.0	以 `require('path/win32')` 公開。
v0.11.15	新增於：v0.11.15

<物件>

path.win32 屬性提供對 path 方法的 Windows 特定實作的存取權。

可透過 require('node:path').win32 或 require('node:path/win32') 存取 API。

路徑#

Windows 與 POSIX#

path.basename(path[, suffix])#

path.delimiter#

path.dirname(path)#

path.extname(path)#

path.format(pathObject)#

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.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`#