puter.peer.connect()
Websites Puter Apps Node.js Workers
Connects to a peer server and returns a PuterPeerConnection instance.
On websites, Puter.js may prompt the user to authenticate before connecting.
Syntax
const conn = await puter.peer.connect(inviteCode);
const conn = await puter.peer.connect(inviteCode, options);
Parameters
inviteCode (required)
A string invite code created by puter.peer.serve().
options (optional)
options is an object with the following properties:
iceServers(RTCIceServer[]) Custom ICE servers (STUN/TURN) to use instead of the Puter-managed relays.
Return value
A Promise that resolves to a PuterPeerConnection instance.
PuterPeerConnection methods and events
send(data)- Send a message to the peer. Supports strings,Blob,ArrayBuffer, orArrayBufferView.close(reason)- Close the connection.openevent: Fired when the data channel is ready.messageevent: Fired when a message is received (event.data).closeevent: Fired when the connection closes (event.reason).errorevent: Fired when a connection error occurs (event.error).
Example
<html>
<body>
<script src="https://js.puter.com/v2/"></script>
<script>
(async () => {
const inviteCode = prompt('Enter invite code');
const conn = await puter.peer.connect(inviteCode);
conn.addEventListener('open', () => {
conn.send('Hello from the client!');
});
conn.addEventListener('message', (msg) => {
puter.print('Server says:', msg.data);
});
})();
</script>
</body>
</html>