Here's a first pass, I've merely generated the d.ts from jsDoc and haven't had time to play with the definition beyond that: https://github.com/aendrew/github/tree/d.ts

The declaration itself is at:

https://github.com/aendrew/github/blob/d.ts/github-api.d.ts

There are a bunch of errors being thrown, given that tsd-jsdoc doesn't validate jsDoc comments.

jsDoc comments that will need to be fixed:

ln. 1078, "Requestable.callback"
@param {(Object|true)} needs to be something like @param {GitHubAPIResponse|boolean} or any
@param {Object} needs to be something like a GitHubAPIRequest interface or any
This is probably one of the more difficult ones to resolve correctly. It's possible that we could piggyback on Axios' TypeScript defs for this; instead of Object, we could use Axios.AxiosResponse. The biggest problem with this is it's generated within the class definition, which is a known bug; see Issues in generated files englercj/tsd-jsdoc#6.
ln. 1135, "Search.Params"
Object is not a valid TypeScript type. Needs an interface.
lns. 544, 553, 809, 819, 1015, "variable-name" conflict
Argument should be renamed to something not reflecting a primitive.
ln. 789 , "Repository.createBranch"
For some reason it's inferring this as an optional param, which can't go in front of required parameters. I think removing [oldBranch=master] from the doccomment will fix this.
ln. 935, "Repository.writeFile"
cb should be in square brackets if it's optional.
ln. 1109, "Requestable._requestAllPages"
results should either be optional, or private methods shouldn't have a declaration generated.
ln. 1404, "interface Iauth"
token is not a valid type. Just change the type to string.
Throughout "Generic type Promise requires 1 type argument(s)"
Instead of just returning a promise, what the promise resolves must also be included. Replacing Promise with axios.Promise solves this.

On a whole, though, y'all done a crazy-good job of documenting everything, am semi-surprised everything worked this well!

I'll probably write a mass PR in the next few days that resolves all of the above and lets tsd-jsdoc generate the TS declaration cleanly, followed by one that resolves this issue by adding the build setup I use in that branch.

Add a TypeScript definition #241

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions