Function receiveSyncMessage

receiveSyncMessage<T>(
    doc: Automerge.Doc<T>,
    inState: Automerge.SyncState,
    message: Automerge.SyncMessage,
    opts?: Automerge.ApplyOptions<T>,
): [Automerge.Doc<T>, Automerge.SyncState, null]
Update a document and our sync state on receiving a sync message
Type Parameters
- T
Parameters
- doc: Automerge.Doc<T>
  The doc the sync message is about
- inState: Automerge.SyncState
  The SyncState for the peer we are communicating with
- message: Automerge.SyncMessage
  The message which was received
- Optionalopts: Automerge.ApplyOptions<T>
  Any ApplyOptions, used for passing a PatchCallback which will be informed of any changes in doc which occur because of the received sync message.
Returns [Automerge.Doc<T>, Automerge.SyncState, null]
An array of [newDoc, newSyncState, null] where newDoc is the updated state of doc, newSyncState should replace inState.

Remarks
Note that this function has three return values for legacy reasons. The third value used to be a sync message to send back but this is now always null and you should instead call generateSyncMessage after calling receiveSyncMessage to see if there are new messages to send.
- Defined in node_modules/.pnpm/@[email protected]/node_modules/@automerge/automerge/dist/implementation.d.ts:527