typings: make lettable ofType properly narrow action type #385
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Hotell
changed the title
jayphelps
reviewed
Jan 4, 2018
index.d.ts
Outdated
| @@ -52,6 +52,6 @@ export declare function createEpicMiddleware<T extends Action, S, D = any>(rootE | |||
| export declare function combineEpics<T extends Action, S, D = any>(...epics: Epic<T, S, D>[]): Epic<T, S, D>; | |||
| export declare function combineEpics<E>(...epics: E[]): E; | |||
|
|
|||
| export declare function ofType<T extends Action>(...keys: T['type'][]): (source: Observable<T>) => Observable<T>; | |||
| export declare function ofType<T extends Action, R extends T, K extends R['type'] = R['type']>(...key: K[]): (source: Observable<T>) => Observable<R>; | |||
There was a problem hiding this comment.
I believe this would be a breaking change since it now requires two params instead of one. But if we provide a default param for the second one I think that would make it non-breaking and have the same behavior as before wouldn't it? R extends T = T
ofType<T extends Action, R extends T = T, K extends R['type'] = R['type']>There was a problem hiding this comment.
yeah, good catch! my bad thx!
|
Thank you for this! Let's discuss my breaking change comment a bit. Also, I kicked the build as it failed for unrelated reasons and should pass now, assuming it would otherwise. |
- docs: add typescript ofType troubleshooting solution - chore(npm-scripts): enable all strict type-checking options for TS tests - test(typings): cover ofType proper type narrowing - docs: fix code typos - fix(typings): make ofType definition non breaking Closes redux-observable#382
|
hey @jayphelps sorry it took so long :( too busy lately
thx! |
|
Thanks again! |
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
I have read the Contributor Guide
My commit messages are in conventional-changelog-standard format.
adds Typescript docs to troubleshooting
enables strict mode for TS test
covers proper type narrowing within TS tests
Closes #382