README.md

@libp2p/peer-collections

Stores values against a peer id

Table of contents

• Install
  • Browser <script> tag
• Description
• API Docs
• License
• Contribution

Install

$ npm i @libp2p/peer-collections

Browser <script> tag

Loading this module through a script tag will make it's exports available as Libp2pPeerCollections in the global namespace.

<script src="https://unpkg.com/@libp2p/peer-collections/dist/index.min.js"></script>

Description

We can't use PeerIds as collection keys because collection keys are compared using same-value-zero equality, so this is just a group of collections that stringifies PeerIds before storing them.

PeerIds cache stringified versions of themselves so this should be a cheap operation.

API Docs

• https://libp2p.github.io/js-libp2p/modules/_libp2p_peer_collections.html

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)

Contribution

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.