SyncAgentOpts | /src/syncer/syncer_types.ts | earthstar@v10.0.0-alpha.4

Module

x/earthstar/src/syncer/syncer_types.ts>SyncAgentOpts

Earthstar is a tool for private, undiscoverable, offline-first networks.

earthstar-project/earthstar

Go to Latest

attachment_transfer.ts

AttachmentTransfer

doc_thumbnail_tree.ts

partner_web_client.ts

PartnerWebClient

partner_web_server.ts

EarthstarRangeMessenger

AttachmentTransferOpts

AttachmentTransferProgressEvent

AttachmentTransferReport

AttachmentTransferStatus

SyncAgentFulfilledEvent

SyncAgentHaveEvent

SyncAgentOpts

SyncAgentPruneEvent

SyncAgentRangeMessageEvent

SyncAgentStatus

SyncAgentWantAttachmentEvent

SyncAgentWantEvent

SyncAppetite

SynceAgentNewAttachmentEvent

type alias SyncAgentOpts

import { type SyncAgentOpts } from "https://deno.land/x/earthstar@v10.0.0-alpha.4/src/syncer/syncer_types.ts";

Options used for initialisng a SyncAgent.

replica: The replica to represent.
mode: Whether to sync only existing docs or keep the connection open for new docs too.

Type Parameters

definition: { replica: Replica; formats?: FormatsArg<F>; transferManager: TransferManager<F, unknown>; syncerManager: SyncerManager; syncAppetite: SyncAppetite; initiateMessaging: boolean; payloadThreshold: number; rangeDivision: number; }