YjsJSONSerializer
Defined in: yjs/src/peerborne-yjs.ts:74
Extends
Section titled “Extends”JSONSerializer<Uint8Array>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new YjsJSONSerializer():
YjsJSONSerializer
Returns
Section titled “Returns”YjsJSONSerializer
Inherited from
Section titled “Inherited from”JSONSerializer<Uint8Array>.constructor
Methods
Section titled “Methods”createLoadRequestCompletionDetector()
Section titled “createLoadRequestCompletionDetector()”createLoadRequestCompletionDetector():
LoadRequestCompletionDetector
Defined in: core/dist/esm/src/json-serializer.d.ts:9
Create per-stream framing state for fragmented requests whose writer may remain open while waiting for a response.
Returns
Section titled “Returns”LoadRequestCompletionDetector
Inherited from
Section titled “Inherited from”JSONSerializer.createLoadRequestCompletionDetector
decode()
Section titled “decode()”decode(
message):string
Defined in: core/dist/esm/src/json-serializer.d.ts:21
Parameters
Section titled “Parameters”message
Section titled “message”Uint8Array
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”JSONSerializer.decode
deserialize()
Section titled “deserialize()”deserialize(
message):unknown
Defined in: core/dist/esm/src/json-serializer.d.ts:19
Parameters
Section titled “Parameters”message
Section titled “message”string
Returns
Section titled “Returns”unknown
Inherited from
Section titled “Inherited from”JSONSerializer.deserialize
deserializeChanges()
Section titled “deserializeChanges()”deserializeChanges(
changes):Uint8Array
Defined in: yjs/src/peerborne-yjs.ts:78
Parameters
Section titled “Parameters”changes
Section titled “changes”Uint8Array
Returns
Section titled “Returns”Uint8Array
Overrides
Section titled “Overrides”JSONSerializer.deserializeChanges
deserializeLoadRequest()
Section titled “deserializeLoadRequest()”deserializeLoadRequest(
message):CRDTLoadRequest
Defined in: core/dist/esm/src/json-serializer.d.ts:27
Parameters
Section titled “Parameters”message
Section titled “message”Uint8Array
Returns
Section titled “Returns”CRDTLoadRequest
Inherited from
Section titled “Inherited from”JSONSerializer.deserializeLoadRequest
deserializeSyncMessage()
Section titled “deserializeSyncMessage()”deserializeSyncMessage(
message):CRDTSyncMessage<Uint8Array<ArrayBufferLike>>
Defined in: yjs/src/peerborne-yjs.ts:159
Parameters
Section titled “Parameters”message
Section titled “message”Uint8Array
Returns
Section titled “Returns”CRDTSyncMessage<Uint8Array<ArrayBufferLike>>
Overrides
Section titled “Overrides”JSONSerializer.deserializeSyncMessage
encode()
Section titled “encode()”encode(
message):Uint8Array
Defined in: core/dist/esm/src/json-serializer.d.ts:20
Parameters
Section titled “Parameters”message
Section titled “message”string
Returns
Section titled “Returns”Uint8Array
Inherited from
Section titled “Inherited from”JSONSerializer.encode
orderDecodedSyncFields()
Section titled “orderDecodedSyncFields()”
protectedorderDecodedSyncFields(wire,decoded):CRDTSyncMessage<Uint8Array<ArrayBufferLike>>
Defined in: core/dist/esm/src/json-serializer.d.ts:8
Keep authenticated JSON field order while dropping unknown wire fields.
Parameters
Section titled “Parameters”Record<string, unknown>
decoded
Section titled “decoded”CRDTSyncMessage<Uint8Array<ArrayBufferLike>>
Returns
Section titled “Returns”CRDTSyncMessage<Uint8Array<ArrayBufferLike>>
Inherited from
Section titled “Inherited from”JSONSerializer.orderDecodedSyncFields
serialize()
Section titled “serialize()”serialize(
message):string
Defined in: core/dist/esm/src/json-serializer.d.ts:10
Parameters
Section titled “Parameters”message
Section titled “message”unknown
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”JSONSerializer.serialize
serializeChanges()
Section titled “serializeChanges()”serializeChanges(
changes):Uint8Array
Defined in: yjs/src/peerborne-yjs.ts:75
Parameters
Section titled “Parameters”changes
Section titled “changes”Uint8Array
Returns
Section titled “Returns”Uint8Array
Overrides
Section titled “Overrides”JSONSerializer.serializeChanges
serializeLoadRequest()
Section titled “serializeLoadRequest()”serializeLoadRequest(
message):Uint8Array
Defined in: core/dist/esm/src/json-serializer.d.ts:26
Parameters
Section titled “Parameters”message
Section titled “message”CRDTLoadRequest
Returns
Section titled “Returns”Uint8Array
Inherited from
Section titled “Inherited from”JSONSerializer.serializeLoadRequest
serializeNormalizedSyncWireValue()
Section titled “serializeNormalizedSyncWireValue()”
protectedserializeNormalizedSyncWireValue(message):string
Defined in: core/dist/esm/src/json-serializer.d.ts:18
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
Inherited from
Section titled “Inherited from”JSONSerializer.serializeNormalizedSyncWireValue
serializeSyncMessage()
Section titled “serializeSyncMessage()”serializeSyncMessage(
message):Uint8Array
Defined in: yjs/src/peerborne-yjs.ts:82
Parameters
Section titled “Parameters”message
Section titled “message”CRDTSyncMessage<Uint8Array<ArrayBufferLike>>
Returns
Section titled “Returns”Uint8Array
Overrides
Section titled “Overrides”JSONSerializer.serializeSyncMessage