Interface UseUpdateAvailableResult

interface UseUpdateAvailableResult {
    applyUpdate: () => void;
    checkNow: () => Promise<void>;
    currentVersion: string | null;
    latestVersion: string | null;
    updateAvailable: boolean;
}

Properties

applyUpdate: () => void

Apply the update by reloading the page. Equivalent to window.location.reload().

checkNow: () => Promise<void>

Imperatively trigger a re-check now (returns a promise that resolves after the fetch completes).

currentVersion: string | null

The version the hook is comparing against — either options.currentVersion (if provided) or the first poll's value.

latestVersion: string | null

The version reported by the latest successful poll, or null before the first poll.

updateAvailable: boolean

True when the latest polled version differs from the running version.