Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Revert "document options values for Firefox."

This reverts commit 9d05827.
  • Loading branch information...
commit fb0c13e8e247075afbc0f40d0bc2c7c68ae21e03 1 parent 9d05827
@michelle michelle authored
Showing with 3 additions and 3 deletions.
  1. +3 −3 docs/api.md
View
6 docs/api.md
@@ -46,9 +46,9 @@ Returns a `DataConnection` object.
* `id` String. The id of the remote peer to connect to.
* `options` Object.
* `label` Optional label for the underlying DataChannel, to differentiate between DataConnections between the same two peers. If left unspecified, a label will be assigned at random.
- * `metadata` Optional metadata to pass to the remote peer. Can be any serializable type. **Only available in Firefox on the first DataConnection established between two Peers.**
- * `serialization` String, which can be `binary`, `binary-utf8`, `json`, or `none`. This will be the serialization format of all data sent over the P2P DataConnection. Defaults to `binary`. **Will always be `binary` in Firefox.**
- * `reliable` Boolean, which if `true` activates experimental reliable transfer (while waiting for actual reliable transfer to be implemented in Chrome). Defaults to `false` until Chrome implements reliable/large data transfer. This parameter is only available in the most recent build. **Will always be `true` in Firefox.**
+ * `metadata` Optional metadata to pass to the remote peer. Can be any serializable type.
+ * `serialization` String, which can be `binary`, `binary-utf8`, `json`, or `none`. This will be the serialization format of all data sent over the P2P DataConnection. Defaults to `binary`.
+ * `reliable` Boolean, which if `true` activates experimental reliable transfer (while waiting for actual reliable transfer to be implemented in Chrome). Defaults to `false` until Chrome implements reliable/large data transfer. This parameter is only available in the most recent build.
Before writing to / data will be emitted from the `DataConnection` object that is returned, the `open` event must fire. Also the `error` event should be checked in case a connection cannot be made.
Please sign in to comment.
Something went wrong with that request. Please try again.