ipfs.block API is out of sync with the implementation

[matheus23]

Here is what I've noticed:

• ipfs.block.get
  • docs say it returns a Block, but it returns a Uint8Array
  • docs are missing the preload option
• ipfs.block.put
  • docs say it can also take a Block as a parameter, but it can only be a Uint8Array
  • docs say it can take a cid as an option, but the implementation ignores such a parameter
  • docs say it returns a Block, but it's just a Uint8Array

[lidel]

@matheus23 mind opening PR with updated docs (make docs match the latest implementation)? 🙏

docs are missing the preload option

which docs? (it is js-ipfs only feature)

[matheus23]

which docs? (it is js-ipfs only feature)

The options parameter for ipfs.block.get is missing an optional preload: boolean parameter.

[lidel]

Ack. It also should be added to the docs you linked.

[vogdb]

The return of ipfs.block.get has been fixed in #3990. @lidel I can help to fix the rest, if you want.