【Node.js24.x】Object::mkdtempSync()メソッドの使い方
mkdtempSyncメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
mkdtempSyncメソッドは、ファイルシステム上に安全な一時ディレクトリを同期的に作成するメソッドです。このメソッドは、引数として指定されたテンプレート文字列を新しいディレクトリ名のプレフィックスとして使用し、システムが自動的にユニークなサフィックスを付与することで、名前の衝突を避けた一時ディレクトリを作成します。
同期的に動作するため、ディレクトリの作成処理が完了するまでNode.jsのイベントループがブロックされ、その間、他のJavaScriptコードの実行が一時的に停止します。そのため、I/O処理が多いアプリケーションのメインスレッドで頻繁に使用すると、アプリケーション全体の応答性に影響を与える可能性があります。
mkdtempSyncメソッドは、ディレクトリの作成に成功すると、新しく作成された一時ディレクトリの絶対パスを文字列として返します。もし、何らかの原因でディレクトリの作成に失敗した場合は、エラーをスローして処理を中断します。 このメソッドは、主にテスト環境で一時的なファイルを保存する必要がある場合や、アプリケーションの実行中に一時的な作業スペースが必要な場面で利用されます。作成された一時ディレクトリは、プログラムが終了しても自動的には削除されないため、不要になったタイミングで明示的に削除する管理が必要です。
構文(syntax)
1const fs = require('node:fs'); 2const tempDir = fs.mkdtempSync('my-app-');
引数(parameters)
prefix, options
- prefix: string: 作成される一時ディレクトリ名の先頭に付与される文字列
- options: object: オプションを指定するオブジェクト。以下のプロパティを指定できます:
- encoding: string: ディレクトリ名に使用するエンコーディング（デフォルトは 'utf8'）
戻り値(return)
string
同期的に一時ディレクトリを作成し、そのディレクトリのパスを文字列で返します。