Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify docs: PublicDirectory.read returns a CID (for now) #199

Closed
Tracked by #295
matheus23 opened this issue Mar 3, 2023 · 1 comment
Closed
Tracked by #295

Clarify docs: PublicDirectory.read returns a CID (for now) #199

matheus23 opened this issue Mar 3, 2023 · 1 comment

Comments

@matheus23
Copy link
Member

Right now these are the docs for the wasm PublicDirectory.read function:

/// Reads specified file content from the directory.
pub fn read(&self, path_segments: &Array, store: BlockStore) -> JsResult<Promise> {

It should perhaps be clarified that only a CID is returned.

In the future we'll have rs-wnfs code that understands UnixFS chunking and will be able to stream out the actual bytes of the file.

@matheus23
Copy link
Member Author

This was addressed in #376

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant