@libp2p/peer-collections 4.0.6 → 4.0.7

package/README.md

@@ -1,5 +1,3 @@
-# @libp2p/peer-collections <!-- omit in toc -->
-
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
 [![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
 [![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p)
@@ -7,22 +5,19 @@
 
 > Stores values against a peer id
 
-## Table of contents <!-- omit in toc -->
+# About
 
-- [Install](#install)
-  - [Browser `<script>` tag](#browser-script-tag)
-- [Description](#description)
-- [API Docs](#api-docs)
-- [License](#license)
-- [Contribution](#contribution)
+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.
 
-## Install
+PeerIds cache stringified versions of themselves so this should be a cheap operation.
+
+# Install
 
 ```console
 $ npm i @libp2p/peer-collections
 ```
 
-### Browser `<script>` tag
+## Browser `<script>` tag
 
 Loading this module through a script tag will make it's exports available as `Libp2pPeerCollections` in the global namespace.
 
@@ -30,23 +25,17 @@ Loading this module through a script tag will make it's exports available as `Li
 <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
+# API Docs
 
 - <https://libp2p.github.io/js-libp2p/modules/_libp2p_peer_collections.html>
 
-## License
+# License
 
 Licensed under either of
 
 - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
 - MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
-## Contribution
+# 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.

package/dist/src/index.d.ts

@@ -1,3 +1,10 @@
+/**
+ * @packageDocumentation
+ *
+ * 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.
+ */
 export { PeerMap } from './map.js';
 export { PeerSet } from './set.js';
 export { PeerList } from './list.js';

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AAClC,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AAClC,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA"}

package/dist/src/index.js

@@ -1,3 +1,10 @@
+/**
+ * @packageDocumentation
+ *
+ * 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.
+ */
 export { PeerMap } from './map.js';
 export { PeerSet } from './set.js';
 export { PeerList } from './list.js';

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AAClC,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AAClC,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/peer-collections",
-  "version": "4.0.6",
+  "version": "4.0.7",
   "description": "Stores values against a peer id",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p/tree/master/packages/peer-collections#readme",
@@ -49,11 +49,11 @@
     "test:electron-main": "aegir test -t electron-main"
   },
   "dependencies": {
-    "@libp2p/interface": "^0.1.4",
-    "@libp2p/peer-id": "^3.0.4"
+    "@libp2p/interface": "^0.1.5",
+    "@libp2p/peer-id": "^3.0.5"
   },
   "devDependencies": {
-    "@libp2p/peer-id-factory": "^3.0.6",
+    "@libp2p/peer-id-factory": "^3.0.7",
     "aegir": "^41.0.2"
   }
 }

package/src/index.ts

@@ -1,3 +1,11 @@
+/**
+ * @packageDocumentation
+ *
+ * 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.
+ */
+
 export { PeerMap } from './map.js'
 export { PeerSet } from './set.js'
 export { PeerList } from './list.js'