Improve documentation #24
Description
vinyldns-js now has documentation generated by source code comments. However, in some cases, the documentation should be improved a bit. For example, the getBatchChanges method lacks details surrounding how the queryOpts argument should appear when present:
getBatchChanges(queryOpts)
Get batch changes.
getBatchChanges(queryOpts: any)
Parameters
queryOpts (any)
Ideally, the documentation should include details on what type of data queryOpts is (it's an object), as well as what properties -- and their types -- it supports. This is true for documentation beyond getBatchChanges as well.