Class BackupService

Default implementation of the backup service.

Implements

BackupServiceInterface

Index

Constructors

Properties

isCreatingBackup isRestoringBackup

Methods

createBackup delete init resolveBackupResource resolveData resolveTransports restore

Constructors

constructor

new BackupService(): BackupService
Returns BackupService
- Defined in src/backup/backup.service.ts:35

Properties

`Readonly`isCreatingBackup

isCreatingBackup: BehaviorSubject<boolean> = ...

A subject that contains whether or not a backup is currently being created.

`Readonly`isRestoringBackup

isRestoringBackup: BehaviorSubject<boolean> = ...

A subject that contains whether or not a backup is currently being restored.

Methods

createBackup

createBackup(data?: BackupCreateData): Promise<void>
Starts a new backup based on the given configuration.
Parameters
- Optionaldata: BackupCreateData
Returns Promise<void>
Implementation of BackupServiceInterface.createBackup
- Defined in src/backup/backup.service.ts:64

delete

delete(backup: BackupEntity): Promise<void>
Deletes the given backup.
Parameters
- backup: BackupEntity
Returns Promise<void>
Implementation of BackupServiceInterface.delete
- Defined in src/backup/backup.service.ts:137

init

init(): Promise<void>
Initializes the service.

Returns Promise<void>
Implementation of BackupServiceInterface.init
- Defined in src/backup/backup.service.ts:40

resolveBackupResource

resolveBackupResource(
resource: BackupResourceEntity,
): undefined | Newable<BackupResourceInterface>
Resolves a backup resource based on the given entity.
Parameters
- resource: BackupResourceEntity
Returns undefined | Newable<BackupResourceInterface>
Implementation of BackupServiceInterface.resolveBackupResource
- Defined in src/backup/backup.service.ts:160

resolveData

resolveData(
    transports: BackupTransportInterface[],
    resource: BackupResourceEntity,
    backup: BackupEntity,
): Promise<Readable>
Resolves the actual backed up data for the given resource and transports.
Parameters
- transports: BackupTransportInterface[]
- resource: BackupResourceEntity
- backup: BackupEntity
Returns Promise<Readable>
Implementation of BackupServiceInterface.resolveData
- Defined in src/backup/backup.service.ts:175

resolveTransports

resolveTransports(
resource: BackupResourceEntity,
): undefined | BackupTransportInterface[]
Resolve the transports for the given backup resource.
Parameters
- resource: BackupResourceEntity
Returns undefined | BackupTransportInterface[]
Implementation of BackupServiceInterface.resolveTransports
- Defined in src/backup/backup.service.ts:165

restore

restore(backup: BackupEntity): Promise<void>
Restores the given backup.
Parameters
- backup: BackupEntity
Returns Promise<void>
Implementation of BackupServiceInterface.restore
- Defined in src/backup/backup.service.ts:106