Interface PeerRouting

Hierarchy

PeerRouting

Index

Properties

findPeer getClosestPeers

Properties

findPeer

findPeer: ((peerId: PeerId, options?: AbortOptions) => Promise<PeerInfo>)

Type declaration

- (peerId: PeerId, options?: AbortOptions): Promise<PeerInfo>
- Searches the network for peer info corresponding to the passed peer id.
  
  Example
```
// ...
const peer = await peerRouting.findPeer(peerId, options)
```
  Parameters
  - peerId: PeerId
  - Optional options: AbortOptions
  Returns Promise<PeerInfo>

getClosestPeers

getClosestPeers: ((key: Uint8Array, options?: AbortOptions) => AsyncIterable<PeerInfo>)

Type declaration

- (key: Uint8Array, options?: AbortOptions): AsyncIterable<PeerInfo>
- Search the network for peers that are closer to the passed key. Peer info should be yielded in ever-increasing closeness to the key.
  
  Example
```
// Iterate over the closest peers found for the given key
for await (const peer of peerRouting.getClosestPeers(key)) {
  console.log(peer.id, peer.multiaddrs)
}
```
  Parameters
  - key: Uint8Array
  - Optional options: AbortOptions
  Returns AsyncIterable<PeerInfo>