暂无描述

Jonas Gloning 5abd76a5b7 test(e2e): retry flaky tests 1 年之前
.github 6b9ed7c979 ci: use `package.json` version of prettier 1 年之前
__test__ 0d1468514c test(jest): skip broken test until a better solution is found 2 年之前
e2e 5abd76a5b7 test(e2e): retry flaky tests 1 年之前
lib b6d3fdd759 refactor: Custom `DataConnection` classes can be plugged-in at runtime 1 年之前
.deepsource.toml d02b4802f0 Added .deepsource.toml 4 年之前
.gitignore 168d407c07 test: configure jest 2 年之前
.parcelrc b5beec4a07 fix(bundler import): enable module target 3 年之前
.prettierignore 2b604305c1 style: prettier ignore CHANGELOG.md 3 年之前
.prettierrc.toml d46692622d style: configure prettier 3 年之前
.releaserc.json d5bd9552da fix: add changelog and npm version to the repo 3 年之前
CHANGELOG.md 9aaf86fe90 chore(release): 1.4.7 [skip ci] 2 年之前
LICENSE fc7c88d3e3 Update LICENSE 10 年之前
README.md 8cfcaa1dba style: run prettier 2 年之前
browserstack.err d9d9407d35 test(e2e): run datachannel serialization tests 2 年之前
jest.config.cjs d9d9407d35 test(e2e): run datachannel serialization tests 2 年之前
package-lock.json d59a2fe225 chore(deps): update dependency @swc/core to v1.3.71 1 年之前
package.json 6b9ed7c979 ci: use `package.json` version of prettier 1 年之前
renovate.json 749042e7f9 chore(deps): merge renovate updates with `branch` strategy 2 年之前
tsconfig.json d9d9407d35 test(e2e): run datachannel serialization tests 2 年之前

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

Browsers support

Firefox
Firefox
Chrome
Chrome
Safari
Safari
last 4 versions last 4 versions 12.1+

Safari

  1. Safari supports only string data when sending via DataConnection. Use JSON serialization type if you want to communicate with Safari. By default, DataConnection uses Binary serialization type.

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.