ApiCoreInterfaces
Interface: SyncEngineConfig
Defined in: packages/core/src/sync/sync-engine.ts:47
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
files? | readonly | (peerId, message) => Promise<void> | Where a files message from a peer goes (spec 05 §16.6); without it, they are dropped | packages/core/src/sync/sync-engine.ts:65 |
heartbeatInterval? | readonly | number | - | packages/core/src/sync/sync-engine.ts:55 |
holds? | readonly | () => Holds | What this node holds, asked afresh for every hello. Default: everything. | packages/core/src/sync/sync-engine.ts:63 |
self? | readonly | string | This node's id among its peers; of two peers, the one that sorts first starts reconciling. Without it this node always starts, sometimes doubling the work. | packages/core/src/sync/sync-engine.ts:54 |
sendToPeer | readonly | (peerId, message) => void | - | packages/core/src/sync/sync-engine.ts:49 |
storageProvider | readonly | StorageProvider | - | packages/core/src/sync/sync-engine.ts:48 |
validate? | readonly | (version) => Promise<IncomingValidation> | Gatekeeper for versions from peers, typically createVersionCheck. What it rejects is dropped and surfaces as rejected. Without it, everything is accepted: only for a trusted transport or a test. | packages/core/src/sync/sync-engine.ts:61 |