class Earthstar.Peer
implements IPeer
Re-export
import { Earthstar } from "https://deno.land/x/earthstar_replica_server@4.0.0-beta.1/deps.ts";
const { Peer } = Earthstar;
Holds many shares' replicas and manages their synchronisation with other peers. Recommended as the point of contact between your application and Earthstar shares.
Properties
private
replicaEventBus: BlockingBus<Map<ShareAddress, Replica>>Methods
addReplica(replica: Replica): Promise<void>
addSyncPartner<I, F>()
Begin syncing using an instance implementing ISyncPartner. Use this if you don't want to sync with a local peer or a replica server.
getReplica(ws: ShareAddress): Replica | undefined
onReplicasChange(callback: (map: Map<ShareAddress, Replica>) => void | Promise<void>)
Fires a given callback whenever the Peer's store of replicas changes.
onSyncersChange(callback: (map: Map<string, { description: string; syncer: Syncer<unknown, unknown>; }>) => void | Promise<void>): () => void
Fires a given callback whenever a new syncer is added to the peer.
removeReplica(replica: Replica): Promise<void>