Class LocalPeers

Hierarchy

  • TypedEmitter
    • LocalPeers

Constructors

constructor

Accessors

peers

Methods

[kTestOnlySendRawInvite] connect sendDeviceInfo sendInvite sendInviteCancel sendInviteResponse sendProjectJoinDetails

Constructors

constructor

  • new LocalPeers(opts?): LocalPeers

  • Parameters

    • Optionalopts: {
          logger: undefined | Logger;
      } = {}

    Returns LocalPeers

Accessors

peers

  • get peers(): (PeerInfoBase & {
        connectedAt: number;
        protomux: Protomux<NoiseSecretStream<Duplex<any, any, any, any, true, true, DuplexEvents<any, any>>>>;
        status: "connected";
    } | PeerInfoBase & {
        disconnectedAt: number;
        status: "disconnected";
    })[]

  • Returns (PeerInfoBase & {
        connectedAt: number;
        protomux: Protomux<NoiseSecretStream<Duplex<any, any, any, any, true, true, DuplexEvents<any, any>>>>;
        status: "connected";
    } | PeerInfoBase & {
        disconnectedAt: number;
        status: "disconnected";
    })[]

Methods

[kTestOnlySendRawInvite]

  • [kTestOnlySendRawInvite](deviceId, buf): Promise<void>

  • Parameters

    • deviceId: string
    • buf: Buffer

    Returns Promise<void>

connect

  • connect(stream): ReplicationStream

  • Connect to a peer over an existing NoiseSecretStream

    Parameters

    • stream: NoiseSecretStream<any>

      a NoiseSecretStream from @hyperswarm/secret-stream

    Returns ReplicationStream

sendDeviceInfo

  • sendDeviceInfo(deviceId, deviceInfo): Promise<void>

  • Parameters

    • deviceId: string

      id of the peer you want to send to (publicKey of peer as hex string)

    • deviceInfo: DeviceInfo

      device info to send

    Returns Promise<void>

sendInvite

  • sendInvite(deviceId, invite): Promise<void>

  • Parameters

    • deviceId: string
    • invite: Invite

    Returns Promise<void>

sendInviteCancel

  • sendInviteCancel(deviceId, inviteCancel): Promise<void>

  • Parameters

    • deviceId: string
    • inviteCancel: InviteCancel

    Returns Promise<void>

sendInviteResponse

  • sendInviteResponse(deviceId, inviteResponse): Promise<void>

  • Respond to an invite from a peer

    Parameters

    • deviceId: string

      id of the peer you want to respond to (publicKey of peer as hex string)

    • inviteResponse: InviteResponse

    Returns Promise<void>

sendProjectJoinDetails

  • sendProjectJoinDetails(deviceId, details): Promise<void>

  • Parameters

    • deviceId: string
    • details: ProjectJoinDetails

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods