Node.jsでfs.mkdirSyncを使ってフルパスを作成する方法

2024-04-10

Node.jsのfs.mkdirSyncを使ってフルパスを作成する方法

この関数を使ってフルパスを作成するには、以下の手順が必要です。

fsモジュールの読み込み

const fs = require('fs');

フルパスの生成

次に、作成したいディレクトリのフルパスを生成します。フルパスとは、ファイルシステム上のファイルやディレクトリの絶対的な位置を表すパスです。

例えば、/home/user/project/dataというディレクトリを作成したい場合は、以下のコードのように生成できます。

const fullPath = '/home/user/project/data';

fs.mkdirSyncの呼び出し

最後に、fs.mkdirSync関数を呼び出して、ディレクトリを作成します。

fs.mkdirSync(fullPath);

このコードを実行すると、/home/user/project/dataというディレクトリが作成されます。

ポイント

fs.mkdirSync関数は、ディレクトリが存在しない場合のみ作成します。すでに存在する場合は、エラーが発生します。
フルパスを生成する際は、各ディレクトリ名の間をスラッシュ(/)で区切ります。
fs.mkdirSync関数は同期処理なので、処理が完了するまで他の処理がブロックされます。

例

以下のコードは、fs.mkdirSync関数を使い、フルパスにディレクトリを作成する例です。

const fs = require('fs');

const fullPath = '/home/user/project/data/subdir1/subdir2';

try {
  fs.mkdirSync(fullPath, { recursive: true });
  console.log('ディレクトリを作成しました');
} catch (err) {
  console.error(err.message);
}

このコードを実行すると、以下のようになります。

ディレクトリを作成しました

recursiveオプションをtrueに設定することで、中間ディレクトリが存在しない場合でも自動的に作成されます。

fs.mkdirSync関数は、Node.jsで簡単にディレクトリを作成できる便利な関数です。フルパスを生成する際の注意点や、オプション設定などを理解することで、より効率的にディレクトリを作成することができます。

const fs = require('fs');

// 作成したいディレクトリのフルパス
const fullPath = '/home/user/project/data/subdir1/subdir2';

// オプション設定
const options = {
  recursive: true, // 中間ディレクトリが存在しない場合でも自動的に作成する
  mode: 0o775 // ディレクトリのアクセス権限
};

try {
  // ディレクトリを作成
  fs.mkdirSync(fullPath, options);
  console.log('ディレクトリを作成しました');
} catch (err) {
  // エラー処理
  console.error(err.message);
}

ディレクトリを作成しました

modeオプションで、ディレクトリのアクセス権限を設定できます。

fs.mkdir関数: 非同期処理でディレクトリを作成する関数です。
fs.promises.mkdir関数: Promiseを使ってディレクトリを作成する関数です。

このサンプルコードはあくまでも参考情報であり、いかなる保証もありません。ご自身の責任でご利用ください。

Node.jsでフルパスを作成する他の方法

pathモジュールを使う

Node.jsのpathモジュールには、パスを操作するためのさまざまな機能が用意されています。

const path = require('path');

const fullPath = path.join('/home/user', 'project', 'data');

console.log(fullPath); // /home/user/project/data

path.join関数は、複数のパスを結合してフルパスを作成します。

手動で結合する

pathモジュールを使わずに、手動でパスを結合することもできます。

const fullPath = '/home/user/' + 'project/' + 'data';

console.log(fullPath); // /home/user/project/data

ただし、この方法は誤入力が発生しやすいので、注意が必要です。

第三者ライブラリを使う

fs-extraなどの第三者ライブラリを使って、フルパスを作成することもできます。

const fsExtra = require('fs-extra');

const fullPath = '/home/user/project/data';

fsExtra.ensureDirSync(fullPath);

console.log(fullPath); // /home/user/project/data

fs-extraライブラリのensureDirSync関数は、ディレクトリが存在しない場合は作成し、存在する場合は何もしません。

Node.jsでフルパスを作成するには、さまざまな方法があります。それぞれの方法にはメリットとデメリットがあるので、状況に応じて最適な方法を選択する必要があります。

node.js fs