Skip to main content

Interface: SnapStoreOptions

Snap Store options. To publish directly to Snapcraft, see Snapcraft authentication options for local or CI/CD authentication options.

Extends​

Properties​

channels?​

readonly optional channels?: string | string[] | null

The list of channels the snap would be released.

Default​

["edge"]

maxUpdateInfoSize?​

readonly optional maxUpdateInfoSize?: number | null

The largest channel file (latest*.yml) electron-updater reads, in bytes: it is read into memory and parsed before anything verifies it. A larger one fails the update check with ERR_UPDATER_RESPONSE_TOO_LARGE. Release feeds and provider API responses (release listings and lookups) are not limited. Written into app-update.yml, so installed apps use it; autoUpdater.maxUpdateInfoSize overrides it at runtime. A positive integer, or 0 for no limit.

Default​

10485760

Inherited from​

PublishConfiguration.maxUpdateInfoSize


provider​

readonly provider: "snapStore"

The provider. Must be snapStore.

Overrides​

PublishConfiguration.provider


publishAutoUpdate?​

readonly optional publishAutoUpdate?: boolean

Whether to publish auto update info files.

Auto update relies only on the first provider in the list (you can specify several publishers). Thus, probably, theres no need to upload the metadata files for the other configured providers. But by default will be uploaded. A provider with falsenever becomes the feed embedded inapp-update.yml` while a later provider receives the metadata: the first provider that does is embedded instead.

Default​

true

Inherited from​

PublishConfiguration.publishAutoUpdate


repo?​

readonly optional repo?: string

snapcraft repo name


requestHeaders?​

readonly optional requestHeaders?: OutgoingHttpHeaders

Any custom request headers

Inherited from​

PublishConfiguration.requestHeaders


timeout?​

readonly optional timeout?: number | null

Request timeout in milliseconds. (Default is 2 minutes; O is ignored)

Default​

120000

Inherited from​

PublishConfiguration.timeout