feat: add getRepositoryEndpoint(), getRepositoryName(), isRepositoryName(), isRepositoryEndpoint(); deprecate getEndpoint()
#222
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
`getEndpoint()` is now deprecated and will be removed in a future major release.
…ndpoint()` `getRepositoryEndpoint()` and `getGraphQLEndpoint()` use `isRepositoryName()` to more safely construct the endpoints.
Codecov Report
@@ Coverage Diff @@
## master #222 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 20 23 +3
Lines 328 352 +24
Branches 63 65 +2
=========================================
+ Hits 328 352 +24
Continue to review full report at Codecov.
|
size-limit report 📦
|
angeloashmore
changed the title
getRepositoryEndpoint(), getRepositoryName(), isRepositoryName(), isRepositoryEndpoint(); deprecate getEndpoint()`getRepositoryEndpoint(), getRepositoryName(), isRepositoryName(), isRepositoryEndpoint(); deprecate getEndpoint()
7 tasks
lihbr
approved these changes
Feb 11, 2022
|
@angeloashmore Should we change |
Once this lands:
|
7 tasks
|
@lihbr @angeloashmore Do you have an estimated timeline for this? |
|
It has been shipped :) So we can start updating the doc accordingly |
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.
Types of changes
Description
This PR adds the following repository endpoint helpers:
getRepositoryEndpoint(): Rename ofgetEndpoint()getRepositoryName(): Extracts the repository name from a standard Prismic Rest API V2 endpointisRepositoryEndpoint(): Determines if an input is a valid repository endpointisRepositoryName(): Determines if an input is a valid repository nameSee each helper's TSDocs for more in-depth descriptions.
This PR also introduces the following deprecations:
getEndpoint(): Replaced bygetRepositoryEndpoint().getEndpoint()will be removed in a future major release.Related: prismicio/prismic-helpers#42
Checklist:
🐴