Interface
The version of a widget.
Inheritance: WidgetVersionVersion<WidgetUpgradeInfo>
Properties
| Property | Type | Notes |
|---|---|---|
descriptioninherited | string | The description of the version. |
boolean | If a version needs to upgrade full info (widgetJson and outputDataSourceJsons), it should set "upgradeFullInfo" to true. | |
upgraderinherited | (oldConfig: WidgetUpgradeInfo, id: string) => WidgetUpgradeInfo | Promise<WidgetUpgradeInfo> | The upgrader function for this version. |
versioninherited | string | The version number, which follows the semver version format. |
upgradeFullInfo
optional
Interface PropertyupgradeFullInfo: booleanIf a version needs to upgrade full info (widgetJson and outputDataSourceJsons), it should set "upgradeFullInfo" to true.
upgrader
inherited
Interface Propertyupgrader: (oldConfig: WidgetUpgradeInfo, id: string) => WidgetUpgradeInfo | Promise<WidgetUpgradeInfo>The upgrader function for this version.
Type declaration
function(oldConfig: WidgetUpgradeInfo, id: string): WidgetUpgradeInfo | Promise<WidgetUpgradeInfo>Parameters
| Parameter | Type | Notes |
|---|---|---|
old | 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. |
Returns
WidgetUpgradeInfo | Promise<WidgetUpgradeInfo>Inherited from Version.upgrader
version
inherited
Interface Propertyversion: stringThe version number, which follows the semver version format.
Inherited from Version.version
description: stringThe description of the version.