@libp2p/peer-collections 4.0.10 → 5.0.0-09dd02987

package/dist/src/index.d.ts

@@ -4,6 +4,33 @@
  * 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 Peer lists
+ *
+ * ```JavaScript
+ * import { peerList } from '@libp2p/peer-collections'
+ *
+ * const list = peerList()
+ * list.push(peerId)
+ * ```
+ *
+ * @example Peer maps
+ *
+ * ```JavaScript
+ * import { peerMap } from '@libp2p/peer-collections'
+ *
+ * const map = peerMap<string>()
+ * map.set(peerId, 'value')
+ * ```
+ *
+ * @example Peer sets
+ *
+ * ```JavaScript
+ * import { peerSet } from '@libp2p/peer-collections'
+ *
+ * const set = peerSet()
+ * set.add(peerId)
+ * ```
  */
 export { PeerMap } from './map.js';
 export { PeerSet } from './set.js';

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

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;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

@@ -4,6 +4,33 @@
  * 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 Peer lists
+ *
+ * ```JavaScript
+ * import { peerList } from '@libp2p/peer-collections'
+ *
+ * const list = peerList()
+ * list.push(peerId)
+ * ```
+ *
+ * @example Peer maps
+ *
+ * ```JavaScript
+ * import { peerMap } from '@libp2p/peer-collections'
+ *
+ * const map = peerMap<string>()
+ * map.set(peerId, 'value')
+ * ```
+ *
+ * @example Peer sets
+ *
+ * ```JavaScript
+ * import { peerSet } from '@libp2p/peer-collections'
+ *
+ * const set = peerSet()
+ * set.add(peerId)
+ * ```
  */
 export { PeerMap } from './map.js';
 export { PeerSet } from './set.js';

package/dist/src/index.js.map

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;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.10",
+  "version": "5.0.0-09dd02987",
   "description": "Stores values against a peer id",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/peer-collections#readme",
@@ -53,11 +53,11 @@
     "test:electron-main": "aegir test -t electron-main"
   },
   "dependencies": {
-    "@libp2p/interface": "^1.0.1",
-    "@libp2p/peer-id": "^4.0.1"
+    "@libp2p/interface": "1.0.1-09dd02987",
+    "@libp2p/peer-id": "4.0.1-09dd02987"
   },
   "devDependencies": {
-    "@libp2p/peer-id-factory": "^3.0.10",
+    "@libp2p/peer-id-factory": "4.0.0-09dd02987",
     "aegir": "^41.0.2"
   }
 }

package/src/index.ts

@@ -4,6 +4,33 @@
  * 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 Peer lists
+ *
+ * ```JavaScript
+ * import { peerList } from '@libp2p/peer-collections'
+ *
+ * const list = peerList()
+ * list.push(peerId)
+ * ```
+ *
+ * @example Peer maps
+ *
+ * ```JavaScript
+ * import { peerMap } from '@libp2p/peer-collections'
+ *
+ * const map = peerMap<string>()
+ * map.set(peerId, 'value')
+ * ```
+ *
+ * @example Peer sets
+ *
+ * ```JavaScript
+ * import { peerSet } from '@libp2p/peer-collections'
+ *
+ * const set = peerSet()
+ * set.add(peerId)
+ * ```
  */
 
 export { PeerMap } from './map.js'

package/dist/typedoc-urls.json

@@ -1,5 +0,0 @@
-{
-  "PeerList": "https://libp2p.github.io/js-libp2p/classes/_libp2p_peer_collections.PeerList.html",
-  "PeerMap": "https://libp2p.github.io/js-libp2p/classes/_libp2p_peer_collections.PeerMap.html",
-  "PeerSet": "https://libp2p.github.io/js-libp2p/classes/_libp2p_peer_collections.PeerSet.html"
-}