glitchdotcom / friendly-words

The Glitch word list, packaged into an NPM module for easy use.
https://friendly-words.glitch.me
MIT License
309 stars 44 forks source link

Add TypeScript type declarations #36

Open netsgnut opened 3 years ago

netsgnut commented 3 years ago

Thank you for the library! We are using it to generate a random name for user-generated lists for a client project.

We are using TypeScript in our project. Since this library does not come with type declarations, we are using a local declaration file for the library. However, since it may be useful for other TypeScript users, we decide to make a PR :)

To the library users, the typings would be automatically recognized without additional work when they use TypeScript. What it takes is a .d.ts file, and a declaration in the package.json.

Please let me know if that is a good idea for you. Thanks!