Add definitions for TypeScript

[forabi]

This helps IDEs like VS Code and Atom with TypeScript plugins understand the types of different functions and exports and warn about issues with typos/incompatible types... etc

[omnidan]

Thank you for the PR, @forabi 😁 I am not too familiar with typescript, is it normal to start type names with a lowercase character? I think that's a bit confusing (maybe I'm just used to the naming conventions of types in other languages, like Haskell, though).

[forabi]

I'm not too familiar with TS either 😄

Actually this is the first time I use TypeScript in a large project and VS Code kept complaining about the missing definition file. So I had to write it myself and reference it manually.

I thought it might be a good idea to have them in the package itself.

As for the naming of types, I am not sure, I have seen many projects with different naming conventions, some prefix types with a T and interfaces with an I. Some just use a capital letter.

I see your point however, I've updated the PR to keep names consistent.

[omnidan]

@forabi Thanks for the quick response! Looks good to me now 😁

[jfstephe]

@forabi - quick question.... I tried running 'typings install [email protected]' to get the TS definitions but it failed. Can you tell me how are you getting the types?

Many thanks!

[forabi]

@jfstephe You do not need to use typings install, definition files are included in the npm package and they should be automatically picked up by TypeScript language service just by doing npm install redux-undo

[jfstephe]

ah - indeed. I'm using jspm and I think microsoft/TypeScript#6012 is biting me. Thanks for jolting my grey cells :-).

[jessewatson]

Newbie question (typescript related)... I am not seeing any type definitions after an "npm install redux-undo" - it looks like npm is pulling down [email protected] by default. When I tried "npm install [email protected]", it says "invalid" and appears to be the unbuilt source tree.

Do I need to git clone it and build it myself? Are there docs for this?

[omnidan]

@jessewatson did you try installing via npm install redux-undo@beta (as described in the README)?

[jessewatson]

@omnidan - Wow - no idea how I missed that. Thanks!

[omnidan]

@jessewatson no worries 😉 glad it works now 😁