PresenceCoordinator | @sheetwrite/core

Ephemeral presence lifecycle; it never calls a document mutation API.

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

Members 6

constructor

constructor(grid: Grid, transport: PresenceTransport, options: PresenceCoordinatorOptions);

destroy

destroy: () => void;

on

on: (listener: PresenceListener) => () => void;

pruneStale

pruneStale: () => void;

publishNow

publishNow: () => Promise<void>;

remotePresence

remotePresence: () => readonly PresenceMessage[]

Declaration

View full TypeScript declaration

class PresenceCoordinator {
  constructor(
    grid: Grid,
    transport: PresenceTransport,
    options: PresenceCoordinatorOptions,
  );
  destroy: () => void;
  on: (listener: PresenceListener) => () => void;
  pruneStale: () => void;
  publishNow: () => Promise<void>;
  remotePresence: () => readonly PresenceMessage[];
}

Referenced by

Workspace packages depending on @sheetwrite/core

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

Public exports naming PresenceCoordinator

None.

Loading documentation…