Interface Router

name

OptionalcancelReprovide

• cancelReprovide?(key: CID, options?: AbortOptions): Promise<void>

  Helia will periodically re-provide every previously provided CID. Use this method to no longer re-provide the passed CID.

  Parameters

  • key: CID
  • Optionaloptions: AbortOptions

  Returns Promise<void>

  Example

  // ...
  await contentRouting.cancelReprovide(cid, {
    signal: AbortSignal.timeout(5_000)
  })
  Copy

Optionalcapabilities

• capabilities?(): "fallback"[]

  Returns "fallback"[]

OptionalfindPeer

• findPeer?(
      peer: CID,
      options?: RoutingOptions<RoutingFindPeerProgressEvents>,
  ): Promise<Peer>

  Searches the network for peer info corresponding to the passed peer id.

  Parameters

  • peer: CID
  • Optionaloptions: RoutingOptions<RoutingFindPeerProgressEvents>

  Returns Promise<Peer>

  Example

  // ...
  const peer = await peerRouting.findPeer(peerId, {
    signal: AbortSignal.timeout(5_000)
  })
  Copy

OptionalfindProviders

• findProviders?(
      cid: CID,
      options?: RoutingOptions<RoutingFindProvidersProgressEvents>,
  ): AsyncIterable<Provider>

  Find the providers of the passed CID.

  Parameters

  • cid: CID
  • Optionaloptions: RoutingOptions<RoutingFindProvidersProgressEvents>

  Returns AsyncIterable<Provider>

  Example

  // Iterate over the providers found for the given cid
  for await (const provider of contentRouting.findProviders(cid, {
    signal: AbortSignal.timeout(5_000)
  })) {
   console.log(provider.id, provider.multiaddrs)
  }
  Copy

Optionalget

• get?(
      key: Uint8Array,
      options?: RoutingOptions<RoutingGetProgressEvents>,
  ): Promise<Uint8Array<ArrayBuffer>>

  Retrieves a value from the network corresponding to the passed key.

  Parameters

  • key: Uint8Array
  • Optionaloptions: RoutingOptions<RoutingGetProgressEvents>

  Returns Promise<Uint8Array<ArrayBuffer>>

  Example

  // ...
  
  const key = uint8ArrayFromString('/key')
  const value = await contentRouting.get(key, {
    signal: AbortSignal.timeout(5_000)
  })
  Copy

OptionalgetClosestPeers

• getClosestPeers?(
      key: Uint8Array,
      options?: RoutingOptions<RoutingGetClosestPeersProgressEvents>,
  ): AsyncIterable<Peer>

  Search the network for peers that are closer to the passed key. Peer info should be yielded in ever-increasing closeness to the key.

  Parameters

  • key: Uint8Array
  • Optionaloptions: RoutingOptions<RoutingGetClosestPeersProgressEvents>

  Returns AsyncIterable<Peer>

  Example

  // Iterate over the closest peers found for the given key
  for await (const peer of peerRouting.getClosestPeers(key, {
    signal: AbortSignal.timeout(5_000)
  })) {
    console.log(peer.id, peer.multiaddrs)
  }
  Copy

Optionalprovide

• provide?(
      cid: CID,
      options?: RoutingOptions<RoutingProvideProgressEvents>,
  ): Promise<void>

  The implementation of this method should ensure that network peers know the caller can provide content that corresponds to the passed CID.

  Parameters

  • cid: CID
  • Optionaloptions: RoutingOptions<RoutingProvideProgressEvents>

  Returns Promise<void>

  Example

  // ...
  await contentRouting.provide(cid, {
    signal: AbortSignal.timeout(5_000)
  })
  Copy

Optionalput

• put?(
      key: Uint8Array,
      value: Uint8Array,
      options?: RoutingOptions<RoutingPutProgressEvents>,
  ): Promise<void>

  Puts a value corresponding to the passed key in a way that can later be retrieved by another network peer using the get method.

  Parameters

  • key: Uint8Array
  • value: Uint8Array
  • Optionaloptions: RoutingOptions<RoutingPutProgressEvents>

  Returns Promise<void>

  Example

  // ...
  const key = uint8ArrayFromString('/key')
  const value = uint8ArrayFromString('oh hello there')
  
  await contentRouting.put(key, value, {
    signal: AbortSignal.timeout(5_000)
  })
  Copy