/src/syncer/syncer_types.ts | earthstar@v10.0.1

import * as earthstar from "https://deno.land/x/earthstar@v10.0.1/src/syncer/syncer_types.ts";

Interfaces

I ISyncPartner	Provides a syncer with the means to connect the peer being synced with (the partner).
I SyncerOpts	Options to initialise a Syncer with.

Type Aliases

T AttachmentTransferOpts
T AttachmentTransferProgressEvent
T AttachmentTransferReport
T AttachmentTransferStatus
T DocThumbnail	A short string with a timestamp and hash of the document's path and author.
T GetTransferOpts
T RangeMessage
T SyncAgentAbortEvent
T SyncAgentDocEvent	An event with an Earthstar document and corresponding ID.
T SyncAgentEvent	A type of message one SyncAgent can send to another.
T SyncAgentFulfilledEvent	An event sent when a SyncAgent doesn't want anything anymore, though it'll still serve HAVE requests.
T SyncAgentHaveEvent
T SyncAgentOpts
T SyncAgentPruneEvent	A special event for the implementation of a PlumTree. Asks the recipient to begin lazily messaging us.
T SyncAgentRangeMessageEvent	An event to be passed on to a RangeMessenger
T SyncAgentStatus	The current status of a SyncAgent.
T SyncAgentWantAttachmentEvent
T SyncAgentWantEvent	Signals that a SyncAgent wants a document/documents from another SyncAgent
T SyncAppetite	An 'appetite' which determines when the syncer will stop syncing. `once` - The syncer will only attempt to reconcile existing docs and then stop. `continuous` - Indefinite syncing, including existing docs and new ones as they are ingested into the replica.
T SynceAgentNewAttachmentEvent
T SyncerDiscloseEvent	An event for disclosing which shares a Peer has without actually revealing them. Another peer can use the salt to hash their own shares' addresses and see if they match.
T SyncerEvent	An event a Syncer can send or receive.
T SyncerFulfilledEvent
T SyncerHeartbeat
T SyncerStatus	A map of sync statuses by the share address they're associated with.
T SyncerSyncAgentEvent	A SyncAgentEvent addressed to a specific share address.