fs.promises.readFile

関数の概要

fs.promises.readFileは、Node.jsのファイルシステムモジュールで提供される関数の1つです。この関数は、非同期でファイルを読み込み、その内容を文字列やバッファとして取得するために使用されます。ファイルの読み込みが完了するまで待たず、他の処理を続行できるのが特徴です。

パラメータの説明

引数 型 用途
path String 読み込むファイルのパスを指定
options Object オプション設定（エンコーディングなど）

戻り値

Promiseオブジェクトを返すため、非同期処理を行います。処理が完了すると、ファイルの内容やエラー情報が解決されたPromiseが返されます。

使用例

例1：


const fs = require('fs').promises;

fs.readFile('sample.txt', 'utf-8')
  .then((data) => {
    console.log(data);
  })
  .catch((err) => {
    console.error(err);
  });

例2：


const fs = require('fs').promises;

(async () => {
  try {
    const data = await fs.readFile('sample.txt', 'utf-8');
    console.log(data);
  } catch (err) {
    console.error(err);
  }
})();

関連する関数

関連する関数はfs.promises.writeFileやfs.promises.readdirなど、ファイルの書き込みやディレクトリ内のファイル取得などを行う関数です。

まとめ

fs.promises.readFileは非同期でファイルを読み込むための便利な関数です。コールバック関数やPromiseを使って、ファイルの読み込みが完了した後の処理を記述することが重要です。

スポンサーリンク