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

Ship types with the npm package #435

Open
Uzlopak opened this issue Jun 29, 2023 · 0 comments · May be fixed by #436
Open

Ship types with the npm package #435

Uzlopak opened this issue Jun 29, 2023 · 0 comments · May be fixed by #436

Comments

@Uzlopak
Copy link
Contributor

Uzlopak commented Jun 29, 2023

Context

  • node version: not applicable
  • module version: 5.0.0
  • environment (e.g. node, browser, native): not applicable
  • any other relevant information:

What problem are you trying to solve?

Follow up for #334

It would be nice, if the typings would be shipped with the code. I know you decided to maintain the code by the community of definetly typed, as stated in #342 (comment) . But if it is with the package, we could easily refer them in typings, which are using them too, like in @fastify/simple-oauth2.

See fastify/help#900 (comment)

At fastify we ship the typings with the npm package, and test the typings with tsd. Pull Requests in fastify packages need corresponding typing changes if applicable. This way, you could ensure, that the typings are always in sync with the code.

3 years have passed since the last decision regarding this topic, so maybe you reconsider it.

Do you have a new or modified API suggestion to solve the problem?

I will provide a simple PR.

@Uzlopak Uzlopak linked a pull request Jun 29, 2023 that will close this issue
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 a pull request may close this issue.

1 participant