js-api-client icon indicating copy to clipboard operation
js-api-client copied to clipboard

[WIP]refactor: add jsdocs

Open MichaelSolati opened this issue 7 years ago • 3 comments

So this would be the first PR. All that has been done is jsdocs have been added so you get an explanation for each function as well as hinting for the params/args. I still opted to turn each object into a class as the passing of functions made it difficult to neatly have the jsdocs and param types appear in the intellisense.

MichaelSolati avatar Jan 31 '19 02:01 MichaelSolati

Realized a little problem (forgot I was writing JS not TS, will fix later tonight)

MichaelSolati avatar Jan 31 '19 04:01 MichaelSolati

@jepser ready for your reviewing pleasure

MichaelSolati avatar Jan 31 '19 20:01 MichaelSolati

Sorry if you feel blocked @MichaelSolati , but can we separate the concern of each one of the thing you're doing?

  1. Adding JS docs
  2. Updating deps

After that, good work adding docs to our methods 💥

jepser avatar Feb 13 '19 11:02 jepser