diff --git a/index.html b/index.html index 2cc84ff4..082a08ad 100644 --- a/index.html +++ b/index.html @@ -2,7 +2,7 @@
-0.28.8
0.28.9
peerStore
Connection
will be returned
true
or false
.
-
+
src/metrics/index.js
@@ -9623,7 +9623,7 @@ resolve to either true
or false
.
-
+
src/metrics/index.js
@@ -9678,7 +9678,7 @@ will be ignored.
-
+
src/metrics/index.js
@@ -9733,7 +9733,7 @@ Once stop
is called, start
must be called to resume st
-
+
src/metrics/index.js
@@ -9795,7 +9795,7 @@ Once stop
is called, start
must be called to resume st
-
+
src/metrics/index.js
@@ -9857,7 +9857,7 @@ Once stop
is called, start
must be called to resume st
-
+
src/metrics/index.js
@@ -9933,7 +9933,7 @@ is a live peer, or in the disconnected peer LRU cache.
-
+
src/metrics/index.js
@@ -9995,7 +9995,7 @@ is a live peer, or in the disconnected peer LRU cache.
-
+
src/metrics/index.js
@@ -10070,7 +10070,7 @@ is a live peer, or in the disconnected peer LRU cache.
-
+
src/metrics/index.js
@@ -10139,7 +10139,7 @@ be stopped and moved to an LRU for temporary retention.
-
+
src/metrics/index.js
@@ -10217,7 +10217,7 @@ placeholder stats will be merged with the existing stats.
-
+
src/metrics/index.js
@@ -10347,7 +10347,7 @@ with the placeholder string returned from here, and the known PeerId
-
+
src/metrics/index.js
@@ -10431,7 +10431,7 @@ and returned.
-
+
src/metrics/old-peers.js
@@ -10506,7 +10506,7 @@ and returned.
-
+
src/metrics/stats.js
@@ -10586,7 +10586,7 @@ and returned.
Stats.stop
was previously called,
undefined
if there are no known multiaddrs for the given pe
-
+
src/peer-store/address-book.js
@@ -13545,7 +13545,7 @@ Returns undefined
if there are no known multiaddrs for the given pe
-
+
src/peer-store/proto-book.js
@@ -13576,6 +13576,1065 @@ Returns undefined
if there are no known multiaddrs for the given pe
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The KeyBook is responsible for keeping the known public keys of a peer.
+ ++ Extends + + Book + +
+ + + + + + + + + + +(PeerStore)
+
+ Map known peers to their known Public Key.
+ +Set the Peer public key.
+ +(PeerId)
+
+ ((RsaPublicKey | Ed25519PublicKey | Secp256k1PublicKey))
+
+ KeyBook
:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get Public key of the given PeerId, if stored.
+ +(PeerId)
+
+ (RsaPublicKey | Ed25519PublicKey | Secp256k1PublicKey)
:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+The MetadataBook is responsible for keeping the known supported +protocols of a peer.
+ ++ Extends + + Book + +
+ + + + + + + + + + +(PeerStore)
+
+ Set metadata key and value of a provided peer.
+ + + + + + + + + + + + + +(PeerId)
+
+ (string)
+ metadata key
+
+ (Buffer)
+ metadata value
+
+ ProtoBook
:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Set data into the datastructure
+ +(any)
+
+ (any)
+
+ (any)
+
+ (Object
+ = {}
)
+
+ Name | +Description | +
---|---|
$3.emit any
+
+ (default true )
+ |
+ + |
Get the known data of a provided peer.
+ + + + + + + + + + + + + +(PeerId)
+
+ Map<string, Buffer>
:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Get specific metadata value, if it exists
+ + + + + + + + + + + + + +(PeerId)
+
+ (string)
+
+ Buffer
:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Deletes the provided peer from the book.
+ +(PeerId)
+
+ boolean
:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Deletes the provided peer metadata key from the book.
+ + + + + + + + + + + + + +(PeerId)
+
+ (string)
+
+ boolean
:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+PeerStore Event emitter, used by the MetadataBook to emit: +"change:metadata" - emitted when the known metadata of a peer change.
+ +undefined
if there are no known multiaddrs for the given pe
-
+
src/peer-store/book.js
@@ -13723,7 +14782,7 @@ Returns undefined
if there are no known multiaddrs for the given pe
undefined
if there are no known multiaddrs for the given pe
undefined
if there are no known multiaddrs for the given pe
undefined
if there is no available data for the given peer.
undefined
if there is no available data for the given peer.
The KeyBook is responsible for keeping the known public keys of a peer.
- -- Extends - - Book - -
- - - - - - - - - - -(PeerStore)
-
- Map known peers to their known Public Key.
- -Set the Peer public key.
- -(PeerId)
-
- ((RsaPublicKey | Ed25519PublicKey | Secp256k1PublicKey))
-
- KeyBook
:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Get Public key of the given PeerId, if stored.
- -(PeerId)
-
- (RsaPublicKey | Ed25519PublicKey | Secp256k1PublicKey)
:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-The MetadataBook is responsible for keeping the known supported -protocols of a peer.
- -- Extends - - Book - -
- - - - - - - - - - -(PeerStore)
-
- Set metadata key and value of a provided peer.
- - - - - - - - - - - - - -(PeerId)
-
- (string)
- metadata key
-
- (Buffer)
- metadata value
-
- ProtoBook
:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Set data into the datastructure
- -(any)
-
- (any)
-
- (any)
-
- (Object
- = {}
)
-
- Name | -Description | -
---|---|
$3.emit any
-
- (default true )
- |
- - |
Get the known data of a provided peer.
- - - - - - - - - - - - - -(PeerId)
-
- Map<string, Buffer>
:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Get specific metadata value, if it exists
- - - - - - - - - - - - - -(PeerId)
-
- (string)
-
- Buffer
:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Deletes the provided peer from the book.
- -(PeerId)
-
- boolean
:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Deletes the provided peer metadata key from the book.
- - - - - - - - - - - - - -(PeerId)
-
- (string)
-
- boolean
:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-PeerStore Event emitter, used by the MetadataBook to emit: -"change:metadata" - emitted when the known metadata of a peer change.
- -Ping a given peer and wait for its response, getting the operation latency.
- + @@ -16309,7 +16309,7 @@ If the peer was not known before, it will be added.(PeerId)
+ peer ((PeerId | multiaddr))