Add back keys property to regex
#272
Draft
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
The returned regex object from `pathToRegex` used to include the modified keys array as a `keys` property in v1.7.0. The current API is not entirely ideal, since a keys array must be passed, we could instead use a more functional API where no array is mutated. In the future this should be changed that no array needs to be passed to `pathToRegex`, adding it as a property is done for backwards compatibility.
blakeembrey
reviewed
Mar 9, 2022
| /** | ||
| * Optional property that includes key metadata corresponding to this regex. | ||
| */ | ||
| keys?: Key[]; |
There was a problem hiding this comment.
Can we make this required? A way to get around TypeScript complaining is to use Object.assign(regex, { keys }).
|
We'll also need a simple couple of tests to ensure we don't regress but otherwise LGTM 😄 |
Codecov Report
@@ Coverage Diff @@
## master #272 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 1 1
Lines 246 250 +4
Branches 98 98
=========================================
+ Hits 246 250 +4
Continue to review full report at Codecov.
|
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.
See issue #236
The returned regex object from
pathToRegexused to include the modifiedkeys array as a
keysproperty in v1.7.0. The current API is not entirelyideal, since a keys array must be passed, we could instead use a more
functional API without mutation.
In the future this should be changed that no array needs to be passed to
pathToRegex,adding it as a property this way is done to maintain backwards compatibility.