redux-smart-creators/dist/types/reducer.d.ts

Smart creators for actions and reducers

import { BasicAction, PayloadFunction, UnknownAction } from './common';
import { ActionCreatorBase, ActionCreatorWithPayload } from './creator';
/**
 * Reducer from Redux
 */
export declare type Reducer<State = any, Action extends UnknownAction<string> = BasicAction<string>> = (state: State | undefined, action: Action) => State;
/**
 * A handler that takes no arguments
 * Used in the "on" method
 */
export declare type EmptyStateHandler<State> = () => State;
/**
 * A handler that takes state as an argument
 * Used in the "on" method
 */
export declare type StateHandler<State> = (state: State) => State;
/**
 * A handler that takes state and payload as arguments
 * Used in the "on" method
 */
export declare type StateWithPayloadHandler<State, Payload> = (state: State, payload: Payload) => State;
/**
 * Handlers Union
 * Used in the "on" method
 */
export declare type AnyStateHandler<State, Payload = any> = EmptyStateHandler<State> | StateHandler<State> | StateWithPayloadHandler<State, Payload>;
/**
 * A handler that takes payload as an argument
 * Used in the "getFromPayload" method
 */
export interface PayloadToStateHandler<State, Payload = any> {
    (payload: Payload): State;
}
/**
 * Incoming action or actions handler
 * Accepts a transform function that should return a new state
 */
export interface ReducerActionHandler<State, Action extends BasicAction<string>> {
    <ActionType extends Action['type'], ActionCreator extends ActionCreatorBase<ActionType>>(actionCreator: ActionCreator, staticValue: State): ReducerCreator<State, Action>;
    <ActionType extends Action['type'], ActionCreator extends ActionCreatorBase<ActionType>>(actionCreator: ActionCreator, handler: () => State): ReducerCreator<State, Action>;
    <ActionType extends Action['type'], ActionCreator extends ActionCreatorBase<ActionType>>(actionCreator: ActionCreator, handler: (state: State) => State): ReducerCreator<State, Action>;
    <ActionType extends Action['type'], ActionCreator extends ActionCreatorWithPayload<ActionType, any>>(actionCreator: ActionCreator, handler: (state: State, payload: ReturnType<ActionCreator>['payload']) => State): ReducerCreator<State, Action>;
    <ActionType extends Action['type'], ActionCreator extends ActionCreatorBase<ActionType>>(actionCreators: ActionCreator[], staticValue: State): ReducerCreator<State, Action>;
    <ActionType extends Action['type'], ActionCreator extends ActionCreatorBase<ActionType>>(actionCreators: ActionCreator[], handler: () => State): ReducerCreator<State, Action>;
    <ActionType extends Action['type'], ActionCreator extends ActionCreatorBase<ActionType>>(actionCreators: ActionCreator[], handler: (state: State) => State): ReducerCreator<State, Action>;
    <ActionType extends Action['type'], ActionCreator extends ActionCreatorWithPayload<ActionType, any>>(actionCreators: ActionCreator[], handler: (state: State, payload: ReturnType<ActionCreator>['payload']) => State): ReducerCreator<State, Action>;
}
/**
 * Resets the state to its initial state
 */
export interface ReducerResetHandler<State, Action extends UnknownAction<string>> {
    <ActionType extends Action['type']>(...actions: ActionCreatorBase<ActionType>[]): ReducerCreator<State, Action>;
}
/**
 * Changes state to payload
 */
export interface ReducerSwitchToPayloadHandler<State, Action extends UnknownAction<string>> {
    <ActionType extends Action['type']>(...actionCreators: ActionCreatorWithPayload<ActionType, PayloadFunction<State>>[]): ReducerCreator<State, Action>;
}
/**
 * Incoming action or actions handler
 * Accepts a transform function that should return a new state
 */
export interface ReducerGetFromPayloadHandler<State, Action extends UnknownAction<string>> {
    <ActionType extends Action['type'], ActionCreator extends ActionCreatorWithPayload<ActionType, any>>(actionCreator: ActionCreator, handler: PayloadToStateHandler<State, ReturnType<ActionCreator>['payload']>): ReducerCreator<State, Action>;
    <ActionType extends Action['type'], ActionCreator extends ActionCreatorWithPayload<ActionType, any>>(actionCreators: ActionCreator[], handler: PayloadToStateHandler<State, ReturnType<ActionCreator>['payload']>): ReducerCreator<State, Action>;
}
/**
 * A function that injects additional logic into the ReducerCreator
 */
export interface ReducerLogicCreator<State, Action extends BasicAction<string>> {
    (reducerCreator: ReducerCreator<State, Action>): ReducerCreator<State, Action>;
}
/**
 * Injecting external logic into the ReducerCreator
 */
export interface InjectLogic<State, Action extends UnknownAction<string>> {
    (logicCreator: ReducerLogicCreator<State, Action>): ReducerCreator<State, Action>;
}
/**
 * An object that contains tools for configuring the reducer
 */
export interface ReducerCreator<State, Action extends BasicAction<string> = BasicAction<string>> {
    create(): Reducer<State, Action>;
    on: ReducerActionHandler<State, Action>;
    reset: ReducerResetHandler<State, Action>;
    switchToPayload: ReducerSwitchToPayloadHandler<State, Action>;
    getFromPayload: ReducerGetFromPayloadHandler<State, Action>;
    injectLogic: InjectLogic<State, Action>;
}