Closed hugomrdias closed 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'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.
@rvagg seems ready to merge.
:tada: This PR is included in version 5.1.0 :tada:
The release is available on:
Your semantic-release bot :package::rocket:
This PR adds a new class CarReaderSync to support syncronous car reading.
Changes:
decodeV2Header
,decodeVarint
andgetMultihashLength
BytesReader
interface has a new arg in theexactly
method to seek after reading, defaults to false (previous behavior)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.