メインコンテンツまでスキップ

streamCommand

コマンド実行中にイベントを yield する非同期ジェネレータを返します。リアルタイム出力が必要な長時間実行プロセスに使用してください。最後のイベントは常に exit イベントです。

パラメータ

パラメータ説明
requestExecuteCommandRequestコマンド実行パラメータ
signalAbortSignal(オプション)キャンセル用のシグナル

戻り値

AsyncGenerator<CommandEvent>

使用例

for await (const event of mods.streamCommand({ command: "build" })) {
switch (event.type) {
case "stdout":
console.log(event.data);
break;
case "stderr":
console.error(event.data);
break;
case "exit":
console.log("完了、終了コード:", event.exitCode);
break;
}
}

AbortSignal によるキャンセル:

const controller = new AbortController();
for await (const event of mods.streamCommand({ command: "slow" }, controller.signal)) {
// ...
}