Class RollbackManager

Rollback manager that orchestrates backup and rollback operations.

Combines file-level backups (BackupManager) with a git snapshot (GitIntegration) behind one interface for transformation safety.

Index

Constructors

Methods

clearBackups createBackup getCurrentStrategy hasBackup rollback

Constructors

constructor

new RollbackManager(config?: RollbackConfig): RollbackManager
Parameters
- config: RollbackConfig = {}
Returns RollbackManager

Methods

clearBackups

clearBackups(): Promise<void>
Clear all backups.

Returns Promise<void>

createBackup

createBackup(
files: string[],
options?: CreateBackupOptions,
): Promise<BackupOperationResult>
Back up files before a transformation. Always writes file-level backups (with metadata on disk, so another RollbackManager finds them); inside a git repository it also records a git snapshot of the working tree and stores its commit with every backup. Nothing in the working tree, the index or the stash list changes.
Parameters
- files: string[]
- options: CreateBackupOptions = {}
Returns Promise<BackupOperationResult>

getCurrentStrategy

getCurrentStrategy(): RollbackStrategy
Configured rollback strategy.

Returns RollbackStrategy

hasBackup

hasBackup(): boolean
Check if backup exists.

Returns boolean

rollback

rollback(files?: string[]): Promise<RollbackOperationResult>
Restore files from their newest backup. Without a file list it restores the files of this instance's backups, or else of the newest backup group on disk (the last transform-code call). The configured strategy decides the source: file backup, git snapshot, or file backup first (auto).
Parameters
- Optionalfiles: string[]
Returns Promise<RollbackOperationResult>