step

La fonction step() enregistre une étape nommée dans un flow. Quand includeDetails est activé dans F.run(), les noms d'étapes collectés sont retournés avec le résultat final.

Exemple interactif

Syntaxe

function step<
	GenericName extends string,
	GenericOutput extends unknown = void
>(
	name: GenericName,
	theFunction?: () => GenericOutput
): Generator | AsyncGenerator

Paramètres

• name : Label d'étape stocké dans les détails d'exécution.
• theFunction : Callback optionnel exécuté après l'émission du step. Son résultat devient la valeur de retour de step().

Valeur de retour

Un générateur qui émet un effet de step. Il retourne undefined quand aucun callback n'est fourni, sinon retourne le résultat du callback.

Voir aussi

• run - Collecte les noms d'étapes quand includeDetails est activé
• exec - Propage les effets de step depuis des flows imbriqués