Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【Node.js24.x】Object::basename()メソッドの使い方

basenameメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

basenameメソッドは、指定されたパス文字列の最後の部分、つまりファイル名やディレクトリ名を抽出して返すメソッドです。このメソッドは、ファイルパスから純粋なファイル名を簡単に取得したい場合や、パスの末尾にある特定のディレクトリ名を抽出したい場合に利用されます。

例えば、「/home/user/document/report.txt」のようなパスが与えられた場合、basenameメソッドは「report.txt」というファイル名部分の文字列を返します。また、「/usr/local/bin/」のようなディレクトリパスが与えられた場合は、「bin」というディレクトリ名を返します。

さらに、このメソッドにはオプションとして、ファイル名から特定の拡張子を除外する機能も備わっています。先ほどの「report.txt」から「.txt」という拡張子を除外して「report」という純粋なファイル名を取得したい場合は、basenameメソッドの第二引数に除外したい拡張子「.txt」を指定することで実現できます。この機能は、ファイル名を拡張子と分けて処理したい場合に非常に便利です。

basenameメソッドはNode.jsのpathモジュールに属しており、ファイルシステムパスを扱う多くの場面で活用されます。Windows環境とPOSIX(LinuxやmacOSなど)環境の両方のパス区切り文字(\/)に対応しているため、異なるオペレーティングシステム間で互換性のあるパス操作を行う際に非常に有用です。このメソッドは、パスの正規化などは行わず、純粋に文字列操作として末尾の要素を抽出することに特化しています。

構文(syntax)

1const path = require('path');
2const filename = path.basename('/home/user/documents/report.txt');

引数(parameters)

path, suffix

  • path: string: ファイルパスまたはディレクトリパスを指定する文字列
  • suffix: string = '': 削除する末尾の文字列を指定する文字列。省略可能で、指定しない場合は末尾の文字列は削除されません。

戻り値(return)

string

path.basename() メソッドは、指定されたパス文字列の最後の部分、つまりファイル名またはディレクトリ名を文字列として返します。

関連コンテンツ