@statesync/persistence

---

@statesync/persistence / CrossTabMessage

Type Alias: CrossTabMessage<T>

type CrossTabMessage<T> = 
  | {
  payload: SnapshotEnvelope<T>;
  tabId: string;
  type: "snapshot";
}
  | {
  tabId: string;
  type: "request-sync";
}
  | {
  tabId: string;
  type: "clear";
};

Defined in: persistence/src/cross-tab.ts:12

Discriminated union of messages exchanged between tabs via BroadcastChannel.

Each variant carries a type discriminator, a tabId identifying the sender, and (for 'snapshot') the actual state payload.

Type Parameters

Type Parameter	Description
T	The shape of the application state.

Type Declaration

{
  payload: SnapshotEnvelope<T>;
  tabId: string;
  type: "snapshot";
}

payload

payload: SnapshotEnvelope<T>;

The snapshot envelope being broadcast.

tabId

tabId: string;

Unique identifier of the sending tab.

type

type: "snapshot";

Indicates this message carries a full snapshot.

{
  tabId: string;
  type: "request-sync";
}

tabId

tabId: string;

Unique identifier of the sending tab.

type

type: "request-sync";

Indicates the sender is requesting the latest state from peers.

{
  tabId: string;
  type: "clear";
}

tabId

tabId: string;

Unique identifier of the sending tab.

type

type: "clear";

Indicates the sender has cleared its persisted storage.