Skip to content

Commit

Permalink
fix(store): fix typing of on fn (#3577)
Browse files Browse the repository at this point in the history
Closes #3576
  • Loading branch information
alex-okrushko committed Sep 19, 2022
1 parent 9804eca commit d054aa9
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 9 deletions.
34 changes: 34 additions & 0 deletions modules/store/spec/types/reducer_creator.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -90,5 +90,39 @@ describe('createReducer()', () => {
on(foo, (state, action) => { const bar: string = action.bar; return state; });
`).toFail(/'bar' does not exist on type/);
});

it('should infer the typed based on state and actions type with action used in on function', () => {
expectSnippet(`
interface State { name: string };
const foo = createAction('FOO', props<{ foo: string }>());
const onFn = on(foo, (state: State, action) => ({ name: action.foo }));
`).toInfer(
'onFn',
`
ReducerTypes<{
name: string;
}, [ActionCreator<"FOO", (props: {
foo: string;
}) => {
foo: string;
} & TypedAction<"FOO">>]>
`
);
});

it('should infer the typed based on state and actions type without action', () => {
expectSnippet(`
interface State { name: string };
const foo = createAction('FOO');
const onFn = on(foo, (state: State) => ({ name: 'some value' }));
`).toInfer(
'onFn',
`
ReducerTypes<{
name: string;
}, [ActionCreator<"FOO", () => TypedAction<"FOO">>]>
`
);
});
});
});
46 changes: 37 additions & 9 deletions modules/store/src/reducer_creator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,23 @@ export interface ReducerTypes<
types: ExtractActionTypes<Creators>;
}

// Specialized Reducer that is aware of the Action type it needs to handle
export interface OnReducer<State, Creators extends readonly ActionCreator[]> {
(state: State, action: ActionType<Creators[number]>): State;
/**
* Specialized Reducer that is aware of the Action type it needs to handle
*/
export interface OnReducer<
// State type that is being passed from consumer of `on` fn, e.g. from `createReducer` factory
State,
Creators extends readonly ActionCreator[],
// Inferred type from within OnReducer function if `State` is unknown
InferredState = State,
// Resulting state would be either a State or if State is unknown then the inferred state from the function itself
ResultState = unknown extends State ? InferredState : State
> {
(
// if State is unknown then set the InferredState type
state: unknown extends State ? InferredState : State,
action: ActionType<Creators[number]>
): ResultState;
}

/**
Expand All @@ -39,15 +53,29 @@ export interface OnReducer<State, Creators extends readonly ActionCreator[]> {
* on(AuthApiActions.loginSuccess, (state, { user }) => ({ ...state, user }))
* ```
*/
export function on<State, Creators extends readonly ActionCreator[]>(
export function on<
// State type that is being passed from `createReducer` when created within that factory function
State,
// Action creators
Creators extends readonly ActionCreator[],
// Inferred type from within OnReducer function if `State` is unknown. This is typically the case when `on` function
// is created outside of `createReducer` and state type is either explicitly set OR inferred by return type.
// For example: `const onFn = on(action, (state: State, {prop}) => ({ ...state, name: prop }));`
InferredState = State
>(
...args: [
...creators: Creators,
reducer: OnReducer<State extends infer S ? S : never, Creators>
reducer: OnReducer<
State extends infer S ? S : never,
Creators,
InferredState
>
]
): ReducerTypes<State, Creators> {
// This could be refactored when TS releases the version with this fix:
// https://github.com/microsoft/TypeScript/pull/41544
const reducer = args.pop() as OnReducer<any, Creators>;
): ReducerTypes<unknown extends State ? InferredState : State, Creators> {
const reducer = args.pop() as unknown as OnReducer<
unknown extends State ? InferredState : State,
Creators
>;
const types = (args as unknown as Creators).map(
(creator) => creator.type
) as unknown as ExtractActionTypes<Creators>;
Expand Down

0 comments on commit d054aa9

Please sign in to comment.