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 Definitions #19

Open
christianliebel opened this issue May 18, 2021 · 5 comments
Open

TypeScript Definitions #19

christianliebel opened this issue May 18, 2021 · 5 comments

Comments

@christianliebel
Copy link
Contributor

If it's helpful for further development, I've created TypeScript definition files based on the current WebIDLs here: https://github.com/christianliebel/handwriting-textarea/blob/main/handwriting-recognition.d.ts

Just wanted to bring this to your attention, feel free to close this issue right away. 😇

@wacky6
Copy link
Member

wacky6 commented May 19, 2021

Awesome! Thanks for contributing.

Do you mind if I put a link to this d.ts file in README?

Also, graphemeSet is in Web IDL now. You can uncomment that line in TS definition.

@christianliebel
Copy link
Contributor Author

Do you mind if I put a link to this d.ts file in README?

@wacky6 Sure, no problem!

You can uncomment that line in TS definition

Done.

@wacky6
Copy link
Member

wacky6 commented May 19, 2021

Thanks.

My collegues suggest we should try to upstream TS definitions to DefinitivelyTyped repository after the API is more stable. We prefer to not upstream it now, in case this API get too popular and make it hard for us to iterate on the design.

Are you willing to stay updated about API changes, and update the definition in the future?

@christianliebel
Copy link
Contributor Author

christianliebel commented May 19, 2021

My collegues suggest we should try to upstream TS definitions to DefinitivelyTyped repository after the API is more stable. We prefer to not upstream it now, in case this API get too popular and make it hard for us to iterate on the design.

Looks like typings for DOM APIs should go here and would automatically be generated from WebIDLs provided by Microsoft Edge. But I'm not sure at which stage APIs are included there. So it looks as if the typings from above would only fill in the gap until the API is generally available on Edge one day.

Are you willing to stay updated about API changes, and update the definition in the future?

Yes.

@wacky6
Copy link
Member

wacky6 commented May 20, 2021

Oh. Interesting. It seems we need to wait until the spec is "mostly" finalized before we can generate d.ts automatically. Let's keep the hand-crafted d.ts around for now.

We'll keep you updated of the API changes.

Thanks for your contribution!

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

2 participants