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] Add typing system to matrix-js-sdk and matrix-appservice-bridge #13

Closed
huan opened this issue Jul 7, 2019 · 3 comments
Closed
Labels
enhancement New feature or request

Comments

@huan
Copy link
Member

huan commented Jul 7, 2019

I had spent around two full days to study the document and write the typings for matrix-appservice-bridge & matrix-js-sdk.

With the typing system, it helped me a lot for learn the API and prevent lots of potential bugs. I think it's worth to publish them, the best will be integrated into our npm module.

The typing definition is still working in progress and heavy developing, you can watch it at https://github.com/huan/matrix-appservice-wechaty/blob/master/src/typings.

I'll create a pull request to add the typing to their repository after I get this project done, and any suggestion will be welcome by leaving comments under this issue.

@Half-Shot

See Also

Thanks!

@huan
Copy link
Member Author

huan commented Feb 27, 2020

Just sent the PR for typing for Matrix JS SDK (matrix-js-sdk) to DefinitelyTyped.

See: DefinitelyTyped/DefinitelyTyped#42673

@huan
Copy link
Member Author

huan commented Feb 27, 2020

And have sent a PR for typing for Matrix AppService Bridge (matrix-appservice-bridge) to DefinitelyTyped.

See: DefinitelyTyped/DefinitelyTyped#42702

@huan
Copy link
Member Author

huan commented Mar 2, 2020

That two PR are all merged to the DefinitelyTyped repository.

now we can use @types/matrix-js-sdk and @types/matrix-appservice-bridge by npm install:

npm install @types/matrix-js-sdk @types/matrix-appservice-bridge -D

@huan huan closed this as completed Mar 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant