関数の概要
fs.unlinkとは、Node.jsのファイルシステムモジュール(fs)に含まれる関数で、指定したファイルを削除するために使用されます。不要なファイルを削除したり、一時ファイルを作成した後に削除する際などに役立ちます。
パラメータの説明
引数 | 型 | 用途 |
---|---|---|
path | string | 削除するファイルのパス |
callback | function | 削除が完了した後に実行するコールバック関数 |
戻り値
fs.unlinkは何も返しません。非同期的にファイルを削除し、削除が完了した際にコールバック関数を呼び出します。
使用例
ファイルの削除:
const fs = require('fs');
fs.unlink('example.txt', (err) => {
if (err) throw err;
console.log('ファイルが削除されました');
});
一時ファイルの削除:
const fs = require('fs');
// 一時ファイルの作成
fs.writeFile('temp.txt', 'Temporary content', (err) => {
if (err) throw err;
console.log('一時ファイルが作成されました');
// 一時ファイルの削除
fs.unlink('temp.txt', (err) => {
if (err) throw err;
console.log('一時ファイルが削除されました');
});
});
関連する関数
- fs.unlinkSync: 同期的にファイルを削除する関数
- fs.unlink: ファイルを非同期的に削除する関数(この記事で説明)
- fs.rm: Node.js 14以降で導入された、ファイルやディレクトリを削除する関数
まとめ
fs.unlinkは指定したファイルを非同期的に削除する際に使用されます。削除したいファイルのパスを指定し、削除が完了した後の処理をコールバック関数で指定します。削除する際には、誤って重要なファイルを削除しないように注意が必要です。