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

Contributing typings #11

Open
willm opened this issue Mar 19, 2016 · 2 comments
Open

Contributing typings #11

willm opened this issue Mar 19, 2016 · 2 comments

Comments

@willm
Copy link

willm commented Mar 19, 2016

I'm interested in contributing some typings to an npm package I maintain. I've started writing it and added it to package.json like this

{
  "typings": "./my-package.d.ts"
}

In order to test it, I've created a separate consuming app and npm linked my package into it. Is there a way to get typings to use the typings in locally linked packages?

Also, once, I'm happy with my typings, will publishing the package with the typings file to npm be enough to make it available to users in typings by doing a typings install my-package?

@blakeembrey
Copy link
Member

If your package has local type definitions, you don't need Typings at all. See https://github.com/Microsoft/TypeScript/wiki/Typings-for-npm-packages.

@blakeembrey
Copy link
Member

And by don't need it, your users don't need to install anything either.

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

No branches or pull requests

2 participants