search

typings / discussions

For discussions and issues with Typings or TypeScript definitions
7 stars 0 forks source link

How to add new typings #13

Open thitemple opened 8 years ago

thitemple commented 8 years ago

Hi I'd like to colaborate with some typings I'm using and I'd like to understand the best way to do it.

Let's say for instance Immutable-js. The project already have the d.ts file, so I don't have to create it. Should I create a repository on github for the typings.json? Or would it be better to add the file to their repository?

Also, in that case, what's the difference between the main and the browser properties for the typings.json?

Finally, in the example used in the docs for the debug.json version file, there's a hash there, I could no find a commit related to that hash? From where that hash came?

Thanks

blakeembrey commented 8 years ago

Let's say for instance Immutable-js. The project already have the d.ts file, so I don't have to create it. Should I create a repository on github for the typings.json? Or would it be better to add the file to their repository?

Their repo is best, Typings is a good fallback - use your own repo for type definitions. This is described https://github.com/typings/registry#contributing.

Also, in that case, what's the difference between the main and the browser properties for the typings.json?

See https://github.com/typings/typings/blob/master/docs/faq.md#how-do-i-write-typings-definitions, it has a formal definition.

Finally, in the example used in the docs for the debug.json version file, there's a hash there, I could no find a commit related to that hash? From where that hash came?

https://github.com/typings/registry/blob/master/npm/debug.json#L3 is https://github.com/typed-typings/npm-debug/commit/0e398cb21de268744dd048a11461be5c13230bad.

thitemple commented 8 years ago

OK, I guess I understand a few things better. I still have some questions. If I'm writing the typings for a package that's only intended to be used on the browser, should I still have the config for main and browser? Both will then point to the same file?

Thanks for the help

blakeembrey commented 8 years ago

Still use main and document that's it's made for browsers. It's pretty much the same approach as NPM packages there. Typings 1.0 will try to tidy up this issue/confusion.