Add TypeScript definition file

[philschatz]

This adds a TypeScript definition file (see ./types/index.d.ts) for Octokat.

You can test it out by doing the following:

• copy the ./types/index.d.ts file into your project by putting it in /local-types/octokat/index.d.ts
• add the following to /tsconfig.json:

{
  "compilerOptions": {
    "typeRoots": [
      "./local-types/"
    ],
...

TODO

• offer dot-completion (ie octo.repos('philschatz', 'octokat.js').issues(3).comments)
• validate all arguments to all the verb methods (ie .fetch(...), .update(...))
• yield a typed result when the Promise is resolved (instead of Promise<any>)
  • this last item requires manually documenting the result of each request
• generate the Regular Expression validator from the JSON files
• generate the list of valid children from the JSON files (the repos and issues in octo.repos(...).issues.fetch()
• maybe write the autogenerated tests in TypeScript (to get some typechecking for free!)

Examples

This shows that the request is typed (via dot-completion in Atom):

This shows that the server response is also typed (via dot-completion in Atom):

[azu]

Can you add types field like "types": "./types/index.d.ts"?

Including declarations in your npm package
https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html

[philschatz]

Thank you for catching that oversight. Updated 😄

[atrauzzi]

What's the current status of this? Would love to see typing information available!

[romdim]

Any update on this? I tried it now and it fails (types are not consistent with the actual commands)