Skip to content
Version: xstate@5.0.0

forwardTo() function​

Forwards (sends) an event to a specified service.

Signature:

export declare function forwardTo<TContext extends MachineContext, TExpressionEvent extends EventObject, TParams extends ParameterizedObject['params'] | undefined, TEvent extends EventObject, TDelay extends string>(target: Target<TContext, TExpressionEvent, TParams, TEvent>, options?: SendToActionOptions<TContext, TExpressionEvent, TParams, TEvent, TDelay>): SendToAction<TContext, TExpressionEvent, TParams, TEvent, TDelay>;

Parameters​

ParameterTypeDescription
targetTarget<TContext, TExpressionEvent, TParams, TEvent>The target service to forward the event to.
optionsSendToActionOptions<TContext, TExpressionEvent, TParams, TEvent, TDelay>(Optional) Options to pass into the send action creator.

Returns:

SendToAction<TContext, TExpressionEvent, TParams, TEvent, TDelay>