It is time we see better documentation for the Javascript API.

in #hive4 years ago (edited)

It is time that the documentation located at
https://github.com/steemit/steem-js/tree/master/doc
were added to. For both Steem and Hive. Indeed even for Whaleshares and Golos, development is hindered because we only have as much documentation as a C header file without comments.

Here is an example from this page

steem.api.getDiscussionsByActive(query, function(err, result) {
  console.log(err, result);
});

Nothing about what result is supposed to be. Is result an array of strings or an array of some structure? If it is a structure what are the members of said structure? What is query? Is it a search string? Is it a regular expression? How is it used? Is it searching the author, title, or tags?

Please see this post on your current site or here on Steemit , which I use for reference and maintain.

Coin Marketplace

STEEM 0.17
TRX 0.15
JST 0.027
BTC 60678.52
ETH 2339.38
USDT 1.00
SBD 2.48