Skip to main content
Module

x/earthstar/src/replica/replica-types.ts

A specification and Javascript library for building online tools you can truly call your own.
earthstar-project/earthstar
Popular
Go to Latest
import * as earthstar from "https://deno.land/x/earthstar@v9.3.3/src/replica/replica-types.ts";

Interfaces

A replica of a share's data, used to read, write, and synchronise data to. Should be closed using the close method when no longer being used.

A replica driver provides low-level access to actual replica and is used by IReplica to actually load and save data. ReplicaDrivers are not meant to be used directly by users; let the Replica talk to it for you.

Type Aliases

  • IngestEventSuccess — a new doc was written
  • IngestEventFailure — refused an invalid doc
  • IngestEventNothingHappened — ingested an obsolete or duplicate doc
  • DocAlreadyExists — processing an old doc as you catch up
  • IdleEvent — reached the end of existing docs; waiting for new docs
  • IngestEvent — the result of a replica ingesting a document
  • ReplicaEventWillClose — the replica is about to close
  • ReplicaEventDidClose — the replica has closed
  • QueryFollowerDidClose — the query follower was closed (can happen on its own or after the replica closes)