関数の概要
fs.mkdirは、Node.jsで提供されているファイルシステムモジュールの一つで、ディレクトリ(フォルダ)を作成するための関数です。新しいディレクトリを作成する際に使用され、指定したパスに新しいディレクトリを作成します。
パラメータの説明
引数 | 型 | 用途 |
---|---|---|
path | string | 作成するディレクトリのパス |
options | Object | オプションパラメータ(再帰的なディレクトリの作成など) |
戻り値
fs.mkdirはコールバック関数を使用し、戻り値はありません。非同期的にディレクトリが作成された後にコールバック関数が実行されます。
使用例
新しいディレクトリを作成する例:
const fs = require('fs');
fs.mkdir('newFolder', (err) => {
if (err) throw err;
console.log('New folder created');
});
再帰的なディレクトリの作成例:
const fs = require('fs');
fs.mkdir('parentFolder/childFolder', { recursive: true }, (err) => {
if (err) throw err;
console.log('Nested folders created');
});
関連する関数
- fs.readdir: ディレクトリ内のファイルやディレクトリの一覧を取得する関数
- fs.rmdir: ディレクトリを削除する関数
まとめ
fs.mkdirはNode.jsでディレクトリを作成するための重要な関数です。パスを指定して新しいディレクトリを作成することができますが、既存のディレクトリが存在する場合はエラーが発生します。オプションを指定することで再帰的なディレクトリの作成も可能です。