BackupManager | @devnote-dev/pterojs

Hierarchy

BaseManager
- BackupManager

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new BackupManager(client: PteroClient, serverId: string): BackupManager

Overrides BaseManager.constructor
- Defined in src/client/BackupManager.ts:31
Parameters
- client: PteroClient
- serverId: string
Returns BackupManager

Properties

cache

cache: Dict<string, Backup>

client

client: PteroClient

serverId

serverId: string

Accessors

FILTERS

get FILTERS(): readonly never[]

Overrides BaseManager.FILTERS
- Defined in src/client/BackupManager.ts:17
Allowed filter arguments for backups (none).

Returns readonly never[]

INCLUDES

get INCLUDES(): readonly never[]

Overrides BaseManager.INCLUDES
- Defined in src/client/BackupManager.ts:22
Allowed include arguments for backups (none).

Returns readonly never[]

SORTS

get SORTS(): readonly never[]

Overrides BaseManager.SORTS
- Defined in src/client/BackupManager.ts:27
Allowed sort arguments for backups (none).

Returns readonly never[]

Methods

_patch

_patch(data: any): any

- Defined in src/client/BackupManager.ts:43
Transforms the raw backup object(s) into typed objects.

Parameters
- data: any
  
  The resolvable backup object(s).
Returns any
The resolved backup object(s).

create

create(options?: CreateBackupOptions): Promise<Backup>

- Defined in src/client/BackupManager.ts:134
Creates a new backup on the server.
see
CreateBackupOptions.

example
```
const server = await client.servers.fetch('34740510');
await server.backups.create({ name: 'bungee-archive' })
 .then(console.log)
 .catch(console.error);
```
Parameters
- options: CreateBackupOptions = {}
  
  Create backup options.
Returns Promise<Backup>
The new backup.

delete

delete(id: string): Promise<void>

- Defined in src/client/BackupManager.ts:226
Deletes a specified backup.
example
```
const server = await client.servers.fetch('34740510');
await server.backups.delete('c4b9c4c7').catch(console.error);
```
Parameters
- id: string
  
  The UUID of the backup.
Returns Promise<void>

download

download(id: string, dest: string): Promise<void>

- Defined in src/client/BackupManager.ts:191
Fetches and saves a backup to a specified path on the system.
example
```
const server = await client.servers.fetch('34740510');
await server.backups.download('904df120', './bungee-archive.tar.gz')
 .catch(console.error);
```
Parameters
- id: string
  
  The UUID of the backup.
- dest: string
  
  The file path to save the backup to.
Returns Promise<void>

fetch

fetch(id: string, options?: Include<FetchOptions>): Promise<Backup>
fetch(options?: Include<FetchOptions>): Promise<Dict<number, Backup>>

Overrides BaseManager.fetch
- Defined in src/client/BackupManager.ts:88
Fetches a backup from the API by its identifier. This will check the cache first unless the force option is specified.
example
```
const server = await client.servers.fetch('34740510');
await server.backups.fetch({ perPage: 10 })
 .then(console.log)
 .catch(console.error);
```
Parameters
- id: string
  
  The identifier of the backup.
- Optional options: Include<FetchOptions>
Returns Promise<Backup>
The fetched backup.
Overrides BaseManager.fetch
- Defined in src/client/BackupManager.ts:102
Fetches a list of backups from the API with the given options (default is undefined).
example
```
const server = await client.servers.fetch('34740510');
await server.backups.fetch({ perPage: 10 })
 .then(console.log)
 .catch(console.error);
```
Parameters
- Optional options: Include<FetchOptions>
Returns Promise<Dict<number, Backup>>
The fetched backups.

getDownloadURL

getDownloadURL(id: string): Promise<string>

- Defined in src/client/BackupManager.ts:173
Fetches the download URL for a specified backup.
example
```
const server = await client.servers.fetch('34740510');
await server.backups.getDownloadURL('904df120')
 .then(console.log)
 .catch(console.error);
```
Parameters
- id: string
  
  The UUID of the backup.
Returns Promise<string>
The download URL.

Protected getFetchAll

getFetchAll<T, K>(...options: unknown[]): Promise<Dict<T, K>>

Inherited from BaseManager.getFetchAll
- Defined in src/structures/BaseManager.ts:37
Fetches rach page and joins the results.

internal
Type Parameters
- T
- K
Parameters
- Rest ...options: unknown[]
Returns Promise<Dict<T, K>>
Dictionary of the specified types

getQueryOptions

getQueryOptions(): { filters: readonly string[]; includes: readonly string[]; sorts: readonly string[] }

Inherited from BaseManager.getQueryOptions
- Defined in src/structures/BaseManager.ts:24
Gets the allowed query options from the inherited manager.

internal
Returns { filters: readonly string[]; includes: readonly string[]; sorts: readonly string[] }
The query options.
- filters: readonly string[]
- includes: readonly string[]
- sorts: readonly string[]

restore

restore(id: string): Promise<void>

- Defined in src/client/BackupManager.ts:211
Restores a specified backup to the server.
example
```
const server = await client.servers.fetch('34740510');
await server.backups.restore('904df120').catch(console.error);
```
Parameters
- id: string
  
  The UUID of the backup.
Returns Promise<void>

toggleLock

toggleLock(id: string): Promise<Backup>

- Defined in src/client/BackupManager.ts:154
Toggles the locked status of a backup.
example
```
const server = await client.servers.fetch('34740510');
await server.backups.toggleLock('904df120')
 .then(console.log)
 .catch(console.error);
```
Parameters
- id: string
  
  The UUID of the backup.
Returns Promise<Backup>
The updated backup.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: PteroClient

serverId: string

Returns BackupManager

Properties

cache

client

meta

serverId

Accessors

FILTERS

Returns readonly never[]

INCLUDES

Returns readonly never[]

SORTS

Returns readonly never[]

Methods

_patch

Parameters

data: any

Returns any

create

Parameters

options: CreateBackupOptions = {}

Returns Promise<Backup>

delete

Parameters

id: string

Returns Promise<void>

download

Parameters

id: string

dest: string

Returns Promise<void>

fetch

Parameters

id: string

Optional options: Include<FetchOptions>

Returns Promise<Backup>

Parameters

Optional options: Include<FetchOptions>

Returns Promise<Dict<number, Backup>>

getDownloadURL

Parameters

id: string

Returns Promise<string>

Protected getFetchAll

Type Parameters

T

K

Parameters

Rest ...options: unknown[]

Returns Promise<Dict<T, K>>

getQueryOptions

Returns { filters: readonly string[]; includes: readonly string[]; sorts: readonly string[] }

filters: readonly string[]

includes: readonly string[]

sorts: readonly string[]

restore

Parameters

id: string

Returns Promise<void>

toggleLock

Parameters

id: string

Returns Promise<Backup>