Tsdocs.dev: Type docs for any JavaScript library
1–10 of 39 posts
Re: Tsdocs.dev: Type docs for any JavaScript library
#2Looks like rust inspired (docs.rs) but for the typescript ecosystem. Neat!
Re: Tsdocs.dev: Type docs for any JavaScript library
#3A good example of a well documented library is three.js
https://tsdocs.dev/docs/three/0.159.0/classes/Bone.html
It’s fun to just read through all of the different entities in the 3D ecosystem, even though I’ve only used it only a couple of times.
Re: Tsdocs.dev: Type docs for any JavaScript library
#4It might have just received the hug of death. Otherwise, this is fantastic; I've been looking for something like this.
Re: Tsdocs.dev: Type docs for any JavaScript library
#5Author here:
I created this because I found myself peeping inside type declaration files too often, and the only way to do that was by installing the package first.
tsdocs.dev helps you check the API surface of a good number of JS libraries and their past versions — usually a quick search away.
There's something powerful about speed and being able to answer questions in seconds that usually take minutes.
edit: The server might be overloaded with requests as we prime up our caches, but do visit back after HN's done hugging us to death.
You can show your support and help cover a part of server costs if this (or bundlephobia.com) saved you time.
Re: Tsdocs.dev: Type docs for any JavaScript library
#6A good example of a well documented library is three.js https://tsdocs.dev/docs/three/0.159.0/classes/Bone.html It’s fun to just read through all of the different entities in the 3D ecosystem, even though I’ve only used it only a couple of times.
Agreed although I'm somewhat confused since the three js source code is JavaScript not TypeScript.
Re: Tsdocs.dev: Type docs for any JavaScript library
#7Some quick bits of feedback after a small bit of skimming (between bad gateway errors, sorry for contributing to all the over-traffic):
- It would be great to see some of the fields from package.json shown as an overview above/next to the README of packages. The homepage and repository fields in particular are often quite useful to have quick access to. You could pull up npmjs.com directly next to this site, but it might be nice to have it all in one place.
- In cases where there is an auto-redirect from package-name to @types/package-name it might be nice to still show the README (and package.json metadata if added) of the original package-name.
- Typedoc upstream includes a dark theme and does the prefers-color-scheme auto-setup. This might be nice to have here, too.
Re: Tsdocs.dev: Type docs for any JavaScript library
#8A good example of a well documented library is three.js https://tsdocs.dev/docs/three/0.159.0/classes/Bone.html It’s fun to just read through all of the different entities in the 3D ecosystem, even though I’ve only used it only a couple of times.
Agreed although I'm somewhat confused since the three js source code is JavaScript not TypeScript.
It is auto-redirecting to the @types/three package and getting the types from DefinitelyTyped. You can see that in the breadcrumbs, but it might be something that could be better highlighted (and maybe even redirect the URL to make even more obvious to developers).
Re: Tsdocs.dev: Type docs for any JavaScript library
#9Author here: I created this because I found myself peeping inside type declaration files too often, and the only way to do that was by installing the package first. tsdocs.dev helps you check the API surface of a good number of JS libraries and their past versions — usually a quick search away. There's something powerful about speed and being able to answer questions in seconds that usually take minutes. edit: The se…
Congrats, this looks fantastic and will be useful for many!
Re: Tsdocs.dev: Type docs for any JavaScript library
#10Some quick bits of feedback after a small bit of skimming (between bad gateway errors, sorry for contributing to all the over-traffic): - It would be great to see some of the fields from package.json shown as an overview above/next to the README of packages. The homepage and repository fields in particular are often quite useful to have quick access to. You could pull up npmjs.com directly next to this site, but it m…
> it might be nice to still show the README (and package.json metadata if added) of the original package-name
This would be great, @types/* docs are rarely ever useful. Although it'd be still nice to indicate that the types are not available in the original package.