Skip to content

Commit 81e9614

Browse files
committed
docs: add serializer_args
1 parent 005953d commit 81e9614

File tree

4 files changed

+12
-0
lines changed

4 files changed

+12
-0
lines changed

src/socketio/async_client.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@ class AsyncClient(base_client.BaseClient):
4545
leave interrupt handling to the calling application.
4646
Interrupt handling can only be enabled when the
4747
client instance is created in the main thread.
48+
:param serializer_args: A mapping of additional parameters to pass to
49+
the serializer. The content of this dictionary
50+
depends on the selected serialization method.
4851
4952
The Engine.IO configuration supports the following settings:
5053

src/socketio/async_server.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ class AsyncServer(base_server.BaseServer):
5050
default is `['/']`, which always accepts connections to
5151
the default namespace. Set to `'*'` to accept all
5252
namespaces.
53+
:param serializer_args: A mapping of additional parameters to pass to
54+
the serializer. The content of this dictionary
55+
depends on the selected serialization method.
5356
:param kwargs: Connection parameters for the underlying Engine.IO server.
5457
5558
The Engine.IO configuration supports the following settings:

src/socketio/client.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,9 @@ class Client(base_client.BaseClient):
4848
leave interrupt handling to the calling application.
4949
Interrupt handling can only be enabled when the
5050
client instance is created in the main thread.
51+
:param serializer_args: A mapping of additional parameters to pass to
52+
the serializer. The content of this dictionary
53+
depends on the selected serialization method.
5154
5255
The Engine.IO configuration supports the following settings:
5356

src/socketio/server.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,9 @@ class Server(base_server.BaseServer):
5353
default is `['/']`, which always accepts connections to
5454
the default namespace. Set to `'*'` to accept all
5555
namespaces.
56+
:param serializer_args: A mapping of additional parameters to pass to
57+
the serializer. The content of this dictionary
58+
depends on the selected serialization method.
5659
:param kwargs: Connection parameters for the underlying Engine.IO server.
5760
5861
The Engine.IO configuration supports the following settings:

0 commit comments

Comments
 (0)