Skip to content

Type Alias: PlasmaFileReadResult

PlasmaFileReadResult = { status: "local"; bytes: Uint8Array; mime: string; name?: string; } | { status: "uploading"; bytes: Uint8Array; mime: string; name?: string; } | { status: "ready"; bytes: Uint8Array; mime: string; name?: string; } | { status: "missing"; } | { status: "error"; cause: unknown; }

Defined in: client/src/sync/client.ts:367

Result of PlasmaClient.readFile(ref).

  • local: bytes are cached locally but no upload record exists — the ref arrived via pull and has already been resolved once on this tab.
  • uploading: bytes are cached locally and the upload worker is (or was) trying to send them to the server. Display can proceed from the local bytes while the transfer runs.
  • ready: bytes are cached locally and known present on the server (either uploaded from this tab or fetched fresh from the sync API).
  • missing: the ref is either broken (BrokenFileRef sentinel from a corrupt pull row) or the server returned 404. Callers should render a placeholder rather than retry indefinitely.
  • error: the sync API returned a non-404 error or the network call threw — retryable at the app layer.