ipld / js-car

Content Addressable aRchive format reader and writer for JavaScript
Other
46 stars 7 forks source link

feat: add support for sync car reading #121

Closed hugomrdias closed 1 year ago

hugomrdias commented 1 year ago

This PR adds a new class CarReaderSync to support syncronous car reading.

Changes:

I was hoping to be able to extract more from the async decoder than i did, but i think this is useful and does not introduce any breaking change.

The new CarReaderSync is exported in package.json.

rvagg commented 1 year ago

I'm not sure jsdoc2readme is working properly on this anymore, npm run docs is supposed to take the jsdoc updates and insert it into the readme; if that doesn't work, you might have to do a bit of manual sync, but getting something on the README would be good for this.

As long as the 3 of you agree on the details don't let me be a blocker, other than the desire for decent docs.

hugomrdias commented 1 year ago

I'm not sure jsdoc2readme is working properly on this anymore, npm run docs is supposed to take the jsdoc updates and insert it into the readme; if that doesn't work, you might have to do a bit of manual sync, but getting something on the README would be good for this.

As long as the 3 of you agree on the details don't let me be a blocker, other than the desire for decent docs.

i was able to make jsdoc2readme work readme is updated and i also added a reference to the sync reader in the usage section.

hugomrdias commented 1 year ago

@rvagg seems ready to merge.

github-actions[bot] commented 1 year ago

:tada: This PR is included in version 5.1.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket: