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 屬性而非註冊鍵擷取 Workflow，可使用 getWorkflowById()，但請注意，類型推斷的精確度會較低。
參數參數 的直接連結
id:
TWorkflowId extends keyof TWorkflows
要擷取的 Workflow ID。必須是 Mastra 設定中存在的有效 Workflow ID。
options:
{ serialized?: boolean }
選用設定物件。當
serialized 為 true 時，只傳回 Workflow 名稱，而非完整的 Workflow 執行個體。傳回值傳回值 的直接連結
workflow:
TWorkflows[TWorkflowId]
具有指定 ID 的 Workflow 執行個體。如找不到 Workflow，則會擲回錯誤。