Mastra.getWorkflow()
La méthode .getWorkflow() permet de récupérer un Workflow par sa clé d’enregistrement. Elle fournit une inférence de types TypeScript complète pour les schémas d’entrée et de sortie du Workflow.
Exemple d’utilisationLien direct vers Exemple d’utilisation
// 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 */},
})
Inférence de typesLien direct vers Inférence de types
Pour une prise en charge TypeScript optimale, utilisez getWorkflow() avec la clé d’enregistrement du Workflow (la clé utilisée lors de l’ajout du Workflow à Mastra). Cela fournit une inférence de types complète pour :
- Les schémas de données d’entrée
- Les schémas de données de sortie
- Les résultats des étapes
Si vous devez récupérer un Workflow à partir de sa propriété id plutôt que de sa clé d’enregistrement, vous pouvez utiliser getWorkflowById(), mais l’inférence de types sera moins précise.
ParamètresLien direct vers Paramètres
id:
TWorkflowId extends keyof TWorkflows
ID du Workflow à récupérer. Il doit s’agir d’un ID de Workflow valide présent dans la configuration Mastra.
options:
{ serialized?: boolean }
Objet de configuration facultatif. Lorsque
serialized est true, renvoie uniquement le nom du Workflow au lieu de l’instance Workflow complète.Valeur renvoyéeLien direct vers Valeur renvoyée
workflow:
TWorkflows[TWorkflowId]
Instance Workflow portant l’ID spécifié. Génère une erreur si le Workflow est introuvable.