Documented headers event.

websockets · Jul 3, 2012 · 3ecdb99 · 3ecdb99
1 parent 2463f85
commit 3ecdb99
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/doc/ws.md b/doc/ws.md
@@ -37,6 +37,12 @@ When the Upgrade was successfully, the `callback` will be called with a `ws.WebS
 
 If the underlying server emits an error, it will be forwarded here.
 
+### Event: 'headers'
+
+`function (headers) { }`
+
+Emitted with the object of HTTP headers that are going to be written to the `Stream` as part of the handshake.
+
 ### Event: 'connection'
 
 `function (socket) { }`