ssbc / ssb-blobs

blob gossiping ssb-subprotocol
MIT License
12 stars 11 forks source link

Documentation #32

Closed retog closed 3 years ago

retog commented 4 years ago

I've been using https://scuttlebot.io/apis/scuttlebot/blobs.html as documentation but it seems to be outdated. I found that the want method now returns a promise and no longer seems to support the callback. Also, the push method is not documented.

stale[bot] commented 3 years ago

Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward?

retog commented 3 years ago

Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward?

I think it is.

mixmix commented 3 years ago

Thanks @retog. I'm looking at documenting the api here this week.

I'm not sure why it's want would return a promise, in the code it's callback based. I have a feeling someone else in the stack might be providing promise sugar but I'm not sure. I don't plan to be investigating that at this stage.

mixmix commented 3 years ago

There's some docs of api in help.js https://www.github.com/ssbc/ssb-blobs/tree/master/help.js

Will be checking that's up to date too

retog commented 3 years ago

Thanks @retog. I'm looking at documenting the api here this week.

I'm not sure why it's want would return a promise, in the code it's callback based. I have a feeling someone else in the stack might be providing promise sugar but I'm not sure. I don't plan to be investigating that at this stage.

Yes, this appears to be added by muxrpc. Not sure why I was under the impression that the callback would no longer work.

mixmix commented 3 years ago

I've added some docs now. Going to close this for the moment