|
@@ -9,7 +9,7 @@ This class is a Peer, which can connect to other peers and listen for connection
|
|
|
|
|
|
|
|
### new Peer([id], [options])
|
|
### new Peer([id], [options])
|
|
|
|
|
|
|
|
-* `id` String. The id by which this peer will be identified when other peers try to connect to it. If no id is given, one will be generated by the server
|
|
|
|
|
|
|
+* `id` String. The id by which this peer will be identified when other peers try to connect to it. If no id is given, one will be generated by the server. **Note that this ID is mainly used for brokering and that it is not recommended that you use it to identify peers. Also note that you can set a `metadata` option to send other identifying information.**
|
|
|
* `options` Object
|
|
* `options` Object
|
|
|
* `key` String. API key for cloud PeerServer. Is not used for servers other than `cloud.peerjs.com`
|
|
* `key` String. API key for cloud PeerServer. Is not used for servers other than `cloud.peerjs.com`
|
|
|
* `host` String. Server host. Default `cloud.peerjs.com`. Also accepts `'/'` for relative hostname.
|
|
* `host` String. Server host. Default `cloud.peerjs.com`. Also accepts `'/'` for relative hostname.
|
Michelle Bu