関数の概要
fs.promises.mkdirは、Node.jsのfsモジュールに含まれる関数の一つです。この関数は、指定されたディレクトリを非同期で作成するために使用されます。新しいディレクトリを作成する際に便利であり、ファイルシステムを操作する際に頻繁に利用されます。
パラメータの説明
パラメータ | 型 | 用途 |
---|---|---|
path | String | 作成するディレクトリのパスを指定する |
options | Object | ディレクトリを作成する際のオプションを指定する |
戻り値
fs.promises.mkdirはPromiseを返します。作成されたディレクトリのパスが解決されたり、エラーが発生した場合には拒否されたりします。非同期で処理されるため、コールバック関数を使用せずに処理を行うことができます。
使用例
以下に、fs.promises.mkdirの使用例を示します。
const fs = require('fs').promises;
// ディレクトリを作成する例
fs.mkdir('newFolder')
.then(() => console.log('ディレクトリが作成されました'))
.catch(err => console.error(err));
関連する関数
fs.promises.mkdirとよく一緒に使われる関数や似た役割を持つ関数には、fs.promises.readdirやfs.promises.rmdirがあります。これらもファイルシステムを操作する際に便利な関数です。
まとめ
fs.promises.mkdirは、非同期でディレクトリを作成するための便利な関数です。パスとオプションを指定することで、簡単に新しいディレクトリを作成することができます。エラーハンドリングにも注意して利用しましょう。