関数の概要
fs.mkdtempは、Node.jsのファイルシステムモジュール(fs)に含まれる関数の一つです。この関数は一時的なディレクトリ(ディレクトリ名がランダムな文字列で生成される)を作成するために使用されます。一時的なディレクトリは、一時ファイルを保存したり一時的な作業ディレクトリとして利用する際に便利です。
パラメータの説明
引数 | 型 | 用途 |
---|---|---|
prefix | string | 一時ディレクトリ名の接頭辞 |
options | Object | オプション設定(例: encoding, mode) |
戻り値
fs.mkdtempは、生成された一時ディレクトリのパスを返します。この関数は非同期的に動作し、コールバック関数を使用して結果を取得します。
使用例
以下にfs.mkdtempの使用例を示します。
const fs = require('fs');
fs.mkdtemp('temp-', (err, folder) => {
if (err) throw err;
console.log('Created temporary directory:', folder);
});
関連する関数
fs.mkdtempとよく一緒に使われる関数として、fs.mkdtempSync(同期的なバージョン)やfs.mkdir(ディレクトリを作成する関数)があります。
まとめ
fs.mkdtempは、一時的なディレクトリを作成する際に利用されるNode.jsの関数です。適切なprefixを指定することで、安全に一時ディレクトリを生成することができます。非同期的に動作するため、コールバック関数を使用して結果を取得する必要があります。