Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface API<OptionExtension>

Type parameters

  • OptionExtension = {}

Hierarchy

  • API

Index

Methods

  • ls(options?: AbortOptions & OptionExtension): Promise<string[]>
  • Returns the list of subscriptions the peer is subscribed to

    Parameters

    Returns Promise<string[]>

  • peers(topic: string, options?: AbortOptions & OptionExtension): Promise<string[]>
  • Returns the peers that are subscribed to one topic.

    example
    const topic = 'fruit-of-the-day'

    const peerIds = await ipfs.pubsub.peers(topic)
    console.log(peerIds)

    Parameters

    • topic: string
    • Optional options: AbortOptions & OptionExtension

    Returns Promise<string[]>

  • publish(topic: string, data: Uint8Array, options?: AbortOptions & OptionExtension): Promise<void>
  • Publish a data message to a pubsub topic

    example
    const topic = 'fruit-of-the-day'
    const msg = new TextEncoder().encode('banana')

    await ipfs.pubsub.publish(topic, msg)
    // msg was broadcasted
    console.log(`published to ${topic}`)

    Parameters

    • topic: string
    • data: Uint8Array
    • Optional options: AbortOptions & OptionExtension

    Returns Promise<void>

  • setMaxListeners(max: number): void
  • Subscribe to a pubsub topic

    example
    const topic = 'fruit-of-the-day'
    const receiveMsg = (msg) => console.log(msg.data.toString())

    await ipfs.pubsub.subscribe(topic, receiveMsg)
    console.log(`subscribed to ${topic}`)

    Parameters

    Returns Promise<void>

  • Unsubscribes from a pubsub topic

    example
    const topic = 'fruit-of-the-day'
    const receiveMsg = (msg) => console.log(msg.toString())

    await ipfs.pubsub.subscribe(topic, receiveMsg)
    console.log(`subscribed to ${topic}`)

    await ipfs.pubsub.unsubscribe(topic, receiveMsg)
    console.log(`unsubscribed from ${topic}`)

    // Or removing all listeners:

    const topic = 'fruit-of-the-day'
    const receiveMsg = (msg) => console.log(msg.toString())
    await ipfs.pubsub.subscribe(topic, receiveMsg);
    // Will unsubscribe ALL handlers for the given topic
    await ipfs.pubsub.unsubscribe(topic);

    Parameters

    Returns Promise<void>

Generated using TypeDoc