Skip to main content

RefundProcess

RefundProcess​

@vendure/corerefund-process.ts

A RefundProcess is used to define the way the refund process works as in: what states a Refund can be in, and how it may transition from one state to another. Using the onTransitionStart() hook, a RefundProcess can perform checks before allowing a state transition to occur, and the onTransitionEnd() hook allows logic to be executed after a state change.

For detailed description of the interface members, see the StateMachineConfig docs.

Signature
interface RefundProcess<State extends keyof CustomRefundStates | string> extends InjectableStrategy {
    transitions?: Transitions<State, State | RefundState> & Partial<Transitions<RefundState | State>>;
    onTransitionStart?: OnTransitionStartFn<State | RefundState, RefundTransitionData>;
    onTransitionEnd?: OnTransitionEndFn<State | RefundState, RefundTransitionData>;
    onTransitionError?: OnTransitionErrorFn<State | RefundState>;
}

transitions​

property
Transitions<State, State | RefundState> & Partial<Transitions<RefundState | State>>

onTransitionStart​

property
OnTransitionStartFn<State | RefundState, RefundTransitionData>

onTransitionEnd​

property
OnTransitionEndFn<State | RefundState, RefundTransitionData>

onTransitionError​

property
OnTransitionErrorFn<State | RefundState>