Automerge Repo - v2.6.0-alpha.3
    Preparing search index...

    Interface StorageAdapterInterface

    A storage adapter represents some way of storing binary data for a Repo

    StorageAdapters provide a key/value storage interface. The keys are arrays of strings (StorageKey) and the values are binary blobs.

    interface StorageAdapterInterface {
        close?(): void | Promise<void>;
        load(key: StorageKey): Promise<Uint8Array<ArrayBufferLike> | undefined>;
        loadRange(keyPrefix: StorageKey): Promise<Chunk[]>;
        remove(key: StorageKey): Promise<void>;
        removeRange(keyPrefix: StorageKey): Promise<void>;
        save(key: StorageKey, data: Uint8Array): Promise<void>;
    }

    Implemented by

    Index

    Methods

    close? load loadRange remove removeRange save

    Methods

    • Release any resources the adapter holds, such as an open database connection. Optional: Repo.shutdown calls it after the final flush. Adapters that hold no long-lived resource (in-memory, plain filesystem) can omit it.

      Returns void | Promise<void>

    • Load the single value corresponding to key

      Parameters

      Returns Promise<Uint8Array<ArrayBufferLike> | undefined>

    • Load all values with keys that start with keyPrefix.

      Parameters

      Returns Promise<Chunk[]>

      The keyprefix will match any key that starts with the given array. For example:

      • [documentId, "incremental"] will match all incremental saves
      • [documentId] will match all data for a given document.

      Be careful! [documentId] would also match something like [documentId, "syncState"]! We aren't using this yet but keep it in mind.)

    • Remove the value corresponding to key

      Parameters

      Returns Promise<void>

    • Remove all values with keys that start with keyPrefix

      Parameters

      Returns Promise<void>

    • Save the value data to the key key

      Parameters

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Methods