@libp2p/peer-collections

@libp2p/peer-collections

Stores values against a peer id

Table of contents

• Install
• Description
• Example
• License
• Contribution

Install

$ npm i @libp2p/peer-collections

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.

Example

import { peerMap, peerSet, peerList } from '@libp2p/peer-collections'

const map = peerMap<string>()
map.set(peerId, 'value')

const set = peerSet()
set.add(peerId)

const list = peerList()
list.push(peerId)

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.