Interface
The version of a widget.
Properties
| Property | Type | Notes |
|---|---|---|
descriptioninherited | 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. |
versioninherited | string | The version number, which follows the semver version format. |
upgradeFullInfo
upgradeFullInfo: booleanIf a version needs to upgrade full info (widgetJson and outputDataSourceJsons), it should set "upgradeFullInfo" to true.
version
version: stringThe version number, which follows the semver version format.
Methods
| Method | Returns | Notes |
|---|---|---|
upgrader(oldConfig, id)inherited | WidgetUpgradeInfo | Promise<WidgetUpgradeInfo> | The upgrader function for this version. |
upgrader
upgrader(oldConfig: WidgetUpgradeInfo, id: string): WidgetUpgradeInfo | Promise<WidgetUpgradeInfo>The upgrader function for this version.
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>