関数の概要
fs.writeはNode.jsのファイルシステムモジュール（fs）に含まれる関数で、ファイルにデータを書き込むために使用されます。主な目的は、指定されたファイルに指定されたデータを非同期的に書き込むことです。
パラメータの説明
| 引数 | 型 | 用途 |
|---|---|---|
| fd | 整数 | ファイルディスクリプタ（ファイルを示す数値） |
| buffer | BufferまたはUint8Array | 書き込むデータを含むBufferオブジェクト |
| offset | 整数 | buffer内の書き込む開始位置 |
| length | 整数 | 書き込むバイト数 |
| position | 整数 | ファイル内の書き込み位置 |
戻り値
fs.writeの戻り値は整数型で、実際に書き込まれたバイト数を示します。非同期的に動作します。
使用例
以下はfs.writeの使用例です。
const fs = require('fs');
const data = 'Hello, World!';
const buffer = Buffer.from(data);
fs.open('example.txt', 'w', (err, fd) => {
if (err) throw err;
fs.write(fd, buffer, 0, buffer.length, null, (err, written, buffer) => {
if (err) throw err;
console.log(`${written} bytes written`);
});
});
関連する関数
- fs.open: ファイルを開くために使われる関数
- fs.writeFile: ファイルを非同期的に書き込む関数
まとめ
fs.writeはファイルにデータを書き込むための関数であり、非同期的に動作します。適切なパラメータを指定することで、効率的にファイルへの書き込みが行えます。
