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

TypeScript support #17

Open
climba03003 opened this issue Apr 17, 2024 · 2 comments · May be fixed by #18
Open

TypeScript support #17

climba03003 opened this issue Apr 17, 2024 · 2 comments · May be fixed by #18
Labels
enhancement

Comments

@climba03003
Copy link

I have a suggestion:

The finial bit before I can use this library is missing the type declaration file.
The JSDoc is very clear in usage, but TypeScript doesn't pick that up.
@dr-dimitru
Copy link
Member

@climba03003 thank you for the suggestion. Perhaps there's a tool to generate TS declarations out of JSDoc? Looking at this doc it seems to be pretty easy, anything else what you would recommend?

@climba03003 climba03003 linked a pull request Apr 18, 2024 that will close this issue
Open
@climba03003
Copy link
Author

Perhaps there's a tool to generate TS declarations out of JSDoc? Looking at this doc it seems to be pretty easy, anything else what you would recommend?

Yes, it is pretty good since you already have JSDoc.
I don't think it is feasible to auto the process but good for initial run.

I have update some part like hide the internal function, import proper library, etc in #18

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

👨‍💻 Add types declaration file climba03003/josk
2 participants
@dr-dimitru @climba03003