Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Browse files

more details on serialization format

  • Loading branch information...
1 parent 9094c57 commit a60ddb839464a2cbe1ceabb7bceb47c1f6902481 @michelle michelle committed
Showing with 4 additions and 2 deletions.
  1. +4 −2 docs/
6 docs/
@@ -5,7 +5,7 @@
## Class: peerjs.Peer
-This class is a the BinaryJS websocket server. It is an `EventEmitter`.
+This class is a Peer, which can connect to other peers and listen for connections. It is an `EventEmitter`.
### new Peer([id], [options])
@@ -118,7 +118,9 @@ for no serialization. Default serialization format is `binary`.
Accepts data of any JSON type or binary type.
-Data is serialized using BinaryPack and then sent to the remote peer.
+To configure which serialization format to use, specify `binary`, `json`, or `none` as the `serialization` property of the `options` object in `peer.connect`.
+Data is serialized using BinaryPack (`binary`) by default and then sent to the remote peer.
### connection.close()

0 comments on commit a60ddb8

Please sign in to comment.
Something went wrong with that request. Please try again.