search

ssbc / ssb-blobs

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

Documentation: all methods missing #21

Closed mixmix closed 4 years ago

mixmix commented 5 years ago

I was reading ssb-serve-blobs and it references methods presumably created by this plugin. Coming here find the config of this module is documented but nowhere the methods.

Here's list of methods that need adding for reference:

exports.manifest = {
  get: 'source',
  getSlice: 'source',
  add: 'sink',
  rm: 'async',
  ls: 'source',
  has: 'async',
  size: 'async',
  meta: 'async',
  want: 'async',
  push: 'async',
  changes: 'source',
  createWants: 'source',
  help: 'sync'
}

e.g. get means there's a method sbot.blobs.get which is a pull-stream source

mixmix commented 4 years ago

See also : http://scuttlebot.io/docs/advanced/publish-a-file.html sweet demo

stale[bot] commented 4 years ago

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