Class Sync1BinaryWrapper

Wraps a Sync1BinaryInterface that implements the Sync1Interface needed by sync1!Syncer1.

Implements

Sync1Interface

Index

Constructors

Methods

sendUpdate subscribe

Constructors

constructor

new Sync1BinaryWrapper(
binaryInterface: Sync1BinaryInterface,
): Sync1BinaryWrapper
Parameters
- binaryInterface: Sync1BinaryInterface
Returns Sync1BinaryWrapper
- Defined in packages/leaf/src/sync-proto.ts:35

Methods

sendUpdate

sendUpdate(entityId: `leaf:${string}`, update: Uint8Array): void
Send an update for a given entity. This must be called to send local changes to remote peers.
Parameters
- entityId: `leaf:${string}`
- update: Uint8Array
Returns void
Implementation of Sync1Interface.sendUpdate
- Defined in packages/leaf/src/sync-proto.ts:76

subscribe(
    entityId: `leaf:${string}`,
    snapshot: Uint8Array,
    handleUpdate: Subscriber,
): () => void
Subscribe to updates for a given entity.

Every time the sync interface has an update for the entity it will call handleUpdate, passing it the entity ID and the update.
Parameters
- entityId: `leaf:${string}`
  The entity ID to subscribe to.
- snapshot: Uint8Array
- handleUpdate: Subscriber
  The handler function to be invoked when the sync interface has a new update.
Returns () => void
Returns a function that may be called to unsubscribe.
Implementation of Sync1Interface.subscribe
- Defined in packages/leaf/src/sync-proto.ts:49