Skip to content

Commit f9d3f06

Browse files
st0ck53ydarrachequesne
authored andcommittedSep 2, 2017
[docs] Fix wsEngine default value in README (#526)
Merge #459 (release 2.0.0) changed default wsEngine to uws. Updating README to reflect this change.
1 parent fd20b91 commit f9d3f06

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed
 

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ to a single process.
226226
option. If false, no path will be sent, which means browsers will only send the cookie on the engine.io attached path (`/engine.io`).
227227
Set false to not save io cookie on all requests. (`/`)
228228
- `cookieHttpOnly` (`Boolean`): If `true` HttpOnly io cookie cannot be accessed by client-side APIs, such as JavaScript. (`true`) _This option has no effect if `cookie` or `cookiePath` is set to `false`._
229-
- `wsEngine` (`String`): what WebSocket server implementation to use. Specified module must conform to the `ws` interface (see [ws module api docs](https://github.com/websockets/ws/blob/master/doc/ws.md)). Default value is `ws`. An alternative c++ addon is also available by installing `uws` module.
229+
- `wsEngine` (`String`): what WebSocket server implementation to use. Specified module must conform to the `ws` interface (see [ws module api docs](https://github.com/websockets/ws/blob/master/doc/ws.md)). Default value is `uws` (see [µWebSockets](https://github.com/uWebSockets/uWebSockets)).
230230
- `initialPacket` (`Object`): an optional packet which will be concatenated to the handshake packet emitted by Engine.IO.
231231
- `close`
232232
- Closes all clients

0 commit comments

Comments
 (0)
Please sign in to comment.