-
In my case: Clarify return types explicitly · fabon-f/vremel@50d2963 · GitHub
-
SaaSHub
SaaSHub - Software Alternatives and Reviews. SaaSHub helps you find the best software and product alternatives
-
JavaScript (TypeScript) ecosystem has various types of API docs generators. Maybe the most popular one is TypeDoc. While generating API docs itself is easy, hosting API docs is pretty hard. Publishing generated HTML to static hosting service like GitHub Pages is the method I adopted previously, but it's not an ideal solution because we can't view docs for older versions.
-
JSR uses Deno's document generator (deno_doc), which is under development and doesn't support all JSDoc tags yet3. So your JSDoc comment can be showed differently from your intention. You can run deno doc --unstable-sloppy-imports --html path/to/entrypoint.ts to check how generate docs will look.
-
I'm developing vremel, an utility library for Temporal API (similar to date-fns for Date). It's a pure ESM package1 and written in TypeScript.
-
JSR is a new package registry for JavaScript, which has compatibility to npm. JSR supports ES modules and TypeScript by default.
-
Now JSR have changed this situation. After publishing the package, we can view API docs of each version (similar to docs.rs in Rust or pkg.go.dev in Go). All we have to do is to write few lines of JSON. Optionally you can publish a package from GitHub Actions by adding only few lines to a workflow file. Any other setup (install packages, write config for document generator...) is not needed.
-
I'm developing vremel, an utility library for Temporal API (similar to date-fns for Date). It's a pure ESM package1 and written in TypeScript.