関数の概要
child_process.spawnSyncとは、Node.jsのモジュールであり、外部プロセスを同期的に実行するための関数です。子プロセスを起動し、そのプロセスの実行が完了するまで待機します。
パラメータの説明
| パラメータ | 型 | 用途 |
|---|---|---|
| command | String | 実行するコマンドを指定 |
| args | Array | コマンドに渡す引数を指定 |
| options | Object | オプション設定を指定 |
戻り値
child_process.spawnSyncの戻り値は、実行したプロセスの結果を含むオブジェクトです。非同期ではなく、同期的にプロセスを実行し、結果を返します。
使用例
以下は、lsコマンドを実行する例です。
const { spawnSync } = require('child_process');
const result = spawnSync('ls', ['-lh']);
console.log(result.stdout.toString());
次は、echoコマンドを使用する例です。
const { spawnSync } = require('child_process');
const result = spawnSync('echo', ['Hello, World!']);
console.log(result.stdout.toString());
関連する関数
- child_process.spawn: 非同期に外部プロセスを実行する
- child_process.execSync: 同期的に外部プロセスを実行する
まとめ
child_process.spawnSyncは、外部プロセスを同期的に実行する際に利用されます。プロセスの終了を待ってから結果を取得できるため、シンプルなコマンド実行や結果の取得に便利です。
