【Node.js24.x】Object::accessSync()メソッドの使い方

accessSyncメソッドは、Node.jsのファイルシステム機能を提供するfsモジュールに属し、指定されたファイルやディレクトリが存在し、かつ現在のプロセスが特定のモードでアクセスできるかどうかを同期的に確認するメソッドです。

このメソッドは、第一引数に確認したいファイルまたはディレクトリのパスを文字列、Buffer、またはURLで指定します。第二引数にはオプションとして、チェックしたいアクセス権限を表すモードを指定します。モードには、fs.constants.F_OK（存在確認）、fs.constants.R_OK（読み込み権限）、fs.constants.W_OK（書き込み権限）、fs.constants.X_OK（実行権限）などを組み合わせて使用できます。たとえば、ファイルの存在と読み込み権限を同時に確認したい場合は、fs.constants.F_OK | fs.constants.R_OKのようにビット論理和で指定します。

accessSyncメソッドは同期的に動作するため、処理が完了するまでプログラムの実行を一時停止します。もし指定されたパスが存在しなかったり、必要なアクセス権限がない場合は、エラーをスローします。そのため、このメソッドを使用する際は、try-catchブロックを用いてエラーを適切に処理することが重要です。

アクセスが成功した場合、accessSyncメソッドはundefinedを返します。このメソッドは、ファイルを読み込む前にそのファイルが存在し、読み込み可能であることを確認したり、特定のディレクトリに書き込みが可能かチェックしたりする際に役立ちます。これにより、予期せぬエラーを防ぎ、より堅牢なアプリケーションを構築することができます。

Copy
1const fs = require('node:fs');
2
3try {
4  fs.accessSync('/path/to/your/file.txt', fs.constants.F_OK);
5  // 指定されたパスのファイルが存在するかどうかを同期的にチェックします。
6} catch (error) {
7  // ファイルが存在しない、またはアクセス権がない場合にエラーがスローされます。
8}

path, mode = fs.constants.F_OK

• path: string: アクセス権をチェックするファイルまたはディレクトリのパス
• mode: number = fs.constants.F_OK: アクセス権のモードを指定します。デフォルトは fs.constants.F_OK (存在確認) です。

戻り値なし

戻り値はありません