Migration

core/migrate~ Migration

Configuration migration base class.

Classes that extend this class will specify the target version for the configuration object to upgrade to. The extended classes should have a constructor that takes no parameters exposed.

Constructor

new Migration(version, head)

Source:
Parameters:
Name Type Description
version string Target version.
head module:core/migrate~Migration Class of the previous migration.

Methods

migrate(config) → {Object}

Upgrade a configuration object to the target version and bump the version number to the target version.
Source:
Parameters:
Name Type Description
config Object The configuration object to be upgrade.
Returns:
Type:
Object
The upgraded configuration object, which is copied from the original configuration object.

upgrade(config) → {Object}

Upgrade a configuration object to the target version. Any class that extends this class must implement this method.
Source:
Parameters:
Name Type Description
config Object The configuration object to be upgrade.
Returns:
Type:
Object
The upgraded configuration object, which is copied from the original configuration object.