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

Clean up public types #685

Open
sarahdayan opened this issue Nov 30, 2022 · 1 comment
Open

Clean up public types #685

sarahdayan opened this issue Nov 30, 2022 · 1 comment

Comments

@sarahdayan
Copy link
Collaborator

Dinero.js exposes a number of types:

Before going beta, we should ensure that:

  • All public types are relevant
  • There are no duplicates
  • Public types are prefixed (Dinero*) to avoid clashes and improve readability
@sarahdayan sarahdayan converted this from a draft issue Nov 30, 2022
@johnhooks
Copy link
Contributor

johnhooks commented Nov 30, 2022

I learned there is an interesting feature of api-extractor that can help with this, it typically throws an error if the *.api.md doesn't match the code base, though in local development the --local flag prevents this. I accidentally left that flag on, I'll work out the details of how it should work in CI. But after properly implementing it, any function that is public to the api and doesn't have a TSDoc release comment, like @public or @beta, will cause the type declaration rollup process to fail.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🆕 New
Development

No branches or pull requests

2 participants