escalate() function​
Escalates an error by sending it as an event to this machine's parent.
Signature:
export declare function escalate<TContext extends MachineContext, TExpressionEvent extends EventObject, TParams extends ParameterizedObject['params'] | undefined, TErrorData = any, TEvent extends EventObject = AnyEventObject>(errorData: TErrorData | ((args: UnifiedArg<TContext, TExpressionEvent, TEvent>) => TErrorData), options?: SendToActionParams<TContext, TExpressionEvent, TParams, EventObject, TEvent, string>): SendToAction<TContext, TExpressionEvent, TParams, TEvent, string>;
Parameters​
| Parameter | Type | Description |
|---|---|---|
| errorData | TErrorData | ((args: UnifiedArg<TContext, TExpressionEvent, TEvent>) => TErrorData) | The error data to send, or the expression function that takes in the context, event, and meta, and returns the error data to send. |
| options | SendToActionParams<TContext, TExpressionEvent, TParams, EventObject, TEvent, string> | (Optional) Options to pass into the send action creator. |
Returns:
SendToAction<TContext, TExpressionEvent, TParams, TEvent, string>