Module content-routing/utils

Index

Type aliases

Functions

Type aliases

Multiaddr

Multiaddr: Multiaddr

PeerId

PeerId: PeerId

Functions

maybeLimitSource

maybeLimitSource(source: AsyncIterable<{ id: PeerId; multiaddrs: Multiaddr[] }>, max?: number | undefined): AsyncIterable<{ id: PeerId; multiaddrs: Multiaddr[] }>

If max is passed, only take that number of peers from the source otherwise take all the peers

Parameters
- source: AsyncIterable<{ id: PeerId; multiaddrs: Multiaddr[] }>
- Optional max: number | undefined
Returns AsyncIterable<{ id: PeerId; multiaddrs: Multiaddr[] }>

requirePeers

requirePeers(source: AsyncIterable<{ id: PeerId; multiaddrs: Multiaddr[] }>, min?: undefined | number): AsyncGenerator<{ id: PeerId; multiaddrs: Multiaddr[] }, void, unknown>

Require at least min peers to be yielded from source

Parameters
- source: AsyncIterable<{ id: PeerId; multiaddrs: Multiaddr[] }>
- Optional min: undefined | number
Returns AsyncGenerator<{ id: PeerId; multiaddrs: Multiaddr[] }, void, unknown>

storeAddresses

storeAddresses(source: AsyncIterable<{ id: PeerId; multiaddrs: Multiaddr[] }>, peerStore: PeerStore): AsyncIterable<{ id: PeerId; multiaddrs: Multiaddr[] }>

Store the multiaddrs from every peer in the passed peer store

Parameters
- source: AsyncIterable<{ id: PeerId; multiaddrs: Multiaddr[] }>
- peerStore: PeerStore
Returns AsyncIterable<{ id: PeerId; multiaddrs: Multiaddr[] }>

uniquePeers

uniquePeers(source: AsyncIterable<{ id: PeerId; multiaddrs: Multiaddr[] }>): AsyncGenerator<{ id: PeerId; multiaddrs: Multiaddr[] }, void, unknown>

Filter peers by unique peer id

Parameters
- source: AsyncIterable<{ id: PeerId; multiaddrs: Multiaddr[] }>
Returns AsyncGenerator<{ id: PeerId; multiaddrs: Multiaddr[] }, void, unknown>