Interface: SyncEngine
Defined in: packages/core/src/sync/sync-engine.ts:88
Methods
addPeer()
addPeer(peerId): void;Defined in: packages/core/src/sync/sync-engine.ts:100
Parameters
| Parameter | Type |
|---|---|
peerId | string |
Returns
void
ask()
ask(collection, ids): void;Defined in: packages/core/src/sync/sync-engine.ts:98
Asks every peer that holds the collection for these versions, by id, ahead of the rest
Parameters
| Parameter | Type |
|---|---|
collection | string |
ids | readonly string[] |
Returns
void
handleMessage()
handleMessage(peerId, message): Promise<void>;Defined in: packages/core/src/sync/sync-engine.ts:92
Handles whatever a peer sent; anything that is not a sync message this peer speaks is ignored.
Parameters
| Parameter | Type |
|---|---|
peerId | string |
message | unknown |
Returns
Promise<void>
levelWith()
levelWith(peerId): boolean;Defined in: packages/core/src/sync/sync-engine.ts:96
Whether the peer was last found level with this node, and this node has taken in nothing since
Parameters
| Parameter | Type |
|---|---|
peerId | string |
Returns
boolean
notifyPeers()
notifyPeers(peers): void;Defined in: packages/core/src/sync/sync-engine.ts:94
Says hello to these peers now, rather than at the next heartbeat.
Parameters
| Parameter | Type |
|---|---|
peers | readonly string[] |
Returns
void
off()
off<K>(event, callback): void;Defined in: packages/core/src/sync/sync-engine.ts:103
Type Parameters
| Type Parameter |
|---|
K extends keyof SyncEvents |
Parameters
| Parameter | Type |
|---|---|
event | K |
callback | SyncEvents[K] |
Returns
void
on()
on<K>(event, callback): void;Defined in: packages/core/src/sync/sync-engine.ts:102
Type Parameters
| Type Parameter |
|---|
K extends keyof SyncEvents |
Parameters
| Parameter | Type |
|---|---|
event | K |
callback | SyncEvents[K] |
Returns
void
onLocalChange()
onLocalChange(version): void;Defined in: packages/core/src/sync/sync-engine.ts:99
Parameters
| Parameter | Type |
|---|---|
version | Version |
Returns
void
removePeer()
removePeer(peerId): void;Defined in: packages/core/src/sync/sync-engine.ts:101
Parameters
| Parameter | Type |
|---|---|
peerId | string |
Returns
void
start()
start(): void;Defined in: packages/core/src/sync/sync-engine.ts:89
Returns
void
stop()
stop(): void;Defined in: packages/core/src/sync/sync-engine.ts:90
Returns
void