Skip to content

Any chance for bundled TypeScript definitions? #88

Description

@Zamiell

Greetings, and thanks for the excellent library.

The year is 2020, and large swaths of the internet are migrating their existing JavaScript projects to TypeScript, and starting new projects with TypeScript.

I am using luaparse in a new project with TypeScript, and it seems that the TypeScript definitions provided at @types/luaparse are out of date, making for a frustrating experience when using this library for the first time.

I am also noticing that the lua-fmt project does not use the DefinitelyTyped definitions and instead uses a custom definitions file written by hydroper. After trying these definitions out, they do seem to be accurate (from what I can tell), and they will get the job done for the time being.

Going forward, it would be fantastic if luaparse could contain native TypeScript definitions in this repository - this would make using the library with TypeScript a seamless experience, meaning that the end-user would not have to install anything external. (With the rise of TypeScript over the past few years, this kind of thing is common for JavaScript libraries to do.)

Of course, maintaining a TypeScript definitions file is a little bit of an extra maintenance burden for fstirlitz & the other maintainers of the project (e.g. it would have to be updated if the API ever changes), but I figured it wouldn't hurt to ask nicely.

Any chance that we could get bundled/native TypeScript definitions?

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementRequest for functionality covering an entirely new use casequestionGeneral question regarding the project

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions