Class Peer

Index

Constructors

Accessors

connected info protomux

Methods

[kTestOnlySendRawInvite] connect disconnect receiveDeviceInfo sendDeviceInfo sendInvite sendInviteCancel sendInviteResponse sendProjectJoinDetails

Constructors

constructor

new Peer(options): Peer
Parameters
- options: {
      channel: Channel;
      logger: undefined | Logger;
      peerId: string;
      protomux: Protomux<any>;
  }
  - channel: Channel
  - logger: undefined | Logger
  - peerId: string
  - protomux: Protomux<any>
Returns Peer

Accessors

connected

get connected(): Promise<any>
A promise that resolves when the peer connects, or rejects if it fails to connect

Returns Promise<any>

info

get info(): PeerInfoInternal
Returns PeerInfoInternal

protomux

get protomux(): Protomux<any>
Returns Protomux<any>

Methods

[kTestOnlySendRawInvite]

[kTestOnlySendRawInvite](buf): void
Parameters
- buf: Buffer
Returns void

connect

connect(): void
Returns void

disconnect

disconnect(): void
Returns void

receiveDeviceInfo

receiveDeviceInfo(deviceInfo): void
Parameters
- deviceInfo: DeviceInfo
Returns void

sendDeviceInfo

sendDeviceInfo(deviceInfo): void
Parameters
- deviceInfo: DeviceInfo
Returns void

sendInvite

sendInvite(invite): void
Parameters
- invite: Invite
Returns void

sendInviteCancel

sendInviteCancel(inviteCancel): void
Parameters
- inviteCancel: InviteCancel
Returns void

sendInviteResponse

sendInviteResponse(response): void
Parameters
- response: InviteResponse
Returns void

sendProjectJoinDetails

sendProjectJoinDetails(details): void
Parameters
- details: ProjectJoinDetails
Returns void