Live data from Hacker News

Tsdocs.dev: Type docs for any JavaScript library

tsdocs.dev

21–30 of 39 posts

Re: Tsdocs.dev: Type docs for any JavaScript library

#23

Author 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…

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.

Re: Tsdocs.dev: Type docs for any JavaScript library

#25

Author 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…

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

Re: Tsdocs.dev: Type docs for any JavaScript library

#26
Looks like a great initiative – I wish there was a reliable TS/JS equivalent of https://docs.rs (even considering rustdoc's deficiencies[1]).

I went through this exercise recently and so far my experience with trying to produce documentation from a somewhat convoluted TS codebase[2] has been disappointing. I would claim it's a consequence of the library's public (user-facing) API substantially differing from how the actual implementation is structured.

Typedoc produces bad results for that codebase so sphinx-js, which I wanted to use, doesn't have much to work with. I ultimately documented things by hand, for now, the way the API is meant to be used by the user.

Compare:

https://ts-results-es.readthedocs.io/en/latest/reference/api...

vs

https://tsdocs.dev/docs/ts-results-es/4.1.0-alpha.1/index.ht...

https://www.jsdocs.io/package/ts-results-es#package-index

[1] https://github.com/rust-lang/rust/issues/66249

[2] https://github.com/lune-climate/ts-results-es

Re: Tsdocs.dev: Type docs for any JavaScript library

#27

Author 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…

This is useful, the search especially.

There's a bug that only happens on this page [1]?

    Uncaught TypeError: Failed to execute 'observe' on 'MutationObserver': parameter 1 is not of type 'Node'
[1] https://tsdocs.dev/docs/svelte/4.2.8/functions/_svelte_compi...

Re: Tsdocs.dev: Type docs for any JavaScript library

#29

Author 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…

Hey, Leo from Deno here.

We recently released a static HTML documentation generator via our `deno doc` subcommand.

We also have a similar system for our registry (here an example: https://deno.land/std@0.209.0/http/mod.ts?s=Server).

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?

Re: Tsdocs.dev: Type docs for any JavaScript library

#30

Author 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…

Hey, Leo from Deno here. We recently released a static HTML documentation generator via our `deno doc` subcommand. We also have a similar system for our registry (here an example: https://deno.land/std@0.209.0/http/mod.ts?s=Server ). 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 regar…

Cool, fwiw I didn't know about the general use and I use deno heavily, here's a comparison of Three.js:

Deno Doc: https://doc.deno.land/https://esm.sh/v135/@types/three@0.159...

TSDocs.dev: https://tsdocs.dev/docs/three/0.159.0/modules.html

The search UX and documentation UI of TSDocs is better. The availability of Deno is better atm.

Though TSDocs was speedier and a better flow when it was working.

Post reply on HN