パス | Node.js v21.7.2 ドキュメント

パス#

ソースコード： 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() メソッドは、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

<文字列>

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

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() メソッドは、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 <文字列>
戻り値: <文字列>

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 <オブジェクト> 次のプロパティを持つ任意の JavaScript オブジェクト
- dir <文字列>
- root <文字列>
- base <文字列>
- name <文字列>
- ext <文字列>
戻り値: <文字列>

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 <文字列>
戻り値: <ブール値>

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 <文字列> パスセグメントのシーケンス
戻り値: <文字列>

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 では\）の単一インスタンスに置き換えられます。末尾のセパレータは保持されます。

pathがゼロ長の文字列の場合、現在の作業ディレクトリを表す'.'が返されます。

POSIX では、この関数によって適用される正規化の種類は、POSIX 仕様に厳密に従っていません。たとえば、この関数は、2 つの先頭のフォワードスラッシュを通常の絶対パスのように単一のスラッシュに置き換えますが、いくつかの 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 <文字列>
戻り値: <オブジェクト>

path.parse() メソッドは、path の重要な要素を表すプロパティを持つオブジェクトを返します。末尾のディレクトリセパレータは無視されます。path.sep を参照してください。

返されるオブジェクトには、次のプロパティがあります。

dir <文字列>
root <文字列>
base <文字列>
name <文字列>
ext <文字列>

たとえば、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固有の実装へのアクセスを提供します。

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 <文字列>
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 <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

<文字列>

プラットフォーム固有のパスセグメントセパレータを提供します。

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固有の実装へのアクセスを提供します。

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