docs: change config.get() to object #343
Conversation
ghost
assigned 
hacdias
changed the title
|
@diasdavid @alanshaw what do you think? 😄 |
| @@ -14,7 +14,7 @@ | |||
|
|
|||
| `key` is the key of the value that should be fetched from the config file. If no key is passed, then the whole config should be returned. `key` should be of type String. | |||
|
|
|||
| `callback` must follow `function (err, config) {}` signature, where `err` is an error if the operation was not successful and `config` is a JSON object containing the configuration of the IPFS node. | |||
| `callback` must follow `function (err, config) {}` signature, where `err` is an error if the operation was not successful and `config` is an object containing the configuration of the IPFS node. | |||
There was a problem hiding this comment.
Are you saying that the config is not pure JSON?
There was a problem hiding this comment.
The config is a JavaScript object, which can be stringified to JSON. I believe a js object is more handy.
Please see ipfs-inactive/js-ipfs-http-client#822 and ipfs-inactive/js-ipfs-http-client#825 😄
Right now, the API returns a Buffer for go-ipfs and an object for js-ipfs.
The js-ipfs core seems to return an object too and not a Buffer.
Hence my suggestion to return an object everywhere. Otherwise the API will behave differently with js-ipfs and go-ipfs.
There was a problem hiding this comment.
It should be an object everywhere. What we mean by it being a JSON object is that it should include no buffers on it.
There was a problem hiding this comment.
@diasdavid Oh, makes sense then. I thought "JSON object" == "Buffer with JSON string". So this PR can be closed, but ipfs-inactive/js-ipfs-http-client#825 should be merged then.
Ref.: ipfs-inactive/js-ipfs-http-client#822