Skip to main content
Module

x/earthstar/mod.ts>Peer#sync

Storage for private, distributed, offline-first applications.
Latest
method Peer.prototype.sync
Re-export
import { Peer } from "https://deno.land/x/earthstar@v10.2.2/mod.ts";

Begin synchronising with a remote or local peer.

Parameters

target: IPeer | string
  • A HTTP URL or Peer instance.
optional
continuous = [UNSUPPORTED]
  • Whether the connection should be kept open for new changes from the other peer, or stop after initial reconciliation. Defaults to false.
optional
formats: FormatsArg<F>
  • Optional. Which document formats to sync. Defaults to es.5.

Returns

Syncer<undefined, F>