Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat!: flatten api #10

Merged
merged 5 commits into from
Dec 16, 2024
Merged

feat!: flatten api #10

merged 5 commits into from
Dec 16, 2024

Conversation

achou11
Copy link
Member

@achou11 achou11 commented Dec 16, 2024

Before, we represented options that were passed into the underlying core api as opts object, which resulted in us having awkward opts-nesting our user-facing APIs. Now we flatten and explicitly specify the parameters of interest, which are still internally passed as an options object to the core apis. This is a notable breaking change.

This PR also:

  • updates the TSDoc annotations to better follow TSDoc
  • updates the type annotations to rely less on mirroring types from core internals (e.g. Parameters<typeof ...>

@achou11 achou11 merged commit a47d577 into main Dec 16, 2024
3 checks passed
@achou11 achou11 deleted the ac/api-cleanup branch December 16, 2024 16:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant