feat: address issuehunt #230#282
Conversation
There was a problem hiding this comment.
Code Review
This pull request introduces createAsyncReducer and createAsyncEpic to the library, along with documentation updates and comprehensive test suites. Feedback identifies that createAsyncReducer is missing from the public API exports in src/index.ts and points out an inconsistency regarding the export source of AsyncActionCreatorMap. Additionally, the documentation needs to be updated to reflect the new rxjs peer dependency, as it currently claims the library has no third-party dependencies.
| export { | ||
| createAsyncEpic, | ||
| AsyncActionCreatorMap, | ||
| AsyncEpicOutputAction, | ||
| CreateAsyncEpicOptions, | ||
| } from './create-async-epic'; |
There was a problem hiding this comment.
The createAsyncReducer function is missing from the public API exports, which contradicts the documentation and examples provided in the README. Additionally, there is a discrepancy regarding AsyncActionCreatorMap: it is exported from ./create-async-epic here, but the tests in src/create-async-reducer.spec.ts import it from ./create-async-reducer. It should be exported from its primary definition file to ensure consistency.
| export { | |
| createAsyncEpic, | |
| AsyncActionCreatorMap, | |
| AsyncEpicOutputAction, | |
| CreateAsyncEpicOptions, | |
| } from './create-async-epic'; | |
| export { | |
| createAsyncEpic, | |
| AsyncEpicOutputAction, | |
| CreateAsyncEpicOptions, | |
| } from './create-async-epic'; | |
| export { | |
| createAsyncReducer, | |
| AsyncActionCreatorMap, | |
| } from './create-async-reducer'; |
| "typescript": "3.7.2" | ||
| }, | ||
| "peerDependencies": { | ||
| "rxjs": "^6.0.0" |
There was a problem hiding this comment.
Adding rxjs as a peer dependency contradicts the "no third-party dependencies" claim in the README (line 61). While this is an appropriate peer dependency for the new Epic API, the documentation should be updated to reflect that the library now has optional dependencies for specific features to maintain transparency about its footprint.
|
Addressed the review points in this branch: |
Automated PR from
issuehunt-230-rtk-compat-v2for IssueHunt issue #230.IssueHunt Summary
Referenced issues
This pull request has been submitted to: