Update js sdk for argument consistency #73
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.
The JavaScript SDK was refactored to remove all usages of the spread operator (
...
) and replace them with explicit argument passing. This change aligns the SDK with the Python SDK's recent updates, improving forward compatibility and type safety by preventing accidental property passing from API responses to requests.Key changes include:
src/index.ts
):search()
,searchAndContents()
,findSimilar()
,findSimilarAndContents()
, andgetContents()
methods now explicitly assign each option property (e.g.,numResults
,includeDomains
,text
) to the payload object instead of using the spread operator.extractContentsOptions()
helper function was refactored to manually extract content-specific properties and buildrestOptions
using a loop andSet
-based filtering, avoiding destructuring with spread.listAll()
insrc/websets/client.ts
andsrc/websets/items.ts
now explicitly assignscursor
andlimit
pagination options.listAll()
andlistAllAttempts()
insrc/websets/webhooks.ts
explicitly assigncursor
,limit
, andeventType
pagination options.This refactoring ensures the SDK remains robust when new fields are introduced in API responses and enhances type checking. The changes maintain the existing public API interface.