fs.rm

関数の概要

fs.rmは、Node.jsのファイルシステムモジュールで提供される関数の一つです。この関数は、指定したファイルやディレクトリを削除するために使用されます。ファイルやディレクトリの削除が必要な場合に利用されます。

パラメータの説明

引数 用途
path string 削除するファイルやディレクトリのパスを指定
options object 削除のオプションを指定(再帰的削除など)

戻り値

fs.rmは非同期関数で、戻り値はありません。削除処理が完了した後にコールバック関数が呼ばれます。

使用例

以下は、fs.rmの使用例です。


const fs = require('fs');

// ファイルを削除する例
fs.rm('example.txt', (err) => {
  if (err) throw err;
  console.log('ファイルが削除されました。');
});

// ディレクトリを再帰的に削除する例
fs.rm('example-dir', { recursive: true }, (err) => {
  if (err) throw err;
  console.log('ディレクトリが再帰的に削除されました。');
});

関連する関数

  • fs.unlink: ファイルを削除する際に使用
  • fs.rmdir: ディレクトリを削除する際に使用

まとめ

fs.rmは、ファイルやディレクトリを削除するための便利な関数です。削除する際には、誤って重要なファイルを削除しないように注意が必要です。