関数の概要
child_process.execSyncは、Node.jsで同期的に外部プロセスを実行するための関数です。外部コマンドを実行し、その結果を取得する際に使用されます。
パラメータの説明
引数 | 型 | 用途 |
---|---|---|
command | string | 実行するコマンドを指定 |
options | Object | 追加の設定オプションを指定(例:cwd、timeoutなど) |
戻り値
child_process.execSyncは外部プロセスの実行結果を返すため、実行結果(標準出力)の文字列が返り値となります。同期的に処理されるため、非同期ではなく同期的に動作します。
使用例
以下は、lsコマンドを実行してディレクトリ内のファイル一覧を取得する例です。
const { execSync } = require('child_process');
const result = execSync('ls');
console.log(result.toString());
次の例では、Windows環境でipconfigを実行してネットワーク情報を取得しています。
const { execSync } = require('child_process');
const result = execSync('ipconfig');
console.log(result.toString());
関連する関数
child_process.exec、child_process.spawnなど、非同期で外部プロセスを実行する関数が関連します。
まとめ
child_process.execSyncは外部プロセスを同期的に実行し、その結果を取得する際に使用される。ただし、同期的に処理されるため、処理が完了するまで次の処理を待つ点に注意が必要。