関数の概要
fs.writeFileは、Node.jsのファイルシステムモジュールに含まれる関数で、指定されたファイルにデータを書き込むために使用されます。主な目的は、新しいファイルを作成したり既存のファイルの内容を上書きすることです。
パラメータの説明
| パラメータ | 型 | 用途 |
|---|---|---|
| file | string | 書き込むファイルのパス |
| data | string or buffer | 書き込むデータ |
| options | object | 書き込みオプション、例えばエンコーディングやフラグ |
戻り値
fs.writeFileは非同期関数であり、コールバック関数が呼び出されるため、明示的な返り値はありません。
使用例
ファイルにテキストを書き込む例：
const fs = require('fs');
fs.writeFile('example.txt', 'Hello, Node.js!', (err) => {
if (err) throw err;
console.log('File written successfully');
});
ファイルにJSONデータを書き込む例：
const fs = require('fs');
const data = { name: 'John', age: 30 };
fs.writeFile('data.json', JSON.stringify(data), (err) => {
if (err) throw err;
console.log('JSON data written successfully');
});
関連する関数
- fs.readFileSync: ファイルを同期的に読み込む
- fs.appendFile: ファイルにデータを追記する
まとめ
fs.writeFileはファイルにデータを書き込むための便利な関数ですが、非同期処理であるためコールバック関数を適切に扱う必要があります。また、ファイルの上書きに注意して使用することが重要です。
