Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Paolo Scanferla committed Feb 13, 2016
1 parent 75611e4 commit a304618
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,14 @@ Available options are:
library. On the server you can use whichever library implements the
websocket protocol (e.g. faye-websocket).

- `autoConnect` **boolean** *optional* [default: `true`]: whether to establish
the connection to the server upon instantiation. When `false`, one can
manually establish the connection with the `connect` method.

- `autoReconnect` **boolean** *optional* [default: `true`]: whether to try to
reconnect to the server when the socket connection closes, unless the closing
was initiated by a call to the `disconnect` method.

#### Returns

A new DDP instance, which is also an `EventEmitter` instance.
Expand Down Expand Up @@ -186,7 +194,8 @@ it for consistency).
### DDP.connect()

Connects to the ddp server. The method is called automatically by the class
constructor, so there generally should be no need for the developer to call it
constructor if the `autoConnect` option is set to `true` (default behaviour).
So there generally should be no need for the developer to call the method
themselves.

#### Arguments
Expand Down

0 comments on commit a304618

Please sign in to comment.