bttmly
commented
8 years ago Sure thing, documentation contributions would be very welcome! I haven't had time to take a proper stab at it. The best place to start is with the integration tests actually, since there is a working example call for each method.
Next, if you create a directory called responses in the root of your clone, each of the stats methods tests will save a json file there with the full response body, which is handy to refer to. (Run npm test or make test in the root of the project). Finally, I just added a file called test/interactive.js. If you run it with node test/interactive.js, it'll run the tests but then attach a Node REPL where the responses are available so you can interactively play around with their shape. You can find the data by StatsData[methodName] or SportVuData[methodName]
Taking this a step further, it seems doable with the pieces here so far to do some kind of documentation generation -- at least for the simple part of saying "the object looks like this, with this key being a number, this key a string, this key an array of objects that look like such and such". In many cases the responses are pretty comprehensive and it'd be a pain (not to mention extremely error prone) to document them by hand.
brandly
arjunblj
I know you're aware of it, but I figured I'd open the issue.
One thing I think would be nice is including an example of the options under a method, so you can see how to call the method, but also click the URL to view an actual response.
Most of my use has been reading stats-endpoints, and then logging out responses to see what data I'm working with. If you're open to it, I could follow this workflow and write some docs. Let me know what you think!