【Node.js24.x】Object::chmodSync()メソッドの使い方
chmodSyncメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
chmodSyncメソッドは、Node.jsのファイルシステム操作を担うfsモジュールに属し、指定されたファイルやディレクトリのアクセス権限を同期的に変更するメソッドです。このメソッドを使用することで、ファイルの読み取り、書き込み、実行といった権限をプログラムから設定できます。
このメソッドは、変更したいファイルやディレクトリのパスと、設定したい新しいパーミッションモード（権限設定）の二つの引数を受け取ります。パーミッションモードは通常、8進数表記（例：0o755）で指定され、ファイルの所有者、グループ、その他のユーザーに対するアクセス権限を定義します。例えば0o755は、ファイルの所有者には全ての権限を、グループとその他のユーザーには読み取りと実行権限を与える設定を表します。
「Sync」という名前が示す通り、このメソッドは権限変更処理が完了するまでNode.jsのプログラム実行をブロックします。そのため、処理中はアプリケーション全体の応答が一時的に停止する可能性があります。高い応答性が求められるWebサーバーなどでは、非同期版であるfs.chmodの使用が推奨されますが、シンプルなスクリプトやアプリケーションの初期設定など、処理の完了を待つことが許容される状況では、コードを簡潔に記述できる利点があります。処理中にエラーが発生した場合は例外がスローされるため、適切なエラーハンドリングも重要です。
構文(syntax)
1import { chmodSync } from 'node:fs'; 2 3chmodSync('./path/to/your/file.txt', 0o755);
引数(parameters)
path, mode
- path: string: 変更するファイルまたはディレクトリのパス
- mode: string | number: ファイルのパーミッションを指定するモード。数値または octal 文字列で指定します
戻り値(return)
戻り値なし
戻り値はありません