Mastra.getWorkflow()
.getWorkflow() 方法用於依註冊鍵取得 Workflow。此方法為 Workflow 輸入和輸出 schema 提供完整的 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()。這樣可對以下內容進行完整的類型推斷：
- 輸入資料 schema
- 輸出資料 schema
- 步驟結果
如果需要依 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，則擲回錯誤。