All files / services/core settings-migration.interface.ts

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/**
 * A single settings migration. Migrations are run on every activation and must
 * therefore be idempotent: when there is nothing to migrate they must be a no-op.
 */
export interface ISettingsMigration {
	/** 
	 * Stable identifier, used for logging.
	 */
	readonly id: string;
 
	/**
	 * Human-readable description of what this migration does.
	 */
	readonly description: string;
 
	/**
	 * Performs the migration. Must be idempotent and safe to run on every activation.
	 */
	migrate(): Promise<void>;
}