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

Typescript bindings #74

Open
xkr47 opened this issue Sep 13, 2019 · 6 comments
Open

Typescript bindings #74

xkr47 opened this issue Sep 13, 2019 · 6 comments

Comments

@xkr47
Copy link

xkr47 commented Sep 13, 2019

I'm offering to write either typescript bindings for this project or convert it to use typescript. Both options would retain all the Javascript apis as-is. Would you consider either if provided as a PR?

@timabbott
Copy link
Member

timabbott commented Sep 14, 2019 via email

@xkr47
Copy link
Author

xkr47 commented Sep 14, 2019

@timabbott which way, convert source to Typescript or keep typings as separate file?

@aero31aero
Copy link
Member

We should convert the source to typescript and in the publishing process, create a index.d.ts file to provide type declarations for our compiled js module.

I think a good way would be to simply add tsc in our build process without making changes and then convert our js files one by one to ts.

@xkr47
Copy link
Author

xkr47 commented Sep 14, 2019

Ok, I will try! 😃

@aero31aero
Copy link
Member

Thanks @xkr47! I'm not well versed in TS yet but I'm happy to review any PRs and test changes.

@tcarrio
Copy link

tcarrio commented Jan 4, 2020

I've been taking a look at making the TypeScript definitions for the project and just noticed this issue was opened awhile back. Seems like it's still open to be worked on and thought I'd ask about interest again.

Would you be interested in just type definitions or would you want to convert the project over to TypeScript entirely? I can provide a PR of the current work done in this regard, which has been just the TypeScript definitions themselves, following the structure of the project pretty closely to allow a faster conversion to TypeScript completely if you were interested.

Most of the work has been done based on the documentation on the Zulip site, but it also covers all of the functions and variables exported from the package as well, at an individual file level. I'll open a PR marked as WIP that shows where it is at now with just the type definitions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants