Skip to main content

Interface: UpdateStatusEventData

Defined in: shared/types/events.ts:323

Payload for update status change events.

Remarks​

Used to communicate the current status of application updates, including errors. - error: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/Error message if status is 'error'.

  • status: The current update status.

Example​

const event: UpdateStatusEventData = {
    status: "downloaded",
};

Properties​

error?​

readonly optional error: string

Defined in: shared/types/events.ts:327

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/Error message if status is 'error'.

status​

readonly status: "error" | "available" | "checking" | "downloaded" | "downloading" | "idle"

Defined in: shared/types/events.ts:335

The current update status.

Remarks​

Can be 'available', 'checking', 'downloaded', 'downloading', 'error', or 'idle'.