start()

start関数は、ワークフローの実行を開始します。定義されたワークフローの順序に従ってすべてのステップを処理し、並列実行、分岐ロジック、ステップ間の依存関係を管理します。

使用方法


const { runId, start } = workflow.createRun();
const result = await start({
  triggerData: { inputValue: 42 },
});

パラメーター

config?:

object

ワークフロー実行を開始するための設定

config

triggerData:

Record<string, any>

ワークフローの triggerSchema に一致する初期データ

戻り値

results:

Record<string, any>

完了したすべてのワークフローステップからの統合出力

status:

'completed' | 'error' | 'suspended'

ワークフロー実行の最終ステータス

エラー処理

start関数は、いくつかの種類のバリデーションエラーをスローする可能性があります。


try {
  const result = await start({ triggerData: data });
} catch (error) {
  if (error instanceof ValidationError) {
    console.log(error.type); // 'circular_dependency' | 'no_terminal_path' | 'unreachable_step'
    console.log(error.details);
  }
}