From 83fedf598a2104f965ec68b4f2a79091892fd477 Mon Sep 17 00:00:00 2001 From: Eli Flanagan Date: Thu, 8 Jun 2017 05:24:56 -0500 Subject: [PATCH] [docs] Add explicit documentation for websocket transport (#1128) --- docs/API.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/API.md b/docs/API.md index 5c2cc3438..2edd9686d 100644 --- a/docs/API.md +++ b/docs/API.md @@ -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({