Class AppBackup

Base for all structures

Hierarchy (View Summary)

Base
- AppBackup

Index

Constructors

Properties

appId constructor data? discloudApp status? url

Methods

_clone _patch _update download

Constructors

constructor

new AppBackup(
discloudApp: DiscloudApp,
data: ApiAppBackup | ApiAppBackupAll,
): AppBackup
Parameters
- discloudApp: DiscloudApp
- data: ApiAppBackup | ApiAppBackupAll
Returns AppBackup
Overrides Base.constructor
- Defined in packages/discloud.app/src/structures/AppBackup.ts:27

Properties

`Readonly`appId

appId: string

Your app id

constructor

constructor: Constructor<AppBackup>

`Optional`data

data?: Buffer<ArrayBufferLike>

The backup Buffer

`Readonly`discloudApp

discloudApp: DiscloudApp

`Optional`status

status?: string

The backup status

url

url: string

The backup url.

You can access it only once.

Methods

`Protected`_clone

_clone(): this
Returns this
Inherited from Base._clone
- Defined in packages/discloud.app/src/structures/Base.ts:18

`Protected`_patch

_patch(data: Partial<ApiAppBackup | ApiAppBackupAll>): this
Parameters
- data: Partial<ApiAppBackup | ApiAppBackupAll>
Returns this
Overrides Base._patch
- Defined in packages/discloud.app/src/structures/AppBackup.ts:35

`Protected`_update

_update(data: unknown): this
Parameters
- data: unknown
Returns this
Inherited from Base._update
- Defined in packages/discloud.app/src/structures/Base.ts:26

download

download(path?: PathLike, fileName?: string): Promise<AppBackup>
Make backup of your application
Parameters
- path: PathLike = ...
  Backup path
- fileName: string = ...
  Backup file name
Returns Promise<AppBackup>
- Defined in packages/discloud.app/src/structures/AppBackup.ts:50