Github url


by peers

peers /peerjs

Simple peer-to-peer with WebRTC

7.5K Stars 1.1K Forks Last release: 11 days ago (v1.3.0) MIT License 889 Commits 28 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

PeerJS: Simple peer-to-peer with WebRTC

Backers on Open CollectiveSponsors 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.


Include the library

with npm:

npm install peerjs

and the usage:

js import Peer from 'peerjs';

Create a Peer

javascript 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


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


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

Media calls

Call```javascript navigator.mediaDevices.getUserMedia({video: true, audio: true}, (stream) => { const call ='another-peers-id', stream); call.on('stream', (remoteStream) => { // Show stream in some

\*\*Answer\*\* ```javascript 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) =&gt; {
    console.error('Failed to get local stream', err);

Running tests

npm test

Browsers support

| FirefoxFirefox | ChromeChrome | SafariSafari | | --------- | --------- | --------- | | last 4 versions| last 4 versions| 12.1+


  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.


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 We'll resolve it when updated to Parcel V2.


Documentation / API Reference


Discuss PeerJS on our Telegram Channel



This project exists thanks to all the people who contribute. [Contribute].


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


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


PeerJS is licensed under the MIT License.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.