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.

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

Any typings / d.ts files for sywac? #70

Open
jose-pr opened this issue Jun 3, 2020 · 4 comments
Open

Any typings / d.ts files for sywac? #70

jose-pr opened this issue Jun 3, 2020 · 4 comments
Labels
Hacktoberfest Welcome to Hacktoberfest participants! help wanted

Comments

@jose-pr
Copy link

jose-pr commented Jun 3, 2020

Are there any typings available for easier autocomplete and use with typescript for this sywac?

@nexdrew
Copy link
Member

nexdrew commented Jun 3, 2020

Not that I know of. Would you be able to help contribute some?

@jose-pr
Copy link
Author

jose-pr commented Jun 3, 2020

Will try to.

@jose-pr
Copy link
Author

jose-pr commented Jun 5, 2020

Not that I know of. Would you be able to help contribute some?

So i gave it a try and have some basic typing, more works needs to be done cleaning it up and chaining the type of the Api as new properties are added to it.
Did it by rewriting it on ts as it was easier to find errors when something was not typed correctly and for now ignoring/dont paying to much attention to private methods. Didnt do typing for utils and buffer.

Typings avaliable at: https://github.com/jose-pr/sywac under the @types folder
Also if the interface are documented better in code you get some nice documentation out of it too for free
https://jose-pr.github.io/sywac/index.html

As i get some more time i may work on it more.

@elliot-nelson elliot-nelson added Hacktoberfest Welcome to Hacktoberfest participants! help wanted labels Oct 1, 2020
@elliot-nelson
Copy link
Member

Although the maintainers aren't focused on TypeScript typing for Sywac right now, this is a feature that's very useful to people who have a need to write their CLI in TS. If folks out there have a passion for working on these types, feel free to take a look.

(The final home for typing would probably be in the @types project, not Sywac itself, however, unless someone presents a compelling case otherwise.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Hacktoberfest Welcome to Hacktoberfest participants! help wanted
Projects
None yet
Development

No branches or pull requests

3 participants