Automerge Repo - v2.3.0-alpha.0
    Preparing search index...

    Module @automerge/automerge-repo - v2.2.0

    The automerge CRDT provides a core CRDT data structure and an implementation of a storage format and sync protocol but doesn't provide the plumbing to use these tools in a JS application. automerge-repo provides the plumbing.

    The main entry point is the Repo class, which you instantiate with a StorageAdapter and zero or more NetworkAdapters. Once you have a repo you can use it to create DocHandles. DocHandles are a reference to a document, identified by a AutomergeUrl, a place to listen for changes to the document, and to make new changes.

    A typical example of how to use this library then might look like this:

    import { Repo } from "@automerge/automerge-repo";

    const repo = new Repo({
    storage: <storage adapter>,
    network: [<network adapter>, <network adapter>]
    })

    const handle = repo.create

    Classes

    DocHandle
    NetworkAdapter
    Repo
    StorageAdapter

    Interfaces

    DeleteDocumentPayload
    DocHandleChangePayload
    DocHandleDeletePayload
    DocHandleEncodedChangePayload
    DocHandleEphemeralMessagePayload
    DocHandleEvents
    DocHandleOutboundEphemeralMessagePayload
    DocHandleRemoteHeadsPayload
    DocumentPayload
    NetworkAdapterEvents
    NetworkAdapterInterface
    NetworkSubsystemEvents
    OpenPayload
    PeerCandidatePayload
    PeerDisconnectedPayload
    PeerMetadata
    PeerPayload
    RepoConfig
    RepoEvents
    StorageAdapterInterface

    Type Aliases

    ActorId
    AnyDocumentId
    AutomergeUrl
    BinaryDocumentId
    Change
    ChangeFn
    Chunk
    ChunkInfo
    ChunkType
    Counter
    Cursor
    Doc
    DocumentId
    DocumentUnavailableMessage
    EphemeralMessage
    HandleState
    HandleState
    Heads
    ImmutableString
    LegacyDocumentId
    Mark
    MarkRange
    MarkSet
    MarkValue
    Message
    ObjID
    Patch
    PatchCallback
    PeerId
    Prop
    RawString
    RepoMessage
    RequestMessage
    SessionId
    SharePolicy
    StorageId
    StorageKey
    SyncInfo
    SyncMessage
    UrlHeads

    Variables

    applyChanges
    Counter
    deleteAt
    getAllChanges
    getChanges
    getConflicts
    getCursor
    getCursorPosition
    getObjectId
    ImmutableString
    insertAt
    isImmutableString
    isRawString
    mark
    RawString
    splice
    unmark
    updateText
    view

    Functions

    decodeHeads
    documentIdToBinary
    encodeHeads
    generateAutomergeUrl
    interpretAsDocumentId
    isRepoMessage
    isValidAutomergeUrl
    isValidDocumentId
    parseAutomergeUrl
    stringifyAutomergeUrl