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.

Sign up for GitHub

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

Jump to bottom

Document types with typedoc + publish types to npm? #852

Open
saghul opened this issue Jan 24, 2025 · 1 comment
Open

Document types with typedoc + publish types to npm? #852

saghul opened this issue Jan 24, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@saghul
Copy link
Contributor

saghul commented Jan 24, 2025

Rather than this: https://quickjs-ng.github.io/quickjs/stdlib we could ship a .d.ts TypeScript declarations file and use typedoc to render it, and add that as static assets to the docs. Sample typedoc: https://bettercallsaghul.com/txiki.js/api/modules/global.tjs.html

Then the types can be published to npm as @quickjs-ng/types
@bnoordhuis
Copy link
Contributor

Good idea, +1

@bnoordhuis bnoordhuis added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@bnoordhuis @saghul