Skip to content
Version: xstate@5.0.0

choose() function​

Signature:

export declare function choose<TContext extends MachineContext, TExpressionEvent extends EventObject, TEvent extends EventObject, TParams extends ParameterizedObject['params'] | undefined, TActor extends ProvidedActor, TAction extends ParameterizedObject, TGuard extends ParameterizedObject, TDelay extends string>(branches: ReadonlyArray<ChooseBranch<TContext, TExpressionEvent, TEvent, TActor, NoInfer<TAction>, NoInfer<TGuard>, TDelay>>): ChooseAction<TContext, TExpressionEvent, TParams, TEvent, TActor, TAction, TGuard, TDelay>;

Parameters​

ParameterTypeDescription
branchesReadonlyArray<ChooseBranch<TContext, TExpressionEvent, TEvent, TActor, NoInfer<TAction>, NoInfer<TGuard>, TDelay>>

Returns:

ChooseAction<TContext, TExpressionEvent, TParams, TEvent, TActor, TAction, TGuard, TDelay>