Type alias ManagedPeerState

ManagedPeerState: {
    config: ManagedPeerConfig;
    error: Error | null;
    id: string | null;
    isActive: boolean;
    isClosed: boolean;
    isReady: boolean;
}

State of peer.

Type declaration

  • config: ManagedPeerConfig
  • error: Error | null
  • id: string | null

    ID of this peer, if any.

  • isActive: boolean
  • isClosed: boolean

    Set to true, when inner peer was closed. It may be closed externally(although it shouldn't) but here is a way to check that.

    When it's set, isReady is also false.

  • isReady: boolean

    If true, this peer can open and receive connections. One has to wait for this event in order to make/receiver connections.

Generated using TypeDoc