fs.rmdir

関数の概要

fs.rmdirは、Node.jsのファイルシステムモジュールに含まれる関数の一つです。この関数は、指定されたディレクトリを削除するために使用されます。ディレクトリが空でない場合は削除できません。

パラメータの説明

引数 用途
path String 削除するディレクトリのパスを指定
options Object 追加のオプションを指定(例: { recursive: true })

戻り値

fs.rmdirはコールバック関数を受け取り、エラーが発生しなかった場合にはnullを返します。非同期的に動作します。

使用例

const fs = require('fs');

fs.rmdir('./test', { recursive: true }, (err) => {
  if (err) throw err;
  console.log('Directory deleted!');
});

関連する関数

  • fs.unlink: ファイルを削除する
  • fs.readdir: ディレクトリ内のファイル一覧を取得する

まとめ

fs.rmdirは指定されたディレクトリを削除するための関数ですが、ディレクトリが空でない場合には削除できません。削除する前に中身を確認することが重要です。