Skip to content

TypeScript type definitions not available #135

@fcrick

Description

@fcrick

Not really your problem, per say, but if libraries maintain their own type definitions they tend to stay in sync better than ones provided separately. This would be a big help for fengari, specifically, as the API is quite large, and already has great documentation, so getting all that info to show up in tooling and be type checked would mean a big gain for not much work.

Usually the process is something like:

  1. Add something like "types": "types/index.d.ts", to package.json and make sure it's included in the published package.
  2. Add types/index.d.ts with all the types.

Alternatively, the types can be published separately as the package @types/fengari. I'm not exactly sure what the process around that is but it looks like these are added via pull requests to https://github.com/DefinitelyTyped/DefinitelyTyped

I might try to get this started at some point if time permits.

Thanks for making fengari! I think I'll find it incredibly useful.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions