Interface CompanionStaticUpgradeResult<TConfig, TSecrets>

The result of an upgrade script

interface CompanionStaticUpgradeResult<TConfig, TSecrets = undefined> {
    updatedActions: CompanionMigrationAction[];
    updatedConfig: null | TConfig;
    updatedFeedbacks: CompanionMigrationFeedback[];
    updatedSecrets?: null | TSecrets;
}

Type Parameters

  • TConfig
  • TSecrets = undefined

Properties

updatedActions: CompanionMigrationAction[]

Any changed actions

updatedConfig: null | TConfig

The updated config, if any changes were made

updatedFeedbacks: CompanionMigrationFeedback[]

Any changed feedbacks

updatedSecrets?: null | TSecrets

The updated secrets, if any changes were made