peerjs Documentation

Technical Documentation: peers/peerjs

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (`README.md`) Copy Section

PeerJS: Simple peer-to-peer with WebRTC

PeerJS provides a complete, configurable, and easy-to-use peer-to-peer API built on top of WebRTC, supporting both data channels and media streams.

Live Example Copy Chapter

Here's an example application that uses both media and data connections: https://glitch.com/~peerjs-video. The example also uses its own PeerServer.

Setup Copy Chapter

Include the library

with npm:
npm install peerjs

with yarn:
yarn add peerjs

// The usage -
import { Peer } from "peerjs";

Create a Peer

const peer = new Peer("pick-an-id");
// You can pick your own id or omit the id if you want to get a random one from the server.

Data connections Copy Chapter

Connect

const conn = peer.connect("another-peers-id");
conn.on("open", () => {
	conn.send("hi!");
});

Receive

peer.on("connection", (conn) => {
	conn.on("data", (data) => {
		// Will print 'hi!'
		console.log(data);
	});
	conn.on("open", () => {
		conn.send("hello!");
	});
});

Media calls Copy Chapter

Call

navigator.mediaDevices.getUserMedia(
	{ video: true, audio: true },
	(stream) => {
		const call = peer.call("another-peers-id", stream);
		call.on("stream", (remoteStream) => {
			// Show stream in some <video> element.
		});
	},
	(err) => {
		console.error("Failed to get local stream", err);
	},
);

Answer

peer.on("call", (call) => {
	navigator.mediaDevices.getUserMedia(
		{ video: true, audio: true },
		(stream) => {
			call.answer(stream); // Answer the call with an A/V stream.
			call.on("stream", (remoteStream) => {
				// Show stream in some <video> element.
			});
		},
		(err) => {
			console.error("Failed to get local stream", err);
		},
	);
});

Running tests Copy Chapter

npm test

Browser support Copy Chapter

We test PeerJS against these versions of Chrome, Edge, Firefox, and Safari with BrowserStack to ensure compatibility.
It may work in other and older browsers, but we don't officially support them.
Changes to browser support will be a breaking change going forward.

[!NOTE]
Firefox 102+ is required for CBOR / MessagePack support.

FAQ Copy Chapter

Q. I have a message Critical dependency: the request of a dependency is an expression in browser's console

A. The message occurs when you use PeerJS with Webpack. It is not critical! It relates to Parcel https://github.com/parcel-bundler/parcel/issues/2883 We'll resolve it when updated to Parcel V2.

Links Copy Chapter

[Documentation / API Reference](https://peerjs.com/docs/) Copy Section

[PeerServer](https://github.com/peers/peerjs-server) Copy Section

[Discuss PeerJS on our Telegram Channel](https://t.me/joinchat/ENhPuhTvhm8WlIxTjQf7Og) Copy Section

[Changelog](https://github.com/peers/peerjs/blob/master/CHANGELOG.md) Copy Section

Contributors Copy Chapter

This project exists thanks to all the people who contribute.

Backers Copy Chapter

Thank you to all our backers! [Become a backer]

Sponsors Copy Chapter

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License Copy Chapter

PeerJS is licensed under the MIT License.

--- METRICS ---

• Files Extracted: 1
• Estimated Token Budget: ~6682 tokens
• Canonical Reference: https://codewiki.google/github.com/peers/peerjs