feat(js-client): add type definitions #6009
Open
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
Add type definitions for dynamic client methods by defining the NetlifyAPI class as an interface that inherits mapped types.
CalebBarnes
commented
Jan 9, 2025
The api client methods will assign these to the correct places but just accept the params as a single object.
The api response for accessToken can possibly be undefined but we were only allowing string or null before.
…itions Since the API client allows using camelCased params we need to allow these to keep backwards compatibility.
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.
Add type definitions for dynamic client methods by defining the
NetlifyAPIclass as an interface that inherits mapped types from@netlify/open-api.Summary
Not having types is annoying, but lets try not to break things.
Screenshots
Using return types from
@netlify/open-api:Support both snake_case and camelCase params:
Support combined path and query params:
For us to review and ship your PR efficiently, please perform the following steps:
we can discuss the changes and get feedback from everyone that should be involved. If you`re fixing a typo or
something that`s on fire 🔥 (e.g. incident related), you can skip this step.
your code follows our style guide and passes our tests.
A picture of a cute animal (not mandatory, but encouraged)