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.
This takes a big burden off of individual packages from publishing their own API docs (having done that I know how hard it can be!), and having a centralized API viewer can offer a lot of advantages over separate docs.
A couple of things I would suggest:
1. Track re-exports and cross-package references and allow crossref links to go into other packages. If package A uses rxjs, then links to the rxjs types should go to the canonical definitions in the rxjs package. (figuring out the canonical declaration can be tricky because it's not always the original declaration though)
2. Organizing by type isn't always a great introduction or way to navigate a package. On the Lit project at https://lit.dev/docs/api we re-organized the API docs by categories and the most important API surfaces. There aren't standard jsdocs for this, but a few straightforward things like @category could be used to offer an alternate top-level nav for a package. Also consider supporting the @packageDocumentation tag from tsdoc.
3. Consider showing files other than the README. Relative links to things like CONTRIBUTING.md currently break. Alternatively interpret all relative links as pointing to github.com or npmjs.com. It'd be great to have a way to link from the README into API docs to guide readers. The community doesn't have a great convention for this unfortunately.
> 1. Track re-exports and cross-package references
This should already be tracked — play around with the member visibility widget on the sidebar for e.g. For convenience, I've inlined the types from re-exports, but might be a good idea to indicate they were re-exported.
Pointing to the canonical source can also limit the usefulness in a few cases (e.g. d3 is just a bunch of re-exports), and users may not care about internal package organization.
> 2. consider supporting the @packageDocumentation tag
Organizing by @category and @packageDocumentation should already be supported. e.g. See the functions in —
https://tsdocs.dev/docs/lodash-es/4.17.21/index.html
Found a fun error "TypeDefinitionResolveError" for a package that includes Typescript sources. Best guess, it may be related to the package.json uses a modern "bare" exports field ("exports": "./index.js"; no "main", no "types") where "index.ts" exists in the package as well. (Not a lot of projects use this today, but it is a modern way to publish projects that will likely increase.)
Typescript itself works just fine with this with this type of package with "moduleResolution": "node" (tsconfig/CLI options) with recent version using recent enough ES targets or with "moduleResolution": "node16" in older versions/older ES targets/non-ES targets.
But we have an outdated system for general use, which is similar to what you have built: https://doc.deno.land/.
Did you know about this, and did you want to built your own system regardless, or did you not know about it and would this have been something you would have used instead of creating your own system?
Does this service do anything different/better than jsdocs.io?
I like the way jsdocs.io puts everything on one page.
I was initially confused when I looked up a package on tsdocs.dev and just got the readme. The actual type defs were tucked away out of sight in the hamburger menu. May just be a problem with the mobile site.
Hi, nice site! I found a small ux issue on ios: the search field has capitalization on by default. It can be turned off with https://stackoverflow.com/a/5171812
I attempted to build this a number of years ago but quickly got frustrated with the inconsistency of how packages are laid out and the unreliability of the information in package.json. Good job if you sorted it out though.
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.
https://github.com/sponsors/pastelsky