パス

[安定版: 2 - 安定版]

ソースコード: lib/path.js

node:path モジュールは、ファイルとディレクトリのパスを操作するためのユーティリティを提供します。以下の方法でアクセスできます。

CJSESM

const path = require('node:path')

import path from 'node:path'

Windows 対 POSIX

node:path モジュールのデフォルト動作は、Node.js アプリケーションが実行されているオペレーティングシステムによって異なります。具体的には、Windows オペレーティングシステムで実行されている場合、node:path モジュールは Windows スタイルのパスが使用されていると想定します。

そのため、path.basename() を使用すると、POSIX と Windows で異なる結果が得られる場合があります。

POSIX の場合:

path.basename('C:\\temp\\myfile.html')
// 戻り値: 'C:\\temp\\myfile.html'

Windows の場合:

path.basename('C:\\temp\\myfile.html')
// 戻り値: 'myfile.html'

任意のオペレーティングシステムで Windows ファイルパスを操作する場合に一貫した結果を得るには、path.win32 を使用します。

POSIX と Windows の場合:

path.win32.basename('C:\\temp\\myfile.html')
// 戻り値: 'myfile.html'

任意のオペレーティングシステムで POSIX ファイルパスを操作する場合に一貫した結果を得るには、path.posix を使用します。

POSIX と Windows の場合:

path.posix.basename('/tmp/myfile.html')
// 戻り値: '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() メソッドは、Unix の basename コマンドと同様に、パスの最後の部分を返します。末尾のディレクトリセパレータは無視されます。

path.basename('/foo/bar/baz/asdf/quux.html')
// 戻り値: 'quux.html'

path.basename('/foo/bar/baz/asdf/quux.html', '.html')
// 戻り値: 'quux'

Windows は通常、ファイル名（ファイル拡張子を含む）を大文字小文字を区別せずに扱いますが、この関数は区別します。たとえば、C:\\foo.html と C:\\foo.HTML は同じファイルを指しますが、basename は拡張子を大文字小文字を区別する文字列として扱います。

path.win32.basename('C:\\foo.html', '.html')
// 戻り値: 'foo'

path.win32.basename('C:\\foo.HTML', '.html')
// 戻り値: 'foo.HTML'

path が文字列でない場合、または suffix が指定されていて文字列でない場合、TypeError がスローされます。

`path.delimiter`

追加バージョン: v0.9.3

<string>

プラットフォーム固有のパス区切り文字を提供します。

Windows の場合: ;
POSIX の場合: :

例えば、POSIX では:

console.log(process.env.PATH)
// 出力: '/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin'

process.env.PATH.split(path.delimiter)
// 返り値: ['/usr/bin', '/bin', '/usr/sbin', '/sbin', '/usr/local/bin']

Windows では:

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

process.env.PATH.split(path.delimiter)
// 返り値: ['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()メソッドは、Unix のdirnameコマンドと同様に、pathのディレクトリ名を返します。末尾のディレクトリセパレータは無視されます。path.sepを参照してください。

path.dirname('/foo/bar/baz/asdf/quux')
// 返り値: '/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の basename の先頭文字以外の.文字がない場合（path.basename()を参照）、空文字列が返されます。

path.extname('index.html')
// 返り値: '.html'

path.extname('index.coffee.md')
// 返り値: '.md'

path.extname('index.')
// 返り値: '.'

path.extname('index')
// 返り値: ''

path.extname('.index')
// 返り値: ''

path.extname('.index.md')
// 返り値: '.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 では:

// `dir`, `root`, `base`が提供されている場合、
// `${dir}${path.sep}${base}`
// が返されます。`root`は無視されます。
path.format({
  root: '/ignored',
  dir: '/home/user/dir',
  base: 'file.txt',
})
// 戻り値: '/home/user/dir/file.txt'

// `dir`が指定されていない場合、`root`が使用されます。
// `root`のみが提供されている場合、または`dir`が`root`と等しい場合、
// プラットフォームセパレータは含まれません。`ext`は無視されます。
path.format({
  root: '/',
  base: 'file.txt',
  ext: 'ignored',
})
// 戻り値: '/file.txt'

// `base`が指定されていない場合、`name` + `ext`が使用されます。
path.format({
  root: '/',
  name: 'file',
  ext: '.txt',
})
// 戻り値: '/file.txt'

// `ext`に指定されていない場合、ドットが追加されます。
path.format({
  root: '/',
  name: 'file',
  ext: 'txt',
})
// 戻り値: '/file.txt'

Windows では:

path.format({
  dir: 'C:\\path\\dir',
  base: 'file.txt',
})
// 戻り値: 'C:\\path\\dir\\file.txt'

`path.matchesGlob(path, pattern)`

追加: v22.5.0, v20.17.0

[安定版: 1 - 試験版]

安定版: 1 安定性: 1 - 試験版

path <string> グローバルマッチングを行うパス。
pattern <string> パスをチェックするグローバルパターン。
戻り値: <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('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', '..')
// 戻り値: '/foo/bar/baz/asdf'

path.join('foo', {}, 'bar')
// '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 仕様に厳密に準拠していません。たとえば、この関数は、先頭の 2 つのスラッシュを通常の絶対パスのように単一のスラッシュに置き換えますが、いくつかの POSIX システムでは、先頭に正確に 2 つのスラッシュで始まるパスに特別な意味を割り当てています。同様に、この関数によって実行される他の置換（「..」セグメントの削除など）は、基盤となるシステムがパスを解決する方法を変更する可能性があります。

たとえば、POSIX では:

path.normalize('/foo/bar//baz/asdf/quux/..')
// 戻り値: '/foo/bar/baz/asdf'

Windows では:

path.normalize('C:\\temp\\\\foo\\bar\\..\\')
// 戻り値: 'C:\\temp\\foo\\'

Windows は複数のパス区切り文字を認識するため、両方の区切り文字は Windows で優先される区切り文字（「\」）のインスタンスに置き換えられます。

path.win32.normalize('C:////temp\\\\/\\/\\/foo/bar')
// 戻り値: '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')
// 戻り値:
// { root: '/',
//   dir: '/home/user/dir',
//   base: 'file.txt',
//   ext: '.txt',
//   name: 'file' }

text

┌─────────────────────┬────────────┐
│          dir        │    base    │
├──────┬              ├──────┬─────┤
│ root │              │ name │ ext │
"  /    home/user/dir / file  .txt "
└──────┴──────────────┴──────┴─────┘
( ""内のスペースはすべて無視してください。これは単なる書式設定のためです。)

Windows では:

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

text

┌─────────────────────┬────────────┐
│          dir        │    base    │
├──────┬              ├──────┬─────┤
│ root │              │ name │ ext │
" C:\      path\dir   \ file  .txt "
└──────┴──────────────┴──────┴─────┘
( ""内のスペースはすべて無視してください。これは単なる書式設定のためです。)

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()を呼び出した後）、長さ 0 の文字列が返されます。

fromまたはtoとして長さ 0 の文字列が渡された場合、長さ 0 の文字列の代わりに現在の作業ディレクトリが使用されます。

例えば、POSIX では：

path.relative('/data/orandea/test/aaa', '/data/orandea/impl/bbb')
// '../../impl/bbb' を返します

Windows では：

path.relative('C:\\orandea\\test\\aaa', 'C:\\orandea\\impl\\bbb')
// '..\\..\\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セグメントを処理した後でも絶対パスが生成されていない場合、現在の作業ディレクトリが使用されます。

結果のパスは正規化され、パスがルートディレクトリに解決されない限り、末尾のスラッシュは削除されます。

長さ 0 のpathセグメントは無視されます。

pathセグメントが渡されない場合、path.resolve()は現在の作業ディレクトリの絶対パスを返します。

path.resolve('/foo/bar', './baz')
// '/foo/bar/baz' を返します

path.resolve('/foo/bar', '/tmp/file/')
// '/tmp/file' を返します

path.resolve('wwwroot', 'static_files/png/', '../gif/image.gif')
// 現在の作業ディレクトリが /home/myself/node の場合、
// '/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)
// 戻り値: ['foo', 'bar', 'baz']

Windows では:

'foo\\bar\\baz'.split(path.sep)
// 戻り値: ['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 ​

パス

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`