Skip to main content

Function: parseStateSyncFullSyncResult()

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

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

Parses a candidate into a StateSyncFullSyncResult.

Parametersโ€‹

candidateโ€‹

unknown

Value to parse.

Returnsโ€‹

{ completedAt: number; siteCount: number; sites: Site[]; source: "cache" | "database" | "frontend"; synchronized: boolean; }

The validated full sync result when successful.

completedAtโ€‹

completedAt: number

siteCountโ€‹

siteCount: number

sitesโ€‹

sites: Site[]

sourceโ€‹

source: "cache" | "database" | "frontend"

synchronizedโ€‹

synchronized: boolean

Throwsโ€‹

https://zod.dev/basics?id=handling-errors When validation fails.