Class Syncer1

A syncer that can be used to keep Entitys up-to-date with other peers across a sync interface.

Index

Constructors

constructor

new Syncer1(sync: Sync1Interface): Syncer1
Create a new syncer using the provided Sync1Interface.
Parameters
- sync: Sync1Interface
Returns Syncer1
- Defined in packages/leaf/src/sync1.ts:83

Properties

inter

inter: Sync1Interface

syncing

syncing: Map<
    `leaf:${string}`,
    {
        awaitInitialLoad: Promise<void>;
        entity: MaybeWeakEntity;
        unsubscribe: () => void;
    },
>

Methods

sync

sync(entityRef: Entity | WeakRef<Entity>): void
Start syncing an entity. All local updates will be pushed to peers, and incoming changes will be automatically merged into the entity.
Parameters
- entityRef: Entity | WeakRef<Entity>
Returns void
- Defined in packages/leaf/src/sync1.ts:96

unsync

unsync(id: `leaf:${string}`): void
Stop syncing an entity.
Parameters
- id: `leaf:${string}`
Returns void
- Defined in packages/leaf/src/sync1.ts:166

Class Syncer1

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Syncer1

Properties

inter

syncing

Methods

sync

Parameters

Returns void

unsync

Parameters

Returns void

Settings

On This Page