Mastra.getWorkflow()
.getWorkflow() メソッドは、登録キーで Workflow を取得します。このメソッドでは、Workflow の入出力スキーマに対して TypeScript の完全な型推論が適用されます。
使用例使用例への直接リンク
// Retrieve workflow by its registration key (recommended for type inference)
const workflow = mastra.getWorkflow('testWorkflow')
const run = await workflow.createRun()
// TypeScript will properly infer the input schema type
await run.startAsync({
inputData: {/* properly typed */},
})
型推論型推論への直接リンク
TypeScript のサポートを最大限に活用するには、Workflow の登録キー（Workflow を Mastra に追加したときに使用したキー）を getWorkflow() に渡します。次の項目で完全な型推論が適用されます。
- 入力データスキーマ
- 出力データスキーマ
- ステップの結果
登録キーではなく Workflow の id プロパティで取得する必要がある場合は、getWorkflowById() を使用できます。ただし、型推論の精度は低くなります。
パラメーターパラメーターへの直接リンク
id:
TWorkflowId extends keyof TWorkflows
取得する Workflow の ID。Mastra の設定に存在する有効な Workflow ID である必要があります。
options:
{ serialized?: boolean }
任意の設定オブジェクト。
serialized が true の場合、Workflow インスタンス全体ではなく Workflow 名だけを返します。戻り値戻り値への直接リンク
workflow:
TWorkflows[TWorkflowId]
指定した ID の Workflow インスタンス。Workflow が見つからない場合はエラーをスローします。