Skip to main content

Interface: UpdateDownloadedEvent

Extends​

Properties​

downloadedFile​

downloadedFile: string

files​

readonly files: UpdateFileInfo[]

Inherited from​

UpdateInfo.files

minimumSystemVersion?​

readonly optional minimumSystemVersion?: string

The minimum version of system required for the app to run. Sample value: macOS 23.1.0, Windows 10.0.22631. Same with os.release() value, this is a kernel version.

Inherited from​

UpdateInfo.minimumSystemVersion

packageFile?​

optional packageFile?: string

Path to the downloaded NSIS web installer package (package-<version>.7z). Only set for web installers.

path?​

readonly optional path?: string

Legacy top-level download descriptor for electron-updater 1.x – 2.15.0. Modern clients read files. Only emitted when electronUpdaterCompatibility includes legacy clients, so it may be absent.

Deprecated​

Inherited from​

UpdateInfo.path

releaseDate​

releaseDate: string

The release date.

Inherited from​

UpdateInfo.releaseDate

releaseName?​

optional releaseName?: string | null

The release name.

Inherited from​

UpdateInfo.releaseName

releaseNotes?​

optional releaseNotes?: string | ReleaseNoteInfo[] | null

The release notes. List if updater.fullChangelog is set to true, string otherwise.

Inherited from​

UpdateInfo.releaseNotes

sha512?​

readonly optional sha512?: string

Legacy top-level checksum for electron-updater 1.x – 2.15.0. Modern clients read files[].sha512. Only emitted when electronUpdaterCompatibility includes legacy clients, so it may be absent.

Deprecated​

Inherited from​

UpdateInfo.sha512

signature?​

readonly optional signature?: string

Base64-encoded Ed25519 signature over the manifest's integrity-critical fields, populated at publish time when update manifest signing is enabled. Verified by electron-updater against the configured updateManifestPublicKey before any download starts. See canonicalizeForSigning.

Always the signature of the first configured signing key; signatures carries the same value (tagged with its key id) plus one entry per additional signing key. Kept so updaters that only know this single-signature form keep verifying.

Inherited from​

UpdateInfo.signature

signatures?​

readonly optional signatures?: UpdateManifestSignature[]

One Ed25519 signature per signing key the manifest was signed with, each tagged with the id of the key that produced it (see computeUpdateManifestKeyId). All entries sign the same canonical payload. A manifest carrying several entries is "dual-signed": an install verifies it as long as any of its trusted keys matches any entry, which is what makes key rotation possible without a flag day.

Inherited from​

UpdateInfo.signatures

stagingPercentage?​

readonly optional stagingPercentage?: number

The staged rollout percentage, 0-100.

Inherited from​

UpdateInfo.stagingPercentage

version​

readonly version: string

The version.

Inherited from​

UpdateInfo.version