JSONSerializer
Defined in: packages/core/src/json-serializer.ts:394
ChangesSerializer provides serialization/deserialization methods for CRDT changes.
Type Parameters
Section titled “Type Parameters”ChangesType
Section titled “ChangesType”ChangesType
Type describing changes to a CRDT document. CRDT implementation dependent.
Implements
Section titled “Implements”ChangesSerializer<ChangesType>SyncMessageSerializer<ChangesType>LoadMessageSerializer
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new JSONSerializer<
ChangesType>():JSONSerializer<ChangesType>
Returns
Section titled “Returns”JSONSerializer<ChangesType>
Methods
Section titled “Methods”createLoadRequestCompletionDetector()
Section titled “createLoadRequestCompletionDetector()”createLoadRequestCompletionDetector():
LoadRequestCompletionDetector
Defined in: packages/core/src/json-serializer.ts:415
Create per-stream framing state for fragmented requests whose writer may remain open while waiting for a response.
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”LoadMessageSerializer.createLoadRequestCompletionDetector
decode()
Section titled “decode()”decode(
message):string
Defined in: packages/core/src/json-serializer.ts:467
Parameters
Section titled “Parameters”message
Section titled “message”Uint8Array
Returns
Section titled “Returns”string
deserialize()
Section titled “deserialize()”deserialize(
message):unknown
Defined in: packages/core/src/json-serializer.ts:454
Parameters
Section titled “Parameters”message
Section titled “message”string
Returns
Section titled “Returns”unknown
deserializeChanges()
Section titled “deserializeChanges()”deserializeChanges(
changes):ChangesType
Defined in: packages/core/src/json-serializer.ts:475
Parameters
Section titled “Parameters”changes
Section titled “changes”Uint8Array
Returns
Section titled “Returns”ChangesType
Implementation of
Section titled “Implementation of”ChangesSerializer.deserializeChanges
deserializeLoadRequest()
Section titled “deserializeLoadRequest()”deserializeLoadRequest(
message):CRDTLoadRequest
Defined in: packages/core/src/json-serializer.ts:522
Parameters
Section titled “Parameters”message
Section titled “message”Uint8Array
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”LoadMessageSerializer.deserializeLoadRequest
deserializeSyncMessage()
Section titled “deserializeSyncMessage()”deserializeSyncMessage(
message):CRDTSyncMessage<ChangesType>
Defined in: packages/core/src/json-serializer.ts:494
Parameters
Section titled “Parameters”message
Section titled “message”Uint8Array
Returns
Section titled “Returns”CRDTSyncMessage<ChangesType>
Implementation of
Section titled “Implementation of”SyncMessageSerializer.deserializeSyncMessage
encode()
Section titled “encode()”encode(
message):Uint8Array
Defined in: packages/core/src/json-serializer.ts:463
Parameters
Section titled “Parameters”message
Section titled “message”string
Returns
Section titled “Returns”Uint8Array
orderDecodedSyncFields()
Section titled “orderDecodedSyncFields()”
protectedorderDecodedSyncFields(wire,decoded):CRDTSyncMessage<ChangesType>
Defined in: packages/core/src/json-serializer.ts:401
Keep authenticated JSON field order while dropping unknown wire fields.
Parameters
Section titled “Parameters”Record<string, unknown>
decoded
Section titled “decoded”CRDTSyncMessage<ChangesType>
Returns
Section titled “Returns”CRDTSyncMessage<ChangesType>
serialize()
Section titled “serialize()”serialize(
message):string
Defined in: packages/core/src/json-serializer.ts:419
Parameters
Section titled “Parameters”message
Section titled “message”unknown
Returns
Section titled “Returns”string
serializeChanges()
Section titled “serializeChanges()”serializeChanges(
changes):Uint8Array
Defined in: packages/core/src/json-serializer.ts:472
Parameters
Section titled “Parameters”changes
Section titled “changes”ChangesType
Returns
Section titled “Returns”Uint8Array
Implementation of
Section titled “Implementation of”ChangesSerializer.serializeChanges
serializeLoadRequest()
Section titled “serializeLoadRequest()”serializeLoadRequest(
message):Uint8Array
Defined in: packages/core/src/json-serializer.ts:513
Parameters
Section titled “Parameters”message
Section titled “message”Returns
Section titled “Returns”Uint8Array
Implementation of
Section titled “Implementation of”LoadMessageSerializer.serializeLoadRequest
serializeNormalizedSyncWireValue()
Section titled “serializeNormalizedSyncWireValue()”
protectedserializeNormalizedSyncWireValue(message):string
Defined in: packages/core/src/json-serializer.ts:434
Stack-safe writer for schema-normalized sync-message wire objects.
Keep this separate from the public generic serializer: JSON.stringify
has observable cross-realm and boxed-primitive semantics that a focused
protocol writer must not claim to reproduce for arbitrary caller values.
Parameters
Section titled “Parameters”message
Section titled “message”unknown
Returns
Section titled “Returns”string
serializeSyncMessage()
Section titled “serializeSyncMessage()”serializeSyncMessage(
message):Uint8Array
Defined in: packages/core/src/json-serializer.ts:479
Parameters
Section titled “Parameters”message
Section titled “message”CRDTSyncMessage<ChangesType>
Returns
Section titled “Returns”Uint8Array