Interface DelegatedRoutingV1HttpApiClient

url

getClosestPeers

• getClosestPeers(
      cid: CID,
      options?: GetClosestPeersOptions,
  ): AsyncGenerator<PeerRecord>

  Returns an async generator of PeerRecords of the closest peers to the supplied key

  Parameters

  • cid: CID
  • Optionaloptions: GetClosestPeersOptions

  Returns AsyncGenerator<PeerRecord>

getIPNS

• getIPNS(cid: CID, options?: AbortOptions): Promise<Uint8Array<ArrayBuffer>>

  Returns a promise of a serialized IPNS record for passed CID

  Parameters

  • cid: CID
  • Optionaloptions: AbortOptions

  Returns Promise<Uint8Array<ArrayBuffer>>

getPeers

• getPeers(cid: CID, options?: GetPeersOptions): AsyncGenerator<PeerRecord>

  Returns an async generator of PeerRecords for the provided CID

  Parameters

  • cid: CID
  • Optionaloptions: GetPeersOptions

  Returns AsyncGenerator<PeerRecord>

getProviders

• getProviders(
      cid: CID,
      options?: GetProvidersOptions,
  ): AsyncGenerator<PeerRecord>

  Returns an async generator of PeerRecords that can provide the content for the passed CID

  Parameters

  • cid: CID
  • Optionaloptions: GetProvidersOptions

  Returns AsyncGenerator<PeerRecord>

putIPNS

• putIPNS(cid: CID, record: Uint8Array, options?: AbortOptions): Promise<void>

  Publishes a serialized IPNS record for the passed CID

  Parameters

  • cid: CID
  • record: Uint8Array
  • Optionaloptions: AbortOptions

  Returns Promise<void>

start

• start(): Promise<void>

  Create the request/response cache used to ensure duplicate requests aren't made for the same data

  Returns Promise<void>

stop

• stop(): Promise<void>

  Shut down any currently running HTTP requests and clear up any resources that are in use

  Returns Promise<void>