PresenceCoordinatorEvent | @sheetwrite/core

Connection or actor transition emitted by presence coordination.

Package: @sheetwrite/core
Source: packages/core/src/collaboration.ts#L55

Variants 4

{ type: "published"; message: PresenceMessageinterface PresenceMessage {
  actor: PresenceActor;
  activeSheet: string;
  selections: readonly Range[];
  sentAt: number;
}interface PresenceMessage {
  actor: PresenceActor;
  activeSheet: string;
  selections: readonly Range[];
  sentAt: number;
}interface PresenceMessage {
  actor: PresenceActor;
  activeSheet: string;
  selections: readonly Range[];
  sentAt: number;
}Ephemeral collaborator selection and activity update.API reference → }

{ type: "updated"; actorId: string }

{ type: "expired"; actorId: string }

{ type: "error"; error: SheetwriteErrorclass SheetwriteError
  extends Error
  implements SheetwriteErrorEnvelope
{
  constructor(
    code: SheetwriteErrorCode,
    operation: SheetwriteErrorOperation,
    message: string,
    options?: SheetwriteErrorOptions,
  );
  code:
    | "aborted"
    | "blocked"
    | "initialization-failed"
    | "initialization-required"
  // … 73 more lines — see the API reference
}class SheetwriteError
  extends Error
  implements SheetwriteErrorEnvelope
{
  constructor(
    code: SheetwriteErrorCode,
    operation: SheetwriteErrorOperation,
    message: string,
    options?: SheetwriteErrorOptions,
  );
  code:
    | "aborted"
    | "blocked"
    | "initialization-failed"
    | "initialization-required"
  // … 73 more lines — see the API reference
}class SheetwriteError
  extends Error
  implements
    SheetwriteErrorEnvelope
{
  constructor(
    code: SheetwriteErrorCode,
    operation: SheetwriteErrorOperation,
    message: string,
    options?: SheetwriteErrorOptions,
  );
  code:
    | "aborted"
    | "blocked"
    | "initialization-failed"
    | "initialization-required"
    | "datasource-request-failed"
    | "renderer-fallback"
    | "export-failed"
  // … 75 more lines — see the API reference
}Canonical envelope for thrown and callback-delivered Sheetwrite failures.API reference → }

Declaration

View full TypeScript declaration

export type PresenceCoordinatorEvent =
  | {
      type: "published";
      message: PresenceMessageinterface PresenceMessage {
  actor: PresenceActor;
  activeSheet: string;
  selections: readonly Range[];
  sentAt: number;
}interface PresenceMessage {
  actor: PresenceActor;
  activeSheet: string;
  selections: readonly Range[];
  sentAt: number;
}interface PresenceMessage {
  actor: PresenceActor;
  activeSheet: string;
  selections: readonly Range[];
  sentAt: number;
}Ephemeral collaborator selection and activity update.API reference →;
    }
  | {
      type: "updated";
      actorId: string;
    }
  | {
      type: "expired";
      actorId: string;
    }
  | {
      type: "error";
      error: SheetwriteErrorclass SheetwriteError
  extends Error
  implements SheetwriteErrorEnvelope
{
  constructor(
    code: SheetwriteErrorCode,
    operation: SheetwriteErrorOperation,
    message: string,
    options?: SheetwriteErrorOptions,
  );
  code:
    | "aborted"
    | "blocked"
    | "initialization-failed"
    | "initialization-required"
  // … 73 more lines — see the API reference
}class SheetwriteError
  extends Error
  implements SheetwriteErrorEnvelope
{
  constructor(
    code: SheetwriteErrorCode,
    operation: SheetwriteErrorOperation,
    message: string,
    options?: SheetwriteErrorOptions,
  );
  code:
    | "aborted"
    | "blocked"
    | "initialization-failed"
    | "initialization-required"
  // … 73 more lines — see the API reference
}class SheetwriteError
  extends Error
  implements
    SheetwriteErrorEnvelope
{
  constructor(
    code: SheetwriteErrorCode,
    operation: SheetwriteErrorOperation,
    message: string,
    options?: SheetwriteErrorOptions,
  );
  code:
    | "aborted"
    | "blocked"
    | "initialization-failed"
    | "initialization-required"
    | "datasource-request-failed"
    | "renderer-fallback"
    | "export-failed"
  // … 75 more lines — see the API reference
}Canonical envelope for thrown and callback-delivered Sheetwrite failures.API reference →;
    };