【Node.js24.x】Object::openSync()メソッドの使い方
openSyncメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
openSyncメソッドは、Node.jsにおいてファイルを同期的に開くためのメソッドです。このメソッドは、指定されたパスのファイルを特定の方法で開き、そのファイルにアクセスするために使用するファイルディスクリプタと呼ばれる整数値を返します。ファイルを開く処理は同期的に行われるため、この処理が完了するまで、プログラムの実行は一時停止し、他のコードの実行はブロックされます。
このメソッドは主に二つの引数を取ります。一つ目は開きたいファイルのパスを示す文字列で、二つ目はファイルをどのように開くかを指定するフラグです。フラグには、読み込み専用（'r'）、書き込み専用でファイルが存在しない場合は新規作成（'w'）、追記（'a'）など、ファイルの操作モードを指定します。オプションで、新規ファイル作成時のパーミッション（アクセス権限）も指定できます。
openSyncメソッドは、例えばアプリケーションの起動時に設定ファイルを読み込む際や、ユーティリティスクリプトで一時的なファイル操作を行う場合など、処理が完了するまで次のステップに進みたくないシンプルな場面で有効です。しかし、ファイル操作は入出力（I/O）処理であり、システムのパフォーマンスに影響を与える可能性があります。特に、Webサーバーのような高い応答性が求められるアプリケーションや、大量のファイルを処理する場合には、メインスレッドをブロックすることでアプリケーション全体の応答性が低下する原因となるため、非同期バージョンのfs.openメソッドの使用が推奨されます。
構文(syntax)
1const fs = require('node:fs'); 2const fileDescriptor = fs.openSync('path/to/file.txt', 'r');
引数(parameters)
path, flags, mode = 0o666
- path: string: 開くファイルのパス。
- flags: string (オプション): ファイルを開く際のフラグ。
- mode: number = 0o666 (オプション): ファイルのパーミッションモード。
戻り値(return)
integer
openSyncメソッドは、ファイルを開いた際に、そのファイルディスクリプタを表す整数値を返します。ファイルディスクリプタは、オペレーティングシステムがファイルを識別するために使用する番号です。