Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface API<OptionExtension>

Type parameters

  • OptionExtension = {}

Hierarchy

  • API

Index

Methods

Methods

stat

  • Show diagnostic information on the bitswap agent. Note: bitswap.stat and stats.bitswap can be used interchangeably.

    example
    const stats = await ipfs.bitswap.stat()
    console.log(stats)

    Parameters

    Returns Promise<Stats>

unwant

  • unwant(cids: CID | CID[], options?: AbortOptions & OptionExtension): Promise<void>

  • Removes one or more CIDs from the wantlist

    example
    let list = await ipfs.bitswap.wantlist()
    console.log(list)
    // [ CID('QmHash') ]

    await ipfs.bitswap.unwant(cid)

    list = await ipfs.bitswap.wantlist()
    console.log(list)
    // []

    Parameters

    • cids: CID | CID[]
    • Optional options: AbortOptions & OptionExtension

    Returns Promise<void>

wantlist

  • wantlist(options?: AbortOptions & OptionExtension): Promise<CID[]>

  • Returns the wantlist for your node

    example
    const list = await ipfs.bitswap.wantlist()
    console.log(list)
    // [ CID('QmHash') ]

    Parameters

    Returns Promise<CID[]>

wantlistForPeer

  • wantlistForPeer(peerId: string, options?: AbortOptions & OptionExtension): Promise<CID[]>

  • Returns the wantlist for a connected peer

    example
    const list = await ipfs.bitswap.wantlistForPeer(peerId)
    console.log(list)
    // [ CID('QmHash') ]

    Parameters

    • peerId: string
    • Optional options: AbortOptions & OptionExtension

    Returns Promise<CID[]>

Generated using TypeDoc