Skip to main content

Function: parseStateSyncFullSyncResult()

function parseStateSyncFullSyncResult(candidate: unknown): {
    completedAt: number;
    revision: number;
    siteCount: number;
    sites: Site[];
    source:
        | "cache"
        | "database"
        | "frontend"
        | "import"
        | "monitor-update";
    synchronized: boolean;
};

Defined in: shared/types/stateSync.ts:300

Parses a candidate into a StateSyncFullSyncResult.

Parameters​

candidate​

unknown

Value to parse.

Returns​

{
  completedAt: number;
  revision: number;
  siteCount: number;
  sites: Site[];
  source: "cache" | "database" | "frontend" | "import" | "monitor-update";
  synchronized: boolean;
}

The validated full sync result when successful.

completedAt​

completedAt: number;

revision​

revision: number;

siteCount​

siteCount: number;

sites​

sites: Site[];

source​

source: "cache" | "database" | "frontend" | "import" | "monitor-update";

synchronized​

synchronized: boolean;

Throws​

z.ZodError when validation fails.