puter.peer.connect() Connects to a peer server and returns a PuterPeerConnection instance.
On websites, Puter.js may prompt the user to authenticate before connecting. To let someone join without an account, pass anonToken — and a turnGrant from the host, so the connection can still use Puter's relays. See puter.peer.createGuestGrant().
const conn = await puter.peer.connect(inviteCode);
const conn = await puter.peer.connect(inviteCode, options);
inviteCode (required)
A string invite code created by puter.peer.serve().
options (Object) (optional)
An object with the following properties:
| Option | Type | Description |
|---|---|---|
anonToken |
String |
Any uuid, to join without a Puter session. It identifies this guest for the whole session, and no sign-in prompt is shown. The host sees the guest as anonymous, so send any name the host should show for the guest over the connection. |
turnGrant |
String |
A grant from puter.peer.createGuestGrant(). It lets a guest use the Puter-managed relays on the host's account. Without one, a guest connects only where a direct connection is possible. With forceRelay, a guest needs one. |
forceRelay |
Boolean |
Whether to route connections through a relay instead of trying a peer-to-peer connection. Defaults to false, which tries peer-to-peer. Metering charges may apply. |
iceServers |
Array<RTCIceServer> |
Custom ICE servers (STUN/TURN) to use instead of the Puter-managed relays. |
recoveryTimeout |
Number |
How long, in milliseconds, the connection keeps trying to restore a broken link before it closes, counted from when the link first showed trouble. Defaults to 60000. |
A Promise that resolves to a PuterPeerConnection instance, which carries send() and close() methods and the open, message, close, and error events.
<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>