Skip to content

Interface

The version of a widget.

Inheritance: WidgetVersionVersion<WidgetUpgradeInfo>

Properties

Hide inherited properties
PropertyTypeNotes
description
inherited
string

The description of the version.

upgradeFullInfoboolean

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

version
inherited
string

The version number, which follows the semver version format.

description

inheritedinherited
Interface Property
description: string

The description of the version.

Inherited from Version.description

upgradeFullInfo

optional
Interface Property
upgradeFullInfo: boolean

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

version

inheritedinherited
Interface Property
version: string

The version number, which follows the semver version format.

Inherited from Version.version

Methods

Hide inherited methods
MethodReturnsNotes
upgrader(oldConfig, id)
inherited
WidgetUpgradeInfo | Promise<WidgetUpgradeInfo>

The upgrader function for this version.

upgrader

inheritedinherited
Interface Method
upgrader(oldConfigWidgetUpgradeInfo, idstring): WidgetUpgradeInfo | Promise<WidgetUpgradeInfo>

The upgrader function for this version.

Parameters
ParameterTypeNotes
oldConfigWidgetUpgradeInfo

The config of the old version.

idstring

This ID can be a widgetId, an actionConfig ID, or the "app", depending on where the config is from.

Returns 
WidgetUpgradeInfo | Promise<WidgetUpgradeInfo>

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.