Path | Node.js v25.0.0 ドキュメント

Path (パス)#

ソースコード: 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 スタイルのパスが使用されていると想定します。

したがって、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 <string>
suffix <string> 削除するオプションの接尾辞
戻り値: <string>

path.basename() メソッドは、Unix の basename コマンドと同様に、path の最後の部分を返します。末尾のディレクトリ区切り文字は無視されます。

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() メソッドは、Unix の dirname コマンドと同様に、path のディレクトリ名を返します。末尾のディレクトリ区切り文字は無視されます。詳細は 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.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 が長さ 0 の文字列の場合、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 セグメントをプラットフォーム固有の区切り文字をデリミタとして結合し、その結果のパスを正規化します。

長さ 0 の path セグメントは無視されます。結合されたパス文字列が長さ 0 の文字列になる場合は、カレントワーキングディレクトリを表す '.' が返されます。

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 が長さ 0 の文字列の場合、カレントワーキングディレクトリを表す '.' が返されます。

POSIX では、この関数によって適用される正規化の種類は、POSIX 仕様に厳密には準拠していません。例えば、この関数は先頭の 2 つのスラッシュを、通常の絶対パスであるかのように 1 つのスラッシュに置き換えますが、一部の POSIX システムではちょうど 2 つのスラッシュで始まるパスに特別な意味を割り当てています。同様に、.. セグメントの削除など、この関数によって実行される他の置換は、基礎となるシステムがパスを解決する方法を変更する可能性があります。

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

from または to として長さ 0 の文字列が渡された場合、その文字列の代わりにカレントワーキングディレクトリが使用されます。

例えば、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 セグメントを処理した後、まだ絶対パスが生成されていない場合は、カレントワーキングディレクトリが使用されます。

結果のパスは正規化され、パスがルートディレクトリに解決される場合を除き、末尾のスラッシュは削除されます。

長さ 0 の 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') を介してアクセスできます。

Path (パス)#

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