Class ClientDatabaseManager

Hierarchy

BaseManager
- ClientDatabaseManager

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

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

Properties

cache

cache: Dict<number, ClientDatabase>

client

client: PteroClient

meta

meta: PaginationMeta = ...

serverId

serverId: string

Accessors

FILTERS

get FILTERS(): readonly never[]

Overrides BaseManager.FILTERS
- Defined in src/client/ClientDatabaseManager.ts:15
Allowed filter arguments for databases (none).

Returns readonly never[]

INCLUDES

get INCLUDES(): readonly string[]

Overrides BaseManager.INCLUDES
- Defined in src/client/ClientDatabaseManager.ts:23
Allowed include arguments for databases:
- password
Returns readonly string[]

SORTS

get SORTS(): readonly never[]

Overrides BaseManager.SORTS
- Defined in src/client/ClientDatabaseManager.ts:28
Allowed sort arguments for databases (none).

Returns readonly never[]

Methods

_patch

_patch(data: any): any

- Defined in src/client/ClientDatabaseManager.ts:44
Transforms the raw database object(s) into typed objects.

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

create

create(database: string, remote: string): Promise<ClientDatabase>

- Defined in src/client/ClientDatabaseManager.ts:91
Creates a database on the server.

Parameters
- database: string
  
  The name of the database.
- remote: string
  
  The connections allowed to the database.
Returns Promise<ClientDatabase>
The new database.

delete

delete(id: number): Promise<void>

- Defined in src/client/ClientDatabaseManager.ts:127
Deletes a database from the server.
example
```
const server = await client.servers.fetch('1c639a86');
await server.databases.delete(2).catch(console.error);
```
Parameters
- id: number
  
  The ID of the database.
Returns Promise<void>

fetch

fetch(options?: Include<FetchOptions>): Promise<Dict<number, ClientDatabase>>

Overrides BaseManager.fetch
- Defined in src/client/ClientDatabaseManager.ts:73
Fetches a list of databases from the API with the given options (default is undefined).
example
```
const server = await client.servers.fetch('1c639a86');
await server.databases.fetch({ page: 2 })
 .then(console.log)
 .catch(console.error);
```
Parameters
- options: Include<FetchOptions> = {}
Returns Promise<Dict<number, ClientDatabase>>
The fetched databases.

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[]

rotate

rotate(id: number): Promise<ClientDatabase>

- Defined in src/client/ClientDatabaseManager.ts:111
Rotates the password of a specified database.
example
```
const server = await client.servers.fetch('1c639a86');
await server.databases.rotate(1)
 .then(console.log)
 .catch(console.error);
```
Parameters
- id: number
  
  The ID of the database.
Returns Promise<ClientDatabase>
The updated database.

Generated using TypeDoc