Skip to content

Feature Request: TypeScript type definitions #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
bb opened this issue Mar 29, 2018 · 1 comment · Fixed by #71
Closed

Feature Request: TypeScript type definitions #69

bb opened this issue Mar 29, 2018 · 1 comment · Fixed by #71

Comments

@bb
Copy link
Contributor

bb commented Mar 29, 2018

Hi there,
it would be great if fast-xml-parser had typescript support.

Would you be willing to include types directly here? The advantage would be that users wouldn't need manually install types.

Another option would be externally, e.g. similar like xml2js: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/xml2js.
Users would then need to install the types package manually as described here: https://www.npmjs.com/package/@types/xml2js
Another disadvantage is that the types might become out of sync with the code more easily.

What way would you prefer, if any?

@amitguptagwl
Copy link
Member

I've less knowledge of how TypeScript type definitions actually works at this moment. However I was also thinking to include them.

In my opinion type definition should be bundled with the project so the user need not to install any extra dependency and for easy maintenance as well.

amitguptagwl added a commit that referenced this issue Apr 2, 2018
first draft of typings for typescript #69
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants