Skip to content

Commit 11a4934

Browse files
committed
docs(json-crdt): ✏️ add indexed codec README
1 parent 1f43168 commit 11a4934

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## Binary Indexed Format
2+
3+
The Binary Index encoding format for JSON CRDT returns a flat map, where each
4+
key is a string and each value is an `Uint8Array` blob.
5+
6+
The map has the following keys:
7+
8+
- `"r"` - ID of the root node.
9+
- `"c"` - Clock table of the document.
10+
- `"{sid}_{time}` - Each key is a string of the form `{sid}_{time}`, where
11+
`sid` is the session ID index in the clock table encoded as Base36 and `time`
12+
is the logical clock sequence number encoded as Base36. The value is the
13+
encoded node.

0 commit comments

Comments
 (0)