Function getPeers

  • getPeers(payload): Promise<{
        announced: {
            multiaddr: null | string;
            peerAddress: string;
            peerId: string;
        }[];
        connected: {
            backoff: number;
            heartbeats: {
                sent: number;
                success: number;
            };
            isNew: boolean;
            lastSeen: number;
            lastSeenLatency: number;
            multiaddr: null | string;
            peerAddress: string;
            peerId: string;
            quality: number;
            reportedVersion: string;
        }[];
    }>

  • Parameters

    • payload: {
          apiEndpoint: string | URL;
          apiToken: string;
          quality?: number;
          timeout?: number;
      }
      • apiEndpoint: string | URL

        The API endpoint for authentication.

      • apiToken: string

        The API token for authentication.

      • Optional quality?: number
      • Optional timeout?: number

        optional timeout for the requests

    Returns Promise<{
        announced: {
            multiaddr: null | string;
            peerAddress: string;
            peerId: string;
        }[];
        connected: {
            backoff: number;
            heartbeats: {
                sent: number;
                success: number;
            };
            isNew: boolean;
            lastSeen: number;
            lastSeenLatency: number;
            multiaddr: null | string;
            peerAddress: string;
            peerId: string;
            quality: number;
            reportedVersion: string;
        }[];
    }>

Settings

Member Visibility

Theme