Document how to use custom JSON encoder/decoder

miguelgrinberg · Aug 30, 2015 · 7cf23c3 · 7cf23c3
1 parent a530ca4
commit 7cf23c3
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/flask_socketio/__init__.py b/flask_socketio/__init__.py
@@ -28,6 +28,10 @@ class SocketIO(object):
                    ``bytes`` values are treated as binary.  This option has no
                    effect on Python 3, where text and binary payloads are
                    always automatically discovered.
+    :param json: An alternative json module to use for encoding and decoding
+                 packets. Custom json modules must have ``dumps`` and ``loads``
+                 functions that are compatible with the standard library
+                 versions.
 
     The Engine.IO configuration supports the following settings: