Interface Fetch

Readonlyprotocol

libp2p.register(libp2p.services.fetch.protocol, {
  onConnect (peerId) {
    // handle fetch peer connect
  }
  // ...etc
})
Copy

fetch

• fetch(
      peer: DialTarget,
      key: string | Uint8Array<ArrayBufferLike>,
      options?: DialProtocolOptions,
  ): Promise<Uint8Array<ArrayBufferLike> | undefined>

  Sends a request to fetch the value associated with the given key from the given peer

  Parameters

  • peer: DialTarget
  • key: string | Uint8Array<ArrayBufferLike>
  • Optionaloptions: DialProtocolOptions

  Returns Promise<Uint8Array<ArrayBufferLike> | undefined>

registerLookupFunction

• registerLookupFunction(prefix: string, lookup: LookupFunction): void

  Registers a new lookup callback that can map keys to values, for a given set of keys that share the same prefix

  Parameters

  • prefix: string
  • lookup: LookupFunction

  Returns void

  Example

  // ...
  libp2p.services.fetch.registerLookupFunction('/prefix', (key) => { ... })
  Copy

unregisterLookupFunction

• unregisterLookupFunction(prefix: string, lookup?: LookupFunction): void

  Registers a new lookup callback that can map keys to values, for a given set of keys that share the same prefix.

  Parameters

  • prefix: string
  • Optionallookup: LookupFunction

  Returns void

  Example

  // ...
  libp2p.services.fetch.unregisterLookupFunction('/prefix')
  Copy