ipfs/js-ipfs-interfaces

TypeScript interfaces used by IPFS internals

ipfs-interfaces

TypeScript interfaces used by IPFS internals

Table of contents

• Structure
• Packages
• API Docs
• License
• Contribute

Structure

• /packages/interface-blockstore An interface for storing and retrieving blocks
• /packages/interface-blockstore-tests Compliance tests for the blockstore interface
• /packages/interface-datastore datastore interface
• /packages/interface-datastore-tests Compliance tests for the datastore interface
• /packages/interface-store A generic interface for storing and retrieving data

Packages

See the ./packages directory for the various interfaces.

API Docs

• https://ipfs.github.io/js-ipfs-interfaces

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribute

Contributions welcome! Please check out the issues.

Also see our contributing document for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS Code of Conduct.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.