Awesome

This repository has been archived!

This IPFS-related repository has been archived, and all issues are therefore frozen. If you want to ask a question or open/continue a discussion related to this repo, please visit the official IPFS forums.

We archive repos for one or more of the following reasons:

• Code or content is unmaintained, and therefore might be broken
• Content is outdated, and therefore may mislead readers
• Code or content evolved into something else and/or has lived on in a different place
• The repository or project is not active in general

Please note that in order to keep the primary IPFS GitHub org tidy, most archived repos are moved into the ipfs-inactive org.

If you feel this repo should not be archived (or portions of it should be moved to a non-archived repo), please reach out and let us know. Archiving can always be reversed if needed.

interface-pull-blob-store

Test suite for pull-blob-stores

A test suite and interface that can be used to implement streaming file (blob) storage modules for various storage backends and platforms. All streaming happens through the use of pull-streams.

Lead Maintainer

Alex Potsides

Modules that use this

• fs-pull-blob-store
• idb-pull-blob-store
• level-pull-blob-store

Table of Contents

• Install
• Usage
• API
  • store.write(key, cb)
  • store.read(key)
  • store.exists(key, cb)
  • store.remove(key, cb)
• Contribute
• License

Install

TODO

Usage

TODO

API

A valid blob store should implement the following APIs. There is a reference in-memory implementation available at src/index.js in this repo.

store.write(key, cb)

This method should return a sink, which when written to writes the data to the blob store.

store.read(key)

This method should return a source that emits blob data from the underlying blob store or emits an error if the blob does not exist or if there was some other error during the read.

store.exists(key, cb)

This checks if a blob exists in the store.

store.remove(key, cb)

This method should remove a blob from the store.

Contribute

If you would like to contribute code to this repository, please dive in! Check out the issues. Clicking the banner above will lead you to the general IPFS community contribute guidelines, if you would like to contribute in other ways.

Small note: If editing the Readme, please conform to the standard-readme specification.

License

MIT