reactive-state/src/types.d.ts

Redux-like state management using RxJS and TypeScript

/**
 * A function which takes a State S and performs a transformation into a new state. The state mutation must be pure.
 * @returns A new state of type S
 */
export declare type StateMutation<S> = (state: S) => S;
/**
 * A reducer takes a state S, a payload P, applies a transformation using the payload to the state and
 * returns a new State. Reducers must be pure.
 */
export declare type Reducer<S, P = void> = (state: S, actionPayload: P) => S;
/**
 * Type of a "cleanup" state object that will be set to the slice when the sliceStore gets destroyed
 *
 * The special string "undefined" means the slice prop should be set to undefined (but the props remains there)
 * Using "delete" will remove the whole prop key from the state object (use this to leave no traces)
 */
export declare type CleanupState<K> = K | null | "undefined" | "delete";
export interface ActionDispatch<P> {
    actionName: string;
    actionPayload: P;
}
export interface StateChangeNotification<S = any> {
    actionName: string | undefined;
    actionPayload: any;
    newState: S;
}