zibri
    Preparing search index...

    Interface BackupServiceInterface

    Interface for a backup service.

    interface BackupServiceInterface {
        createBackup: (data?: BackupCreateData) => Promise<void>;
        delete: (backup: BackupEntity) => Promise<void>;
        init: () => void | Promise<void>;
        isCreatingBackup: BehaviorSubject<boolean>;
        isRestoringBackup: BehaviorSubject<boolean>;
        resolveBackupResource: (
            resource: BackupResourceEntity,
        ) =>
            | Newable<BackupResourceInterface>
            | Promise<Newable<BackupResourceInterface> | undefined>
            | undefined;
        resolveData: (
            transports: BackupTransportInterface[],
            resource: BackupResourceEntity,
            backup: BackupEntity,
        ) => Readable | Promise<Readable>;
        resolveTransports: (
            resource: BackupResourceEntity,
        ) =>
            | BackupTransportInterface[]
            | Promise<BackupTransportInterface[] | undefined>
            | undefined;
        restore: (backup: BackupEntity) => Promise<void>;
        syncBackupEntities: () => Promise<void>;
    }

    Implemented by

    Index

    Properties

    createBackup delete init isCreatingBackup isRestoringBackup resolveBackupResource resolveData resolveTransports restore syncBackupEntities

    Properties

    createBackup: (data?: BackupCreateData) => Promise<void>

    Starts a new backup based on the given configuration.

    delete: (backup: BackupEntity) => Promise<void>

    Deletes the given backup.

    init: () => void | Promise<void>

    Initializes the service.

    isCreatingBackup: BehaviorSubject<boolean>

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

    isRestoringBackup: BehaviorSubject<boolean>

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

    resolveBackupResource: (
        resource: BackupResourceEntity,
    ) =>
        | Newable<BackupResourceInterface>
        | Promise<Newable<BackupResourceInterface> | undefined>
        | undefined

    Resolves a backup resource based on the given entity.

    resolveData: (
        transports: BackupTransportInterface[],
        resource: BackupResourceEntity,
        backup: BackupEntity,
    ) => Readable | Promise<Readable>

    Resolves the actual backed up data for the given resource and transports.

    resolveTransports: (
        resource: BackupResourceEntity,
    ) =>
        | BackupTransportInterface[]
        | Promise<BackupTransportInterface[] | undefined>
        | undefined

    Resolve the transports for the given backup resource.

    restore: (backup: BackupEntity) => Promise<void>

    Restores the given backup.

    syncBackupEntities: () => Promise<void>

    Synchronizes backup entities with the data from all transports.

    Settings

    Member Visibility

    On This Page

    Properties