Interface IRelayAPI

Interface representing the Relay API, providing control and information about the GossipSub protocol.

Hierarchy

  • IRelayAPI

Properties

getMeshPeers gossipSub start

Properties

getMeshPeers

getMeshPeers: ((topic?) => string[])

Type declaration

    • (topic?): string[]

    • Function to retrieve the mesh peers for a given topic or all topics if none is specified. Returns an array of peer IDs as strings.

      Parameters

      • Optional topic: string

      Returns string[]

Readonly gossipSub

gossipSub: GossipSub

The GossipSub instance used for managing pub/sub behavior.

start

start: (() => Promise<void>)

Type declaration

    • (): Promise<void>

    • Function to start the relay, returning a Promise that resolves when initialization is complete.

      Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc