@libp2p/peer-store
Version:
Stores information about peers libp2p knows on the network
57 lines (34 loc) • 2.13 kB
Markdown
# @libp2p/peer-store
[](http://libp2p.io/)
[](https://discuss.libp2p.io)
[](https://codecov.io/gh/libp2p/js-libp2p)
[](https://github.com/libp2p/js-libp2p/actions/workflows/main.yml?query=branch%3Amain)
> Stores information about peers libp2p knows on the network
# About
<!--
!IMPORTANT!
Everything in this README between "# About" and "# Install" is automatically
generated and will be overwritten the next time the doc generator is run.
To make changes to this section, please update the @packageDocumentation section
of src/index.js or src/index.ts
To experiment with formatting, please run "npm run docs" from the root of this
repo and examine the changes made.
-->
The peer store is where libp2p stores data about the peers it has encountered on the network.
# Install
```console
$ npm i @libp2p/peer-store
```
## Browser `<script>` tag
Loading this module through a script tag will make its exports available as `Libp2pPeerStore` in the global namespace.
```html
<script src="https://unpkg.com/@libp2p/peer-store/dist/index.min.js"></script>
```
# API Docs
- <https://libp2p.github.io/js-libp2p/modules/_libp2p_peer_store.html>
# License
Licensed under either of
- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/peer-store/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/peer-store/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.