[WIP] Awesome API Documentation #469
Conversation
| * | ||
| * @memberof Api# | ||
| * | ||
| * @example |
There was a problem hiding this comment.
As I understand our previous discussions, examples should make use of callbacks, not promises.
There was a problem hiding this comment.
feel free to change
| * @alias add | ||
| * @method | ||
| * @param {(Buffer|Stream|Array<Buffer|Stream>)} files - The content to add. | ||
| * @param {function(Error, {hash: string})} [callback] |
There was a problem hiding this comment.
Don't we get the file in the callback rather than a String with the hash?
There was a problem hiding this comment.
Add only returns the hash as far as I know
src/index.js
Outdated
| * // or using options | ||
| * const ipfs = ipfsAPI({host: 'localhost', port: '5001', procotol: 'http'}) | ||
| */ | ||
| function Api (hostOrMultiaddr, port, opts) { |
There was a problem hiding this comment.
Why this changed to just Api from IpfsAPI? Having ipfs in the name helps when dealing with stacktraces
There was a problem hiding this comment.
can't remember, feel free to change back
src/index.js
Outdated
| * | ||
| * @constructor Api | ||
| * @param {string} hostOrMultiaddr | ||
| * @param {number} port |
There was a problem hiding this comment.
Param says number but example is using string
daviddias
added
ready
difficulty:moderate
help wanted
P1 - High
and removed
backlog
labels
|
Closing as this PR is significantly out of date and unlikely to be completed. |
Ref ipfs/js-ipfs#615
Preview: https://ipfs.github.io/js-ipfs-api/