/index.ts | automerge@2.2.2

import * as automerge from "https://deno.land/x/automerge@2.2.2/index.ts";

Namespaces

Classes

c Counter	The most basic CRDT: an integer value that can be changed only by incrementing and decrementing. Since addition of integers is commutative, the value trivially converges.
c Float64
c Int
c next.Counter	The most basic CRDT: an integer value that can be changed only by incrementing and decrementing. Since addition of integers is commutative, the value trivially converges.
c next.Float64
c next.Int
c next.RawString
c next.Uint
c Text
c Uint

Variables

v next.getBackend
v uuid

Functions

f applyChanges	Apply changes received from another document
f change	Update the contents of an automerge document
f changeAt	Make a change to the document as it was at a particular point in history
f clone	Make a full writable copy of an automerge document
f decodeChange
f decodeSyncMessage
f decodeSyncState	Decode some binary data into a SyncState
f deleteAt	Function for use in change which deletes values from a list at a given index
f diff	Create a set of patches representing the change from one set of heads to another
f dump
f emptyChange	Make a change to a document which does not modify the document
f encodeChange
f encodeSyncMessage
f encodeSyncState	encode a SyncState into binary to send over the network
f equals
f free	Explicity free the memory backing a document. Note that this is note necessary in environments which support `FinalizationRegistry`
f from	Create an automerge document from a POJO
f generateSyncMessage	Generate a sync message to send to the peer represented by `inState`
f getActorId	Get the actor ID associated with the document
f getAllChanges	Get all the changes in a document
f getBackend
f getChanges	Get the changes which are in `newState` but not in `oldState`. The returned changes can be loaded in `oldState` via applyChanges.
f getConflicts	Get the conflicts associated with a property
f getHeads	Get the hashes of the heads of this document
f getHistory
f getLastLocalChange	Get the binary representation of the last change which was made to this doc
f getMissingDeps	Get any changes in `doc` which are not dependencies of `heads`
f getObjectId	Return the object ID of an arbitrary javascript value
f init	Create a new automerge document
f initSyncState	Create a new, blank SyncState
f insertAt	Function for use in change which inserts values into a list at a given index
f isAutomerge
f load	Load an automerge document from a compressed document produce by save
f loadIncremental	Load changes produced by saveIncremental, or partial changes
f merge	Merge `remote` into `local`
f next.applyChanges	Apply changes received from another document
f next.block	Get the block marker at the given index
f next.change	Update the contents of an automerge document
f next.changeAt	Make a change to the document as it was at a particular point in history
f next.clone	Make a full writable copy of an automerge document
f next.decodeChange
f next.decodeSyncMessage
f next.decodeSyncState	Decode some binary data into a SyncState
f next.deleteAt	Function for use in change which deletes values from a list at a given index
f next.diff	Create a set of patches representing the change from one set of heads to another
f next.dump
f next.emptyChange	Make a change to a document which does not modify the document
f next.encodeChange
f next.encodeSyncMessage
f next.encodeSyncState	encode a SyncState into binary to send over the network
f next.equals
f next.free	Explicity free the memory backing a document. Note that this is note necessary in environments which support `FinalizationRegistry`
f next.from	Create an automerge document from a POJO
f next.generateSyncMessage	Generate a sync message to send to the peer represented by `inState`
f next.getActorId	Get the actor ID associated with the document
f next.getAllChanges	Get all the changes in a document
f next.getChanges	Get the changes which are in `newState` but not in `oldState`. The returned changes can be loaded in `oldState` via applyChanges.
f next.getConflicts	Get the conflicts associated with a property
f next.getCursor	Returns a cursor for the given position in a string.
f next.getCursorPosition	Returns the current index of the cursor.
f next.getHeads	Get the hashes of the heads of this document
f next.getHistory
f next.getLastLocalChange	Get the binary representation of the last change which was made to this doc
f next.getMissingDeps	Get any changes in `doc` which are not dependencies of `heads`
f next.getObjectId	Return the object ID of an arbitrary javascript value
f next.init	Create a new automerge document
f next.initSyncState	Create a new, blank SyncState
f next.insertAt	Function for use in change which inserts values into a list at a given index
f next.isAutomerge
f next.joinBlock	Delete the block marker at the given index
f next.load	Load an automerge document from a compressed document produce by save
f next.loadIncremental	Load changes produced by saveIncremental, or partial changes
f next.mark
f next.marks
f next.marksAt
f next.merge	Merge `remote` into `local`
f next.receiveSyncMessage	Update a document and our sync state on receiving a sync message
f next.save	Export the contents of a document to a compressed format
f next.saveIncremental	Create binary save data to be appended to a save file or fed into loadIncremental
f next.saveSince
f next.spans	Return the text + block markers at a given path
f next.splice	Modify a string
f next.splitBlock	Insert a new block marker at the given index
f next.toJS
f next.unmark
f next.updateBlock	Update the block marker at the given index
f next.updateSpans	Update the spans at the given path
f next.updateText	Update the value of a string
f next.view	Make an immutable view of an automerge document as at `heads`
f receiveSyncMessage	Update a document and our sync state on receiving a sync message
f save	Export the contents of a document to a compressed format
f saveIncremental	Create binary save data to be appended to a save file or fed into loadIncremental
f saveSince
f toJS
f use
f view	Make an immutable view of an automerge document as at `heads`

Interfaces

I List	A List is an extended Array that adds the two helper methods `deleteAt` and `insertAt`.
I next.MarkSet
I State

Type Aliases

T ActorId
T API
T ApplyOptions	Options passed to loadIncremental, applyChanges, and receiveSyncMessage
T AutomergeValue
T Change
T ChangeAtResult	The type returned from changeAt
T ChangeFn	Function which is called by change when making changes to a `Doc<T>`
T ChangeOptions	Options passed to change, and emptyChange
T Conflicts	The type of conflicts for particular key or index
T DecodedChange
T DecodedSyncMessage
T DelPatch
T Doc	An automerge document.
T Heads
T IncPatch
T InitOptions	Options to be passed to init or load
T InsertPatch
T MaterializeValue
T next.ActorId
T next.ApplyOptions	Options passed to loadIncremental, applyChanges, and receiveSyncMessage
T next.AutomergeValue
T next.Change
T next.ChangeAtResult	The type returned from changeAt
T next.ChangeFn	Function which is called by change when making changes to a `Doc<T>`
T next.ChangeOptions	Options passed to change, and emptyChange
T next.Cursor
T next.DecodedChange
T next.DecodedSyncMessage
T next.DelPatch
T next.Doc	An automerge document.
T next.Heads
T next.IncPatch
T next.InitOptions
T next.InsertPatch
T next.Mark
T next.MarkPatch
T next.MarkRange
T next.MarkValue
T next.MaterializeValue
T next.Patch
T next.PatchCallback	Callback which is called by various methods in this library to notify the user of what changes have been made.
T next.PatchInfo
T next.PatchSource
T next.Prop
T next.PutPatch
T next.ScalarValue
T next.Span
T next.SpliceTextPatch
T next.SyncMessage
T next.SyncState	An opaque type tracking the state of sync with a remote peer
T ObjID
T Patch
T PatchCallback	Callback which is called by various methods in this library to notify the user of what changes have been made.
T PatchInfo
T PatchSource
T Prop
T PutPatch
T ScalarValue
T SpliceTextPatch
T SyncMessage
T SyncState	An opaque type tracking the state of sync with a remote peer

Namespaces

The next API

Classes

Variables

Functions

Interfaces

Type Aliases