@vorlefan/prisma-backup/dist/modules/backup/index.d.ts

Export all the databse models into json files and use them as backup

import { BackupProps } from '../../types/backup';
/**
 * @function runBackup
 * @description save models objects into json
 * @param {Object} models each key is the filename
 * @param {String} password (optional) if encrypt is true, then requires the password
 * @param {Boolean} encrypt (optional, default = false) to encrypt file
 * @param {String} folder (optional, default = '.db') in which name will be folder that will gets all backup?
 * @param {Function} onRoute (optional) defines the route
 * @param {String} backupFolderName (optional, default = Date.now()) the name for backup folder that will be generated
 * @param {Boolean} compress (optional, default = false) compress the folder into a zip file?
 * @returns
 */
export declare function runBackup({ models, password, encrypt, folder, onRoute, backupFolderName, compress, }: BackupProps): Promise<boolean>;