Skip to content

correctly enforce meta and error types as returned from prepare #350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 13, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions etc/redux-toolkit.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,21 +194,17 @@ export type SliceActionCreator<P> = PayloadActionCreator<P>;

// @public
export type SliceCaseReducers<State> = {
[K: string]: CaseReducer<State, PayloadAction<any>> | CaseReducerWithPrepare<State, PayloadAction<any>>;
[K: string]: CaseReducer<State, PayloadAction<any>> | CaseReducerWithPrepare<State, PayloadAction<any, string, any, any>>;
};

export { ThunkAction }

// @public
export type ValidateSliceCaseReducers<S, ACR extends SliceCaseReducers<S>> = ACR & {
[P in keyof ACR]: ACR[P] extends {
reducer(s: S, action?: {
payload: infer O;
}): any;
[T in keyof ACR]: ACR[T] extends {
reducer(s: S, action?: infer A): any;
} ? {
prepare(...a: never[]): {
payload: O;
};
prepare(...a: never[]): Omit<A, 'type'>;
} : {};
};

Expand Down
9 changes: 5 additions & 4 deletions src/createSlice.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import {
ActionReducerMapBuilder,
executeReducerBuilderCallback
} from './mapBuilders'
import { Omit } from './tsHelpers'

/**
* An action creator atttached to a slice.
Expand Down Expand Up @@ -110,7 +111,7 @@ export type CaseReducerWithPrepare<State, Action extends PayloadAction> = {
export type SliceCaseReducers<State> = {
[K: string]:
| CaseReducer<State, PayloadAction<any>>
| CaseReducerWithPrepare<State, PayloadAction<any>>
| CaseReducerWithPrepare<State, PayloadAction<any, string, any, any>>
}

/**
Expand Down Expand Up @@ -187,11 +188,11 @@ export type ValidateSliceCaseReducers<
ACR extends SliceCaseReducers<S>
> = ACR &
{
[P in keyof ACR]: ACR[P] extends {
reducer(s: S, action?: { payload: infer O }): any
[T in keyof ACR]: ACR[T] extends {
reducer(s: S, action?: infer A): any
}
? {
prepare(...a: never[]): { payload: O }
prepare(...a: never[]): Omit<A, 'type'>
}
: {}
}
Expand Down
2 changes: 2 additions & 0 deletions src/tsHelpers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,3 +87,5 @@ type UnionToIntersection<U> = (U extends any
: never) extends ((k: infer I) => void)
? I
: never

export type Omit<T, K extends keyof any> = Pick<T, Exclude<keyof T, K>>
61 changes: 60 additions & 1 deletion type-tests/files/createSlice.typetest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ function expectType<T>(t: T) {
? payload.reduce((acc, val) => acc * val, state)
: state * payload,
addTwo: {
reducer: (s, { payload }) => s + payload,
reducer: (s, { payload }: PayloadAction<number>) => s + payload,
prepare: (a: number, b: number) => ({
payload: a + b
})
Expand Down Expand Up @@ -175,6 +175,65 @@ function expectType<T>(t: T) {
expectType<string>(counter.actions.concatMetaStrLen('test').meta)
}

/**
* Test: access meta and error from reducer
*/
{
const counter = createSlice({
name: 'test',
initialState: { counter: 0, concat: '' },
reducers: {
// case: meta and error not used in reducer
testDefaultMetaAndError: {
reducer(_, action: PayloadAction<number, string>) {},
prepare: (payload: number) => ({
payload,
meta: 'meta' as 'meta',
error: 'error' as 'error'
})
},
// case: meta and error marked as "unknown" in reducer
testUnknownMetaAndError: {
reducer(_, action: PayloadAction<number, string, unknown, unknown>) {},
prepare: (payload: number) => ({
payload,
meta: 'meta' as 'meta',
error: 'error' as 'error'
})
},
// case: meta and error are typed in the reducer as returned by prepare
testMetaAndError: {
reducer(_, action: PayloadAction<number, string, 'meta', 'error'>) {},
prepare: (payload: number) => ({
payload,
meta: 'meta' as 'meta',
error: 'error' as 'error'
})
},
// case: meta is typed differently in the reducer than returned from prepare
testErroneousMeta: {
reducer(_, action: PayloadAction<number, string, 'meta', 'error'>) {},
// typings:expect-error
prepare: (payload: number) => ({
payload,
meta: 1,
error: 'error' as 'error'
})
},
// case: error is typed differently in the reducer than returned from prepare
testErroneousError: {
reducer(_, action: PayloadAction<number, string, 'meta', 'error'>) {},
// typings:expect-error
prepare: (payload: number) => ({
payload,
meta: 'meta' as 'meta',
error: 1
})
}
}
})
}

/*
* Test: returned case reducer has the correct type
*/
Expand Down