Interface
The version of a widget.
Properties
Property | Type | Notes |
---|---|---|
description inherited | string | The description of the version. |
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. |
upgradeFullInfo
upgradeFullInfo: boolean
If a version needs to upgrade full info (widgetJson and outputDataSourceJsons), it should set "upgradeFullInfo" to true.
upgrader
upgrader: (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>
version
version: string
The version number, which follows the semver version format.