WidgetVersion

Interface

The version of a widget.

Inheritance: WidgetVersionVersion<WidgetUpgradeInfo>

Hide inherited properties

Property	Type	Notes
`description` inherited	`string`	The description of the version.
`upgradeFullInfo`	`boolean`	If a version needs to upgrade full info (widgetJson and outputDataSourceJsons), it should set "upgradeFullInfo" to true.
`upgrader` inherited	`(oldConfig: WidgetUpgradeInfo, id: string) => WidgetUpgradeInfo \| Promise<WidgetUpgradeInfo>`	The upgrader function for this version.
`version` inherited	`string`	The version number, which follows the semver version format.

inheritedinherited

Interface Property

description: string

The description of the version.

optional

Interface Property

upgradeFullInfo: boolean

If a version needs to upgrade full info (widgetJson and outputDataSourceJsons), it should set "upgradeFullInfo" to true.

inheritedinherited

Interface Property

upgrader: (oldConfig: WidgetUpgradeInfo, id: string) => WidgetUpgradeInfo | Promise<WidgetUpgradeInfo>

The upgrader function for this version.

function(oldConfig: WidgetUpgradeInfo, id: string): WidgetUpgradeInfo | Promise<WidgetUpgradeInfo>

Parameter	Type	Notes
`oldConfig`	WidgetUpgradeInfo	The config of the old version.
`id`	string	This ID can be a widgetId, an actionConfig ID, or the "app", depending on where the config is from.

WidgetUpgradeInfo | Promise<WidgetUpgradeInfo>

inheritedinherited

Interface Property

version: string

The version number, which follows the semver version format.