関数の概要
fs.openは、Node.jsのファイルシステムモジュールで提供される関数の一つです。この関数は、指定されたファイルを開いてファイルディスクリプタを取得するために使用されます。ファイルを開く際には、読み込み、書き込み、または両方の目的でファイルをオープンすることができます。
パラメータの説明
パラメータ | 型 | 用途 |
---|---|---|
path | string | オープンするファイルのパス |
flags | string | ファイルを開く際の動作を指定するフラグ(読み込み、書き込みなど) |
mode | integer | ファイルのパーミッションを指定する数値 |
戻り値
fs.openは非同期関数であり、コールバック関数を使用してファイルディスクリプタを返します。返り値は、エラーが発生した場合にはエラーオブジェクトを返します。
使用例
ファイルを読み込みモードで開く例:
const fs = require('fs');
fs.open('example.txt', 'r', (err, fd) => {
if (err) throw err;
console.log('File opened successfully!');
});
ファイルを書き込みモードで開く例:
const fs = require('fs');
fs.open('output.txt', 'w', (err, fd) => {
if (err) throw err;
console.log('File opened successfully!');
});
関連する関数
- fs.readFile: ファイルを非同期的に読み込む関数
- fs.writeFile: ファイルを非同期的に書き込む関数
まとめ
fs.openはファイルを開いてファイルディスクリプタを取得するための関数であり、読み込みや書き込みの目的でファイルをオープンすることができます。非同期関数であるため、コールバック関数を使用して処理を行う必要があります。