cancel() function​
Cancels an in-flight send(...) action. A canceled sent action will not be executed, nor will its event be sent, unless it has already been sent (e.g., if cancel(...) is called after the send(...) action's delay).
Signature:
export declare function cancel<TContext extends MachineContext, TExpressionEvent extends EventObject, TParams extends ParameterizedObject['params'] | undefined, TEvent extends EventObject>(sendId: ResolvableSendId<TContext, TExpressionEvent, TParams, TEvent>): CancelAction<TContext, TExpressionEvent, TParams, TEvent>;
Parameters​
| Parameter | Type | Description |
|---|---|---|
| sendId | ResolvableSendId<TContext, TExpressionEvent, TParams, TEvent> | The id of the send(...) action to cancel. |
Returns:
CancelAction<TContext, TExpressionEvent, TParams, TEvent>