Skip to content
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.

Sign up for GitHub

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

fixes to bindActionCreators overloads #3552

Merged
merged 1 commit into from
Sep 2, 2019
Merged

fixes to bindActionCreators overloads #3552

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions src/bindActionCreators.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,25 @@ function bindActionCreator<A extends AnyAction = AnyAction>(
* function as `actionCreators`, the return value will also be a single
* function.
*/
export default function bindActionCreators<A, C extends ActionCreator<A>>(
Copy link
Member

@timdorr timdorr Sep 2, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please don't use single character generic names.

I haven't gone through the existing types to fix this, but I want to start enforcing it now. Preferably via a linting rule.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought this was the de facto standard for naming generics

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with @timdorr, descriptive names are better if the generic is longer than 1 line.

As for this PR, it is a copy/paste from the existing types in index.d.ts (https://github.com/reduxjs/redux/blob/master/index.d.ts#L559)

How would you feel about doing a follow-up PR that renames everything once we've got the whole thing converted to TS? Suggested steps:

  1. make it work as-is, with as few changes as possible
  2. merge in fix replaceReducer with a store enhancer #3524 (this is good to go, and will be much harder to rebase after the template variable renames)
  3. rename all the things

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep! I definitely want us to do incremental, history-traceable, step-by-step changes throughout this whole task. And yes, I'm on board with making types more clearly named.

actionCreator: C,
dispatch: Dispatch
): C

export default function bindActionCreators<
A extends ActionCreator<any>,
B extends ActionCreator<any>
>(actionCreator: A, dispatch: Dispatch): B

export default function bindActionCreators<
A,
M extends ActionCreatorsMapObject<A>
>(actionCreators: M, dispatch: Dispatch): M
export default function bindActionCreators<
M extends ActionCreatorsMapObject<any>,
N extends ActionCreatorsMapObject<any>
>(actionCreators: M, dispatch: Dispatch): N

export default function bindActionCreators(
actionCreators: ActionCreator<any> | ActionCreatorsMapObject,
dispatch: Dispatch
Expand Down