fix(js-client): Update method params type to be optional when all param keys are optional #6017
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.
Summary
This PR improves the developer experience by addressing issues with parameter typing in the API client:
getCurrentUser
) incorrectly required passing something likegetCurrentUser(undefined)
.listSites
) required passing an empty object, even though no parameters were necessary.These issues are resolved by conditionally setting the params type to either
void
orvoid | Params<{...}>
, depending on the method's parameter requirements.Changes
AreAllOptional
type to check if all keys in a type are optional.IsPathAndQueryOptional
type to check if all parameters for a method are optional.CombinedCaseParams
toParams
for better readability in IDEs.void
for methods with no parameters.void | Params<{...optional params}>
for methods where all parameters are optional.OperationParams
to simplify logic and moved repetitive checks intoExtractPathAndQueryParameters
.Example screenshots
Method with no parameters (
getCurrentUser
):Method with all optional parameters (
listSites
):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)