Class FsBackupTransport

A transport that saves the data to the local file system.

Implements

BackupTransportInterface

Index

Constructors

Properties

Methods

deleteData retrieveData storeData

Constructors

constructor

new FsBackupTransport(name: string, backupBasePath: string): FsBackupTransport
Parameters
- name: string
- backupBasePath: string
Returns FsBackupTransport
- Defined in src/backup/transports/fs.backup-transport.ts:15

Properties

`Readonly`name

name: string

The name of the transport. Is used to resolve the transport when restoring backups, so this should not change.

Methods

deleteData

deleteData(backup: BackupEntity, resource: BackupResourceEntity): Promise<void>
Deletes the backup data of the given resource.
Parameters
- backup: BackupEntity
- resource: BackupResourceEntity
Returns Promise<void>
Implementation of BackupTransportInterface.deleteData
- Defined in src/backup/transports/fs.backup-transport.ts:35

retrieveData

retrieveData(
backup: BackupEntity,
resource: BackupResourceEntity,
): Readable | Promise<Readable>
Retrieves the backup data for the given resource.
Parameters
- backup: BackupEntity
- resource: BackupResourceEntity
Returns Readable | Promise<Readable>
Implementation of BackupTransportInterface.retrieveData
- Defined in src/backup/transports/fs.backup-transport.ts:29

storeData

storeData(
    data: Readable,
    backup: BackupEntity,
    resource: BackupResourceEntity,
): Promise<void>
Stores the given data somewhere.
Parameters
- data: Readable
- backup: BackupEntity
- resource: BackupResourceEntity
Returns Promise<void>
Implementation of BackupTransportInterface.storeData
- Defined in src/backup/transports/fs.backup-transport.ts:18