Skip to content

Add TypeScript type definitions #55

Open
@mihkeleidast

Description

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?

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions