Class Backup

Implements

BackupAttributes

Index

Constructors

Properties

bytes checksum completed_at? created_at ignored_files is_locked is_successful name parentServer uuid

Methods

delete downloadStream downloadUrl lock restore unlock

Constructors

constructor

new Backup(userClient, backupProps, parentServer): Backup
Parameters
- userClient: UserClient
- backupProps: RawBackup
- parentServer: Server
Returns Backup
- Defined in src/UserClient/Backup.ts:20

Properties

`Readonly`bytes

bytes: number

`Readonly`checksum

checksum: null | string

`Optional` `Readonly`completed_at

completed_at?: string | Date

`Readonly`created_at

created_at: string | Date

`Readonly`ignored_files

ignored_files: string[]

is_locked

is_locked: false

`Readonly`is_successful

is_successful: true

`Readonly`name

name: string

`Readonly`parentServer

parentServer: Server

`Readonly`uuid

uuid: string

Methods

delete

delete(): Promise<void>
Delete this backup

Returns Promise<void>
- Defined in src/UserClient/Backup.ts:84

downloadStream

downloadStream(): Promise<Buffer>
Download this backup

Returns Promise<Buffer>
- Defined in src/UserClient/Backup.ts:45

downloadUrl

downloadUrl(): Promise<URL>
Get a one time download url this backup

Returns Promise<URL>
- Defined in src/UserClient/Backup.ts:37

lock

lock(): Promise<void>
Lock this backup

Returns Promise<void>
- Defined in src/UserClient/Backup.ts:68

restore

restore(deleteFiles?): Promise<void>
Restore this backup
Parameters
- deleteFiles: boolean = false
Returns Promise<void>
- Defined in src/UserClient/Backup.ts:54

unlock

unlock(): Promise<void>
Unlock this backup

Returns Promise<void>
- Defined in src/UserClient/Backup.ts:76