fix: restore string (pathname) in union type for previous LocationDescriptor #1791
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
🦋 Changeset detectedLatest commit: a86dffa The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
size-limit report 📦
|
mperrotti
reviewed
Jan 13, 2022
| @@ -1,5 +1,5 @@ | |||
| import classnames from 'classnames' | |||
| import {Location} from 'history' | |||
| import {Location, Pathname} from 'history' | |||
There was a problem hiding this comment.
The Pathname type is just string, but I agree with the decision to use Pathname.
There was a problem hiding this comment.
Yeah, easier to infer the semantic meaning this way. It was previously Path (string) in history@v4.
mperrotti
approved these changes
Jan 13, 2022
Merged
6 tasks
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.
Suggestion cannot be applied right now. Please check back later.
There is a TypeScript error occurring on all components that use the
Locationdefinitions fromhistory. This was introduced recently to replaceLocationDescriptor, which was recently deprecated as ofhistory@v5.Error noticed during a smoke test for release candidate on memex:
Solution:
The correct type definition should be a union of
Locationandstringto restore parity withLocationDescriptor. I've usedPathnameinstead, so it's easier to reason around why string is valid here.Merge checklist
Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.