-
Notifications
You must be signed in to change notification settings - Fork 124
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
Docs: Add best practices for modules to support Typescript #200
Comments
@NickBolles For now there's already https://typescript.nuxtjs.org/cookbook/modules.html
About the steps, IMO an intermediate TypeScript developer already knows how to provide types for a package. Still a module author documentation is relevant. |
@kevinmarrec that cookbook link is for a Typescript - runtime module. What I'm suggesting is for modules such as auth-module, which is written in javascript. Often the authors of these modules don't want to or aren't used to typescript types. Probably not a big use case. but 🤷♂ |
Will add a documentation for modules authors. |
Is your feature request related to a problem? Please describe.
I'm always frustrated when... a module doesn't have clear typescript instructions and/or doesn't have typings
Describe the solution you'd like
A guide to module authors on the best way to implement typings into a module.
Describe alternatives you've considered
Dealing with it and figuring it out myself for each package.
Additional context
I'm currently trying to add types to the auth-module, pull request
I'm basing this PR off of the axios-module, but it would be nice if we had a bit more of a step by step process for module authors to take.
It would be nice to link to a typescript specific guide from here (or maybe just include it on that page too) - https://nuxtjs.org/guide/modules
Steps would look something like
"types": "types/index.d.ts",
to your package.json...anything else?
The text was updated successfully, but these errors were encountered: