stale[bot]
commented
2 years ago This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
This PR contains the following updates:
^2.3.0->2.4.1Release Notes
reduxjs/redux-thunk
### [`v2.4.1`](https://togithub.com/reduxjs/redux-thunk/releases/tag/v2.4.1) [Compare Source](https://togithub.com/reduxjs/redux-thunk/compare/v2.4.0...v2.4.1) This release adds an explicit plain `action` overload to the `ThunkDispatch` TS type to better handle inference of the return value in some cases. #### What's Changed - Improve action return value resolution by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/redux-thunk/pull/327](https://togithub.com/reduxjs/redux-thunk/pull/327) **Full Changelog**: https://github.com/reduxjs/redux-thunk/compare/v2.4.0...v2.4.1 ### [`v2.4.0`](https://togithub.com/reduxjs/redux-thunk/releases/tag/v2.4.0) [Compare Source](https://togithub.com/reduxjs/redux-thunk/compare/v2.3.0...v2.4.0) This *very* overdue release makes several major improvements to the TypeScript types, and converts the actual source to TypeScript. Sorry for the delay! #### Changelog ##### TypeScript Improvements This release fixes several outstanding issues that had been reported with the types. An extra overload has been added to let TS correctly understand some generically-typed values being passed to `dispatch`, and the overloads have been reworked for additional compatibility. There's also a new `ThunkActionDispatch` type that can be used to represent how `bindActionCreators` turns bound thunks into `(arg) => thunkReturnValue`. Additionally, all of the generic args have been giving meaningful names instead of one-letter abbreviations (`S` -> `State`, `E` -> `ExtraArgument`, etc), and we've added descriptive comments in the type definitions for clarity. ##### Optional Global `Dispatch` Type Extension Most Redux apps have the thunk middleware enabled, but the default `Dispatch` and `bindActionCreator` types only know about the standard behavior of a basic Redux store without any middleware. The thunk middleware types add to that type behavior, so that `Dispatch` knows dispatching a thunk can actually return a value such as a Promise. We generally recommend [inferring the type of `dispatch` and using that to create reusable types](https://redux.js.org/tutorials/typescript-quick-start#define-root-state-and-dispatch-types), including [creating pre-typed hooks](https://redux.js.org/tutorials/typescript-quick-start#define-typed-hooks). However, some users may prefer to globally augment the `Dispatch` type to always use the additional thunk behavior. You can now `import 'redux-thunk/extend-redux'` to globally augment the `Dispatch` type as an opt-in change in behavior. ##### Codebase Converted to TypeScript We've gone ahead and converted the actual source to TS. Since the source was only 15-ish lines to begin with, most of the "conversion" time was just trying to convince TS that assigning `thunk.extraArgument = createThunkMiddleware` was a legal operation :) We also updated the build tooling: - Babel updates - Rollup for the UMDs instead of Webpack - Github Actions for CI instead of Travis Finally, the README has been updated with newer instructions and usage information. #### What's Changed - Change misleading parameter name for overload of ThunkDispatch by [@jmrog](https://togithub.com/jmrog) in [https://github.com/reduxjs/redux-thunk/pull/216](https://togithub.com/reduxjs/redux-thunk/pull/216) - \--save no longer needed by [@JoeCortopassi](https://togithub.com/JoeCortopassi) in [https://github.com/reduxjs/redux-thunk/pull/217](https://togithub.com/reduxjs/redux-thunk/pull/217) - Allow action to be typed with any by [@laat](https://togithub.com/laat) in [https://github.com/reduxjs/redux-thunk/pull/219](https://togithub.com/reduxjs/redux-thunk/pull/219) - Add overload for bindActionCreators by [@RMHonor](https://togithub.com/RMHonor) in [https://github.com/reduxjs/redux-thunk/pull/224](https://togithub.com/reduxjs/redux-thunk/pull/224) - promote gender neutral docs by [@beatfactor](https://togithub.com/beatfactor) in [https://github.com/reduxjs/redux-thunk/pull/234](https://togithub.com/reduxjs/redux-thunk/pull/234) - Clarify terminology by [@jmm](https://togithub.com/jmm) in [https://github.com/reduxjs/redux-thunk/pull/237](https://togithub.com/reduxjs/redux-thunk/pull/237) - Provide more informative names for TypeScript type params by [@agwells](https://togithub.com/agwells) in [https://github.com/reduxjs/redux-thunk/pull/243](https://togithub.com/reduxjs/redux-thunk/pull/243) - Add peer dependency on redux 4.0 by [@hedgepigdaniel](https://togithub.com/hedgepigdaniel) in [https://github.com/reduxjs/redux-thunk/pull/251](https://togithub.com/reduxjs/redux-thunk/pull/251) - chore: remove 2015 preset and add env by [@hozefaj](https://togithub.com/hozefaj) in [https://github.com/reduxjs/redux-thunk/pull/236](https://togithub.com/reduxjs/redux-thunk/pull/236) - [#248](https://togithub.com/reduxjs/redux-thunk/issues/248) Add union overload to ThunkDispatch by [@Philipp91](https://togithub.com/Philipp91) in [https://github.com/reduxjs/redux-thunk/pull/255](https://togithub.com/reduxjs/redux-thunk/pull/255) - fix: extraThunkArgument types by [@jedmao](https://togithub.com/jedmao) in [https://github.com/reduxjs/redux-thunk/pull/260](https://togithub.com/reduxjs/redux-thunk/pull/260) - Upgrade dependencies by [@jedmao](https://togithub.com/jedmao) in [https://github.com/reduxjs/redux-thunk/pull/261](https://togithub.com/reduxjs/redux-thunk/pull/261) - Add Prettier by [@jedmao](https://togithub.com/jedmao) in [https://github.com/reduxjs/redux-thunk/pull/262](https://togithub.com/reduxjs/redux-thunk/pull/262) - fix: typo TExtraThunkARg -> TExtraThunkArg by [@jedmao](https://togithub.com/jedmao) in [https://github.com/reduxjs/redux-thunk/pull/263](https://togithub.com/reduxjs/redux-thunk/pull/263) - declare this package as having no side effects by [@VincentBailly](https://togithub.com/VincentBailly) in [https://github.com/reduxjs/redux-thunk/pull/267](https://togithub.com/reduxjs/redux-thunk/pull/267) - Reflect rename of Redux Starter Kit by [@travigd](https://togithub.com/travigd) in [https://github.com/reduxjs/redux-thunk/pull/270](https://togithub.com/reduxjs/redux-thunk/pull/270) - Correct destructuring example by [@telegraham](https://togithub.com/telegraham) in [https://github.com/reduxjs/redux-thunk/pull/272](https://togithub.com/reduxjs/redux-thunk/pull/272) - Fix link by [@mhienle](https://togithub.com/mhienle) in [https://github.com/reduxjs/redux-thunk/pull/276](https://togithub.com/reduxjs/redux-thunk/pull/276) - feat(ts): add Dispatch overload to redux module by [@iamandrewluca](https://togithub.com/iamandrewluca) in [https://github.com/reduxjs/redux-thunk/pull/278](https://togithub.com/reduxjs/redux-thunk/pull/278) - docs: fix link for `applyMiddleware` by [@iamandrewluca](https://togithub.com/iamandrewluca) in [https://github.com/reduxjs/redux-thunk/pull/279](https://togithub.com/reduxjs/redux-thunk/pull/279) - Improved wording in README.md by [@haricharanbole](https://togithub.com/haricharanbole) in [https://github.com/reduxjs/redux-thunk/pull/293](https://togithub.com/reduxjs/redux-thunk/pull/293) - chore: add yarn add line by [@RichardBray](https://togithub.com/RichardBray) in [https://github.com/reduxjs/redux-thunk/pull/305](https://togithub.com/reduxjs/redux-thunk/pull/305) - Use "sh" instead of "js" in install instructions by [@EvanHahn](https://togithub.com/EvanHahn) in [https://github.com/reduxjs/redux-thunk/pull/312](https://togithub.com/reduxjs/redux-thunk/pull/312) - Remove redundant `|` by [@Philipp91](https://togithub.com/Philipp91) in [https://github.com/reduxjs/redux-thunk/pull/317](https://togithub.com/reduxjs/redux-thunk/pull/317) - Use GitHub Actions by [@nickmccurdy](https://togithub.com/nickmccurdy) in [https://github.com/reduxjs/redux-thunk/pull/318](https://togithub.com/reduxjs/redux-thunk/pull/318) - Update TS dev tooling and GH Actions workflow by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/redux-thunk/pull/320](https://togithub.com/reduxjs/redux-thunk/pull/320) - Move Redux module type extension into a separate imported file by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/redux-thunk/pull/321](https://togithub.com/reduxjs/redux-thunk/pull/321) - Add CodeSandbox CI by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/redux-thunk/pull/323](https://togithub.com/reduxjs/redux-thunk/pull/323) - Convert codebase to TS and update build tooling by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/redux-thunk/pull/322](https://togithub.com/reduxjs/redux-thunk/pull/322) - Remove Webpack config and try test build by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/redux-thunk/pull/324](https://togithub.com/reduxjs/redux-thunk/pull/324) #### New Contributors - [@jmrog](https://togithub.com/jmrog) made their first contribution in [https://github.com/reduxjs/redux-thunk/pull/216](https://togithub.com/reduxjs/redux-thunk/pull/216) - [@JoeCortopassi](https://togithub.com/JoeCortopassi) made their first contribution in [https://github.com/reduxjs/redux-thunk/pull/217](https://togithub.com/reduxjs/redux-thunk/pull/217) - [@laat](https://togithub.com/laat) made their first contribution in [https://github.com/reduxjs/redux-thunk/pull/219](https://togithub.com/reduxjs/redux-thunk/pull/219) - [@RMHonor](https://togithub.com/RMHonor) made their first contribution in [https://github.com/reduxjs/redux-thunk/pull/224](https://togithub.com/reduxjs/redux-thunk/pull/224) - [@beatfactor](https://togithub.com/beatfactor) made their first contribution in [https://github.com/reduxjs/redux-thunk/pull/234](https://togithub.com/reduxjs/redux-thunk/pull/234) - [@jmm](https://togithub.com/jmm) made their first contribution in [https://github.com/reduxjs/redux-thunk/pull/237](https://togithub.com/reduxjs/redux-thunk/pull/237) - [@agwells](https://togithub.com/agwells) made their first contribution in [https://github.com/reduxjs/redux-thunk/pull/243](https://togithub.com/reduxjs/redux-thunk/pull/243) - [@hedgepigdaniel](https://togithub.com/hedgepigdaniel) made their first contribution in [https://github.com/reduxjs/redux-thunk/pull/251](https://togithub.com/reduxjs/redux-thunk/pull/251) - [@hozefaj](https://togithub.com/hozefaj) made their first contribution in [https://github.com/reduxjs/redux-thunk/pull/236](https://togithub.com/reduxjs/redux-thunk/pull/236) - [@Philipp91](https://togithub.com/Philipp91) made their first contribution in [https://github.com/reduxjs/redux-thunk/pull/255](https://togithub.com/reduxjs/redux-thunk/pull/255) - [@jedmao](https://togithub.com/jedmao) made their first contribution in [https://github.com/reduxjs/redux-thunk/pull/260](https://togithub.com/reduxjs/redux-thunk/pull/260) - [@VincentBailly](https://togithub.com/VincentBailly) made their first contribution in [https://github.com/reduxjs/redux-thunk/pull/267](https://togithub.com/reduxjs/redux-thunk/pull/267) - [@travigd](https://togithub.com/travigd) made their first contribution in [https://github.com/reduxjs/redux-thunk/pull/270](https://togithub.com/reduxjs/redux-thunk/pull/270) - [@telegraham](https://togithub.com/telegraham) made their first contribution in [https://github.com/reduxjs/redux-thunk/pull/272](https://togithub.com/reduxjs/redux-thunk/pull/272) - [@mhienle](https://togithub.com/mhienle) made their first contribution in [https://github.com/reduxjs/redux-thunk/pull/276](https://togithub.com/reduxjs/redux-thunk/pull/276) - [@iamandrewluca](https://togithub.com/iamandrewluca) made their first contribution in [https://github.com/reduxjs/redux-thunk/pull/278](https://togithub.com/reduxjs/redux-thunk/pull/278) - [@haricharanbole](https://togithub.com/haricharanbole) made their first contribution in [https://github.com/reduxjs/redux-thunk/pull/293](https://togithub.com/reduxjs/redux-thunk/pull/293) - [@RichardBray](https://togithub.com/RichardBray) made their first contribution in [https://github.com/reduxjs/redux-thunk/pull/305](https://togithub.com/reduxjs/redux-thunk/pull/305) - [@EvanHahn](https://togithub.com/EvanHahn) made their first contribution in [https://github.com/reduxjs/redux-thunk/pull/312](https://togithub.com/reduxjs/redux-thunk/pull/312) - [@nickmccurdy](https://togithub.com/nickmccurdy) made their first contribution in [https://github.com/reduxjs/redux-thunk/pull/318](https://togithub.com/reduxjs/redux-thunk/pull/318) - [@markerikson](https://togithub.com/markerikson) made their first contribution in [https://github.com/reduxjs/redux-thunk/pull/320](https://togithub.com/reduxjs/redux-thunk/pull/320) **Full Changelog**: https://github.com/reduxjs/redux-thunk/compare/v2.3.0...v2.4.0Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.