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

Improve ts.d documentation of Decomposition/Augmentation #19377

Closed
gwicksted opened this issue Oct 20, 2017 · 1 comment
Closed

Improve ts.d documentation of Decomposition/Augmentation #19377

gwicksted opened this issue Oct 20, 2017 · 1 comment
Labels
Docs The issue relates to how you learn TypeScript

Comments

@gwicksted
Copy link
Contributor

Problem: it is complex to write a definition file for certain (very simplistic) js libs.

It is a weak point in the type definitions that, if not addressed by upcoming language features, should be more accessible in docs.

The concept of Decomposition/Augmentation needs more visibility in at least one of the Documentation pages since it's quite abstract.

Google usually links to the Modules docs when looking up info related to exports or ambient modules. Those docs are not that useful for authoring type definitions so it would be nice to link to the deep dive.

In #19372 @DanielRosenwasser offered a really good link that I don't think is part of the official docs (it should be a link at the very least!)

Unfortunately the bottom of the link mentioned above returns a 404

Example of a missing definition: gulp is quite popular and uses pumpify npm which uses this style of js. Yet pumpify does not have a DefinitelyTyped entry. Why not? Sure, it's not used that often but it likely has a lot to do with the difficulty of authoring the definition.

@mhegazy mhegazy added the Docs The issue relates to how you learn TypeScript label Oct 23, 2017
@RyanCavanaugh
Copy link
Member

This doesn't seem actionable, nor a common complaint -- DT has 14,000+ contributors and nearly 7,000 types, so it can't be that hard to find a definition file for a library similar to the one being typed and crib from it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs The issue relates to how you learn TypeScript
Projects
None yet
Development

No branches or pull requests

3 participants