react-scanner icon indicating copy to clipboard operation
react-scanner copied to clipboard

Add TypeScript type definitions

Open mihkeleidast opened this issue 3 years ago • 4 comments

Hi again! As the tool can now be run programmatically, it would be good if there were also type definitions available for those of us trying to run this in a TS codebase.

The options are:

  1. Add type definitions as a separate package in DefinitelyTyped
  2. Add static type definitions in this repository - can be some maintenance burden.
  3. Add type annotations to the code / functions in JSDoc, then extract those with tsc for build/distribution - still a bit maintenance burden, but at least the types would be co-located with the source and would also give some code editor autocomplete helpers.
  4. Rewrite everything in TS (I wouldn't want to do that, seems like too much work TBH 😅).

Any preference towards some of these options?

mihkeleidast avatar Sep 26 '22 06:09 mihkeleidast

Hey @mihkeleidast,

  1. Sounds like a good start.
  2. Doesn't sound that bad to me.
  3. Meh...
  4. That would be great if anyone has the capacity to do it! The codebase is fairly small so shouldn't take too long.

moroshko avatar Sep 26 '22 13:09 moroshko

I would like to attempt the first option if that's alright.

Aleuck avatar Oct 27 '22 12:10 Aleuck

Thank you @Aleuck 🙏

moroshko avatar Nov 01 '22 05:11 moroshko

Got notifications from here, which reminded me that I actually started on the full TS conversion a while ago, but never filed the PR. Did so now to get some early feedback, see #58. Sorry for forgetting, hope we aren't doing too much duplicate work.

mihkeleidast avatar Nov 01 '22 19:11 mihkeleidast