fix: Declare "EmptyObject" interface to wrap $CombinedState #4031
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.
Suggestion cannot be applied right now. Please check back later.
name: Declare EmptyObject interface to wrap $CombinedState
about: Adding interface for $CombinedState appeases latest version of Typescript, allows exporting result of
combineReducers
PR Type
Does this PR add a new feature, or fix a bug?
Fix a bug with lastest version of Typescript
Why should this PR be included?
No changes to exports are included, but the internal change from type->interface allows Typescript to correctly reference/export usage of
$CombinedState
Checklist
combineReducers
is not exportable with latest typescript #4030New Features
What new capabilities does this PR add?
None, just maintains support of typescript with latest 4.2.x releases
What docs changes are needed to explain this?
None
Bug Fixes
What is the current behavior, and the steps to reproduce the issue?
Upgrade to typescript v2.4.2
Create a file
example.ts
with the following content:make sure
declarations: true
is in yourtsconfig.json
Typescript will emit an error on:
Default export of the module has or is using private name '$CombinedState'.
Also see #4029 for minimal reproducible issue
What is the expected behavior?
No error should be emitted
How does this PR fix the problem?
combineReducers<S>()
returns a type ofReducer<CombinedState<S>>
, and theCombinedState<S>
is the type in question in this PRhttps://www.typescriptlang.org/docs/handbook/advanced-types.html#interfaces-vs-type-aliases
Digging a bit into how Typescript works, but basically a
type
is an alias. So any usage of atype
that internally uses$CombinedState
means the resulting declaration must also use$CombinedState
. Since that value is not exported, Typescript fails.Using an interface however does not need direct access to
$CombinedState
, so the exporting ofcombineReducers
will magically succeed.