Skip to content

Commit 6b750b8

Browse files
committed
Proper documentation for start command
1 parent 10ed2a7 commit 6b750b8

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/sync.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@ The function should always be called in a transaction.
99

1010
The following commands are supported:
1111

12-
1. `start`: Payload is a JSON-encoded object. This requests the client to start a sync iteration, specifying
13-
parameters.
12+
1. `start`: Payload is a JSON-encoded object. This requests the client to start a sync iteration.
13+
The payload can either be `null` or an JSON object with:
14+
- An optional `parameters: Record<string, any>` entry, specifying parameters to include in the request
15+
to the sync service.
1416
2. `stop`: No payload, requests the current sync iteration (if any) to be shut down.
1517
3. `line_text`: Payload is a serialized JSON object received from the sync service.
1618
4. `line_binary`: Payload is a BSON-encoded object received from the sync service.

0 commit comments

Comments
 (0)