Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | 1x 1x 132x | import { RequiredType, guardFunctions } from "@jonloucks/concurrency-ts/api/Types";
/**
* Defines how a transition between states will be done
*
* @param <R> return type of the transition
*/
export interface Transition<S, R> {
/**
* @return the name of the event
*/
event: string;
/**
* @return the goal state of this transition
*/
successState: S;
/**
* @return the optional state if an exception is thrown
*/
errorState?: S
/**
* The optional state if the transition is not allowed.
*/
failedState?: S
/**
* @return the optional return value on success
*/
getSuccessValue?(): R;
/**
* @return the optional return value on exception thrown
*/
getErrorValue?(): R;
/**
* @return the optional return value if transition is not allowed
*/
getFailedValue?(): R;
}
/**
* Type guard to determine if an instance implements Transition
*
* @param instance the instance to check
* @return true if instance is a Transition
*/
export function guard<S, R>(instance: unknown): instance is RequiredType<Transition<S, R>> {
return guardFunctions(
instance,
'event',
'goalState',
'errorState',
'failedState',
'getSuccessValue',
'getErrorValue',
'getFailedValue'
);
} |