Skip to main content

Class: DocStackSyncHandle

Defined in: packages/client/src/core/sync/index.ts:752

Every stack's replication under one object.

Returned by DocStack.sync. Holds one StackSyncHandle per stack and re-dispatches their "status" events, so an application renders one badge from one listener however many databases it has open.

Example​

const sync = await docstack.sync({ remote: (stack) => driveFor(stack.name) });
sync.addEventListener("status", () => render(sync.getStatus()));

Extends​

  • EventTarget

Constructors​

Constructor​

new DocStackSyncHandle(): DocStackSyncHandle;

Defined in: node_modules/typescript/lib/lib.dom.d.ts:11586

Returns​

DocStackSyncHandle

Inherited from​

EventTarget.constructor

Properties​

PropertyModifierTypeDescriptionDefined in
handlesreadonlyMap<string, StackSyncHandle>One handle per stack, keyed by stack name.packages/client/src/core/sync/index.ts:754

Accessors​

names​

Get Signature​

get names(): string[];

Defined in: packages/client/src/core/sync/index.ts:767

The stacks this handle covers. What is missing from this list is not replicating - compare against DocStack.getStacks(), or use DocStack.getSyncCoverage() which does exactly that.

Returns​

string[]

Methods​

cancel()​

cancel(): void;

Defined in: packages/client/src/core/sync/index.ts:805

Cancels every stack's replication.

Returns​

void

getLastConvergedAt()​

getLastConvergedAt(): number;

Defined in: packages/client/src/core/sync/index.ts:794

The oldest convergence across all stacks - the honest answer to "when was everything last up to date". null while any stack has never converged.

Returns​

number

getStatus()​

getStatus(): Record<string, SyncStatus>;

Defined in: packages/client/src/core/sync/index.ts:782

Every stack's status, keyed by stack name.

Returns​

Record<string, SyncStatus>

restart()​

restart(): Promise<void>;

Defined in: packages/client/src/core/sync/index.ts:810

Restarts every stack's replication, re-resolving each remote.

Returns​

Promise<void>