Constructors
constructor
- new Peer(options): Peer
Parameters
- options: {
channel: Channel;
logger: undefined | Logger;
peerId: string;
protomux: Protomux<any>;
}logger: undefined | Logger
peerId: string
Accessors
connected
- get connected(): Promise<any>
Returns Promise<any>
Methods
[kTestOnlySendRawInvite]
- [kTestOnlySendRawInvite](buf): Promise<void>
Returns Promise<void>
connect
- connect(): void
Returns void
disconnect
- disconnect(): void
Returns void
drained
- drained(): void
Returns void
receiveAck
- receiveAck(type, ack): void
Parameters
- type:
| "DeviceInfo"
| "Invite"
| "InviteCancel"
| "InviteResponse"
| "ProjectJoinDetails"
| "InviteAck"
| "InviteCancelAck"
| "InviteResponseAck"
| "ProjectJoinDetailsAck" - ack: AckResponse
Returns void
receiveDeviceInfo
- receiveDeviceInfo(deviceInfo): void
Returns void
sendDeviceInfo
- sendDeviceInfo(deviceInfo): Promise<void>
Returns Promise<void>
sendInvite
- sendInvite(invite): Promise<void>
Returns Promise<void>
sendInviteAck
- sendInviteAck(invite): Promise<void>
Returns Promise<void>
sendInviteCancel
- sendInviteCancel(inviteCancel): Promise<void>
Parameters
- inviteCancel: InviteCancel
Returns Promise<void>
sendInviteCancelAck
- sendInviteCancelAck(inviteCancel): Promise<void>
Parameters
- inviteCancel: InviteCancel
Returns Promise<void>
sendInviteResponse
- sendInviteResponse(response): Promise<void>
Returns Promise<void>
sendInviteResponseAck
- sendInviteResponseAck(response): Promise<void>
Returns Promise<void>
sendProjectJoinDetails
- sendProjectJoinDetails(details): Promise<void>
Parameters
- details: ProjectJoinDetails
Returns Promise<void>
sendProjectJoinDetailsAck
- sendProjectJoinDetailsAck(details): Promise<void>
Parameters
- details: ProjectJoinDetails
Returns Promise<void>
supportsAck
- supportsAck(): boolean
Returns boolean
A promise that resolves when the peer connects, or rejects if it fails to connect