関数の概要
child_process.execFileは、Node.jsで子プロセスを実行するための関数です。外部のプログラムを実行する際に使用され、非同期的にプロセスを開始します。主に外部プログラムの実行や結果の取得などに利用されます。
パラメータの説明
引数 | 型 | 用途 |
---|---|---|
file | String | 実行するファイルのパス |
args | Array | ファイルに渡す引数の配列 |
options | Object | オプション設定(ディレクトリ、環境変数など) |
戻り値
child_process.execFileの戻り値はChildProcessオブジェクトで、非同期的に子プロセスを開始します。プロセスの実行が完了した際にコールバック関数が呼ばれます。
使用例
例1: 外部プログラムを実行する
const { execFile } = require('child_process');
execFile('node', ['--version'], (error, stdout, stderr) => {
if (error) {
console.error(error);
return;
}
console.log(stdout);
});
例2: 引数を渡して外部プログラムを実行する
const { execFile } = require('child_process');
execFile('ls', ['-l', '-a'], (error, stdout, stderr) => {
if (error) {
console.error(error);
return;
}
console.log(stdout);
});
関連する関数
- child_process.exec: コマンドを実行し、結果をバッファリングする
- child_process.spawn: コマンドを実行し、ストリーム形式でデータを取得する
まとめ
child_process.execFileは外部プログラムを非同期的に実行するための便利な関数です。引数やオプションを指定して外部プログラムを実行し、結果を取得することができます。ただし、子プロセスが複雑で大量のデータを扱う場合は適切な対処が必要です。