path.dirname

関数の概要

path.dirnameは、与えられたファイルパスからディレクトリ部分を取得するNode.jsの関数です。ファイルパスからファイル名を除いたディレクトリのパスを取得することができます。主にファイルの親ディレクトリを特定したい時に使用されます。

パラメータの説明

戻り値

返り値はString型で、指定されたファイルパスのディレクトリ部分を表します。同期的に処理されるため、関数呼び出し後に即座に結果が返されます。

使用例

以下はpath.dirnameの使用例です。

const path = require('path');

const filePath = '/home/user/documents/file.txt';
const directory = path.dirname(filePath);
console.log(directory); // Output: /home/user/documents

別の例として、Windows環境での使用例を示します。

const path = require('path');

const filePath = 'C:\\Users\\Documents\\file.txt';
const directory = path.dirname(filePath);
console.log(directory); // Output: C:\Users\Documents

関連する関数

path.basename: ファイルパスからファイル名の部分を取得する関数

path.resolve: 複数のパスを連結して絶対パスを生成する関数

まとめ

path.dirnameは与えられたファイルパスからディレクトリ部分を取得する便利な関数です。ファイルパスを扱う際に、ファイルの親ディレクトリを取得したい場合に活用できます。正しいファイルパスの指定に注意し、ディレクトリのパスを確実に取得しましょう。