PresenceCoordinatorOptions | @sheetwrite/core

Identity, privacy, and timing options for presence coordination.

Source: packages/core/src/collaboration.ts#L40

Members 7

actor

actor: PresenceActor;

privacy

privacy?: PresencePrivacyOptions;

heartbeatMs Publish/prune interval in milliseconds; defaults to 15,000.

heartbeatMs?: number;

Publish/prune interval in milliseconds; defaults to 15,000. Use 0 to disable the timer.

timeoutMs Idle receipt time before a remote actor expires; defaults to 45,000 milliseconds.

timeoutMs?: number;

maxActors Remote actors retained at once; defaults to 32 and is clamped to at least 1.

maxActors?: number;

maxRangesPerActor Selection ranges sent or accepted per actor; defaults to 8 and is clamped to at least 1.

maxRangesPerActor?: number;

now

now?: () => number;

Declaration

View full TypeScript declaration

export interface PresenceCoordinatorOptions {
  actor: PresenceActor;
  privacy?: PresencePrivacyOptions;
  heartbeatMs?: number;
  timeoutMs?: number;
  maxActors?: number;
  maxRangesPerActor?: number;
  now?: () => number;
}

Referenced by

Workspace packages depending on @sheetwrite/core

@sheetwrite/benchdependency
@sheetwrite/docs-startdependency
@sheetwrite/reactdependency
@sheetwrite/sveltedependency
@sheetwrite/vuedependency
@sheetwrite/xlsxdependency

Public exports naming PresenceCoordinatorOptions

PresenceCoordinator@sheetwrite/core

Loading documentation…