Files
orca/src/preload/api/updater-api.ts
T
OrcaWinandOrcaWin 0efc842028 [comment audit] Shorten preload comments (#32257)
* chore: audit preload root comments and track repository coverage

* docs: track repository comment audit coverage

* chore: keep comment audit tracker local

* chore: shorten preload API contract comments

---------

Co-authored-by: OrcaWin <293788423+OrcaWin@users.noreply.github.com>
2026-10-23 02:16:59 -07:00

30 lines
1.1 KiB
TypeScript

import type {
LinuxPackageInstallInstructions,
ReleaseBuildListResult,
UpdateCheckOptions,
UpdateStatus
} from '../../shared/update-status-types'
import type { ReleaseChannel } from '../../shared/release-channel'
export type UpdaterApi = {
getVersion: () => Promise<string>
getStatus: () => Promise<UpdateStatus>
check: (options?: UpdateCheckOptions) => Promise<void>
download: () => Promise<void>
quitAndInstall: () => Promise<void>
dismissNudge: () => Promise<void>
dismissAvailableUpdate: () => Promise<void>
/** Desktop-only. Rejects unless the current status carries `linux-package-install` recovery. */
getLinuxPackageInstallInstructions: () => Promise<LinuxPackageInstallInstructions>
/** Desktop-only. Reveals the revalidated cached package in the native file manager. */
showLinuxPackage: () => Promise<void>
/** Use force to bypass the cache only for an explicit refresh. */
listBuilds: (
channel: ReleaseChannel,
options?: { force?: boolean }
) => Promise<ReleaseBuildListResult>
onStatus: (callback: (status: UpdateStatus) => void) => () => void
onClearDismissal: (callback: () => void) => () => void
}