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

Minor Documentation discrepancy: catReadableStream  #1206

Closed
@mitra42

Description

@mitra42

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions