Skip to content
Version: xstate@5.0.0

sendParent() function​

Sends an event to this machine's parent.

Signature:

export declare function sendParent<TContext extends MachineContext, TExpressionEvent extends EventObject, TParams extends ParameterizedObject['params'] | undefined, TSentEvent extends EventObject = AnyEventObject, TEvent extends EventObject = AnyEventObject, TDelay extends string = string>(event: TSentEvent | SendExpr<TContext, TExpressionEvent, TParams, TSentEvent, TEvent>, options?: SendToActionOptions<TContext, TExpressionEvent, TParams, TEvent, TDelay>): SendToAction<TContext, TExpressionEvent, TParams, TEvent, TDelay>;

Parameters​

ParameterTypeDescription
eventTSentEvent | SendExpr<TContext, TExpressionEvent, TParams, TSentEvent, TEvent>The event to send to the parent machine.
optionsSendToActionOptions<TContext, TExpressionEvent, TParams, TEvent, TDelay>(Optional) Options to pass into the send event.

Returns:

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