Interface IPeerExchange

interface IPeerExchange {
    addLibp2pEventListener: (<K>(type, listener, options?) => void);
    allPeers: (() => Promise<Peer[]>);
    connectedPeers: (() => Promise<Peer[]>);
    multicodec: string;
    peerStore: PeerStore;
    removeLibp2pEventListener: {
        <K>(type, listener?, options?): void;
        (type, listener?, options?): void;
    };
    shardInfo?: ShardInfo;
    query(params): Promise<undefined | PeerInfo[]>;
}

Hierarchy (view full)

Implemented by

    Properties

    addLibp2pEventListener allPeers connectedPeers multicodec peerStore removeLibp2pEventListener shardInfo?

    Methods

    query

    Properties

    addLibp2pEventListener

    addLibp2pEventListener: (<K>(type, listener, options?) => void)

    Type declaration

      • <K>(type, listener, options?): void

      • Type Parameters

        • K extends keyof Libp2pEvents<ServiceMap>

        Parameters

        • type: K
        • listener: null | EventHandler<Libp2pEvents<ServiceMap>[K]>
        • Optional options: boolean | AddEventListenerOptions

        Returns void

    allPeers

    allPeers: (() => Promise<Peer[]>)

    Type declaration

      • (): Promise<Peer[]>

      • Returns Promise<Peer[]>

    connectedPeers

    connectedPeers: (() => Promise<Peer[]>)

    Type declaration

      • (): Promise<Peer[]>

      • Returns Promise<Peer[]>

    multicodec

    multicodec: string

    peerStore

    peerStore: PeerStore

    removeLibp2pEventListener

    removeLibp2pEventListener: {
        <K>(type, listener?, options?): void;
        (type, listener?, options?): void;
    }

    Type declaration

      • <K>(type, listener?, options?): void

      • Type Parameters

        • K extends keyof Libp2pEvents<ServiceMap>

        Parameters

        • type: K
        • Optional listener: null | EventHandler<Libp2pEvents<ServiceMap>[K]>
        • Optional options: boolean | EventListenerOptions

        Returns void

      • (type, listener?, options?): void

      • Parameters

        • type: string
        • Optional listener: EventHandler<Event>
        • Optional options: boolean | EventListenerOptions

        Returns void

    Optional shardInfo

    shardInfo?: ShardInfo

    Methods

    query

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc