Path

[Stable: 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 の最後の部分を返します。末尾のディレクトリ区切り文字は無視されます。

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`

Added in: 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)`

[History]

Version	Changes
v6.0.0	`path` 引数として文字列以外を渡すと、例外がスローされるようになりました。
v0.1.16	Added in: 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)`

[History]

Version	Changes
v6.0.0	`path` 引数として文字列以外を渡すと、例外がスローされるようになりました。
v0.1.25	Added in: 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)`

[History]

Version	Changes
v19.0.0	`ext` でドットが指定されていない場合、ドットが追加されます。
v0.11.15	Added in: 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

[Stable: 1 - 実験的]

Stable: 1 Stability: 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)`

Added in: v0.1.23

path <string>
戻り値: <string>

path.normalize() メソッドは、与えられた path を正規化し、'..' と '.' セグメントを解決します。

複数の連続したパスセグメント区切り文字が見つかった場合 (例えば、POSIX では / で、Windows では \ または /)、それらはプラットフォーム固有のパスセグメント区切り文字の単一のインスタンスに置き換えられます (POSIX では /、Windows では \ )。末尾の区切り文字は保持されます。

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

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

Added in: 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' }

text

┌─────────────────────┬────────────┐
│          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' }

text

┌─────────────────────┬────────────┐
│          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 の文字列が返されます。

長さ 0 の文字列が from または to として渡された場合、長さ 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`

Added in: 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)`

Added in: v9.0.0

path <string>
Returns: <string>

Windows システムのみで、指定された path に相当する名前空間プレフィックス付きパスを返します。path が文字列でない場合、path は変更されずに返されます。

このメソッドは、Windows システムでのみ意味があります。POSIX システムでは、このメソッドは動作せず、常に path を変更せずに返します。

`path.win32`

[History]

Version	Changes
v15.3.0	`require('path/win32')` として公開されました。
v0.11.15	Added in: 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

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`