aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/src/manual/gun.asciidoc11
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/src/manual/gun.asciidoc b/doc/src/manual/gun.asciidoc
index 902af9a..fb457a4 100644
--- a/doc/src/manual/gun.asciidoc
+++ b/doc/src/manual/gun.asciidoc
@@ -69,7 +69,16 @@ The following keys are defined:
keepalive => pos_integer()::
Time between pings in milliseconds. Defaults to 5000.
-@todo We need to document Websocket options.
+=== ws_opts() = map()
+
+Configuration for the Websocket protocol.
+
+The following keys are defined:
+
+compress => boolean()::
+ Whether to enable permessage-deflate compression. This does
+ not guarantee that compression will be used as it is the
+ server that ultimately decides. Defaults to false.
== Messages