Bez popisu

renovate[bot] b3f0e0feec chore(deps): update webdriverio monorepo to v8.20.5 před 1 rokem
.github 8d6073dbd9 chore(deps): update actions/checkout action to v3 před 1 rokem
__test__ 51baaffaca style: run linter před 1 rokem
e2e 95bb0f7fa9 fix: convert `Blob`s to `ArrayBuffer`s during `.send()` před 1 rokem
lib 95bb0f7fa9 fix: convert `Blob`s to `ArrayBuffer`s during `.send()` před 1 rokem
.deepsource.toml d02b4802f0 Added .deepsource.toml před 4 roky
.gitignore cf4c6a7305 chore: remove `browserstack.err` před 1 rokem
.prettierignore 2b604305c1 style: prettier ignore CHANGELOG.md před 3 roky
.prettierrc.toml d46692622d style: configure prettier před 3 roky
.releaserc.json d5bd9552da fix: add changelog and npm version to the repo před 3 roky
CHANGELOG.md b0deea1000 chore(release): 1.5.1 [skip ci] před 1 rokem
LICENSE fc7c88d3e3 Update LICENSE před 10 roky
README.md e8694a09b5 docs(readme): update browser support před 1 rokem
jest.config.cjs d9d9407d35 test(e2e): run datachannel serialization tests před 1 rokem
package-lock.json b3f0e0feec chore(deps): update webdriverio monorepo to v8.20.5 před 1 rokem
package.json b0deea1000 chore(release): 1.5.1 [skip ci] před 1 rokem
renovate.json 749042e7f9 chore(deps): merge renovate updates with `branch` strategy před 1 rokem
tsconfig.json d9d9407d35 test(e2e): run datachannel serialization tests před 1 rokem

README.md

PeerJS: Simple peer-to-peer with WebRTC

https://t.me/joinchat/VWI0UBxnG7f7_DV7

Backers on Open Collective Sponsors on Open Collective

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

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

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

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

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

npm test

Browser support

Firefox
Firefox
Chrome
Chrome
Safari
Edge
Safari
Safari
80+ 83+ 83+ 15+

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

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

Documentation / API Reference

PeerServer

Discuss PeerJS on our Telegram Channel

Changelog

Contributors

This project exists thanks to all the people who contribute.

Backers

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

Sponsors

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

License

PeerJS is licensed under the MIT License.