@libp2p/peer-collections - npm Package Compare versions

Comparing version 4.0.6 to 4.0.7

dist/src/index.d.ts

@@ -0,1 +1,8 @@
+/**
+ * @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';
@@ -2,0 +9,0 @@ export { PeerSet } from './set.js';

dist/src/index.js

@@ -0,1 +1,8 @@
+/**
+ * @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';
@@ -2,0 +9,0 @@ export { PeerSet } from './set.js';

package.json

 {
   "name": "@libp2p/peer-collections",
-  "version": "4.0.6",
+  "version": "4.0.7",
   "description": "Stores values against a peer id",
@@ -52,9 +52,9 @@ "license": "Apache-2.0 OR MIT",
   "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"
   }
 }

README.md

@@ -1,3 +0,1 @@
-# @libp2p/peer-collections <!-- omit in toc -->
-
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
@@ -10,13 +8,10 @@ [![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
 
-## 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
@@ -26,3 +21,3 @@ $ npm i @libp2p/peer-collections
 
-### Browser `<script>` tag
+## Browser `<script>` tag
 
@@ -35,13 +30,7 @@ Loading this module through a script tag will make it's exports available as `Libp2pPeerCollections` in the global namespace.
 
-## Description
+# API Docs
 
-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
+# License
 
@@ -53,4 +42,4 @@ Licensed under either of
 
-## 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.

src/index.ts

@@ -0,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'

No alert changes

Improved metrics

Total package byte prevSize

58607

increased by1.25%

Lines of code

853

increased by2.52%

Worsened metrics

Number of lines in readme file

42

decreased by-20.75%

Dependency changes

• Updated@libp2p/interface@^0.1.5

• Updated@libp2p/peer-id@^3.0.5