Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

Minor Documentation discrepancy: catReadableStream #1206

Closed
mitra42 opened this issue Feb 6, 2018 · 1 comment
Closed

Minor Documentation discrepancy: catReadableStream #1206

mitra42 opened this issue Feb 6, 2018 · 1 comment

Comments

@mitra42
Copy link

mitra42 commented Feb 6, 2018

There appears to be a minor documentation discrepancy in whether options can be passed to catreadablestream.

https://github.com/ipfs/js-ipfs#files
says ipfs.files.catReadableStream(ipfsPath, [options])
i.e. implies can pass options to the ReadableStream.

https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#catreadablestream
Says JavaScript - ipfs.files.catReadableStream(ipfsPath) -> Readable Stream
i.e. implies no options.

The code at files.js has
catReadableStream: (ipfsPath) => toStream.source(_catPullStream(ipfsPath)),

So I think its the interface-ipfs-core docs are correct and js-ipfs docs that are incorrect.

BUT @diasdavid , when you were here, you suggested there was a way to pass stream options (especially the ones for byte range)? Is there another way?

@daviddias daviddias added the status/ready Ready to be worked label Feb 12, 2018
@mitra42
Copy link
Author

mitra42 commented Aug 13, 2018

This is all in sync now

# for free to subscribe to this conversation on GitHub. Already have an account? #.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants