Interface CompanionStaticUpgradeResult<TConfig, TSecrets>

The result of an upgrade script

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

Type Parameters

TConfig extends JsonObject
TSecrets extends JsonObject | undefined

Index

Properties

updatedActions updatedConfig updatedFeedbacks updatedSecrets?

Properties

updatedActions

updatedActions: CompanionMigrationAction[]

Any changed actions

updatedConfig

updatedConfig: TConfig | null

The updated config, if any changes were made

updatedFeedbacks

updatedFeedbacks: CompanionMigrationFeedback[]

Any changed feedbacks

`Optional`updatedSecrets

updatedSecrets?: TSecrets | null

The updated secrets, if any changes were made