[RFE] Add TypeScript Support - Githubissues

mitchwadair / tesjs

Streamline your Twitch EventSub JavaScript integration with TESjs

https://www.tesjs.net/

MIT License

29 stars 5 forks source link

[RFE] Add TypeScript Support #39

Open mitchwadair opened 3 years ago

mitchwadair commented 3 years ago

Is your feature request related to a problem? Please describe. A lot of people might use TS to develop their applications.

Describe the solution you'd like TES should support that by providing type definitions for TES functions. This would be provided through DefinitelyTyped. Maintaining these types will probably be a bit of a pain as EventSub is updated, but not a huge deal. Some examples of things that would need to be added:

Every subscription type
Condition types for subscriptions
Payloads
Subscriptions
etc

mitchwadair commented 2 years ago

Might be able to avoid publishing to DefinitelyTyped by just including a .d.ts file and adding the types key in package.json See: https://betterstack.dev/blog/publishing-type-definitions-with-npm-package/#heading-including-type-definitions