Add JSDoc to typings for better DX in IDEs

[MarkPollmann]

Describe the feature you'd like:

If I start typing library functions in VS Code all I see in the IntelliSense tooltip is the import statement:

As far as I know this could be easily fixed by adding JSDoc in the typings/index.d.ts file so the developer quickly sees a short overview of what this function does and which parameters are expected.

Suggested implementation:

I can start annotating the exported functions 🙂

Describe alternatives you've considered:

Teachability, Documentation, Adoption, Migration Strategy:

[kentcdodds]

Sounds good to me!

Though you should know that we no longer export Simulate :)

[MarkPollmann]

Oops, I confused myself reading the docs and watching your course on FEM in parallel 😅

[kentcdodds]

My bad 😅

[MarkPollmann]

If anyone with more experience in this wants to contribute, feel free to comment here. Else I'm going to take a stab at it on the weekend.