Type alias BackupArgs<C>

BackupArgs<C>: {
    backend: Backend;
    backupId: string;
    config?: C;
    excludeCollections?: string[];
    includeCollections?: string[];
    waitForCompletion?: boolean;
}

The arguments required to create and restore backups.

Type Parameters

Type declaration

  • backend: Backend

    The backend to use for the backup.

  • backupId: string

    The ID of the backup.

  • Optional config?: C

    The configuration options for the backup.

  • Optional excludeCollections?: string[]

    The collections to exclude from the backup.

  • Optional includeCollections?: string[]

    The collections to include in the backup.

  • Optional waitForCompletion?: boolean

    Whether to wait for the backup to complete.