Skip to content

Commit

Permalink
[docs] Add explicit documentation for websocket transport (#1128)
Browse files Browse the repository at this point in the history
  • Loading branch information
efx authored and darrachequesne committed Jun 8, 2017
1 parent c0da119 commit 83fedf5
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ socket.on('reconnect_attempt', () => {

##### With `extraHeaders`

Note: will only work if `polling` transport is enabled (which is the default)
This only works if `polling` transport is enabled (which is the default). Custom headers will not be appended when using `websocket` as the transport. This happens because the WebSocket handshake does not honor custom headers. (For background see the [WebSocket protocol RFC](https://tools.ietf.org/html/rfc6455#section-4))

```js
const socket = io({
Expand Down

0 comments on commit 83fedf5

Please sign in to comment.