NodeManager | @devnote-dev/pterojs

Hierarchy

BaseManager
- NodeManager

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new NodeManager(client: PteroApp): NodeManager

Overrides BaseManager.constructor
- Defined in src/application/NodeManager.ts:62
Parameters
- client: PteroApp
Returns NodeManager

Properties

cache

cache: Dict<number, Node>

client

client: PteroApp

Accessors

FILTERS

get FILTERS(): readonly string[]

Overrides BaseManager.FILTERS
- Defined in src/application/NodeManager.ts:35
Allowed filter arguments for nodes:
- uuid
- name
- fqdn
- daemonTokenId
Returns readonly string[]

INCLUDES

get INCLUDES(): readonly string[]

Overrides BaseManager.INCLUDES
- Defined in src/application/NodeManager.ts:47
Allowed include arguments for nodes:
- allocations
- location
- servers
Note: not all of these include options have been implemented yet.
Returns readonly string[]

SORTS

get SORTS(): readonly string[]

Overrides BaseManager.SORTS
- Defined in src/application/NodeManager.ts:58
Allowed sort arguments for nodes:
- id
- uuid
- memory
- disk
Returns readonly string[]

Methods

_patch

_patch(data: any): any

- Defined in src/application/NodeManager.ts:80
Transforms the raw node object(s) into class objects.

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

adminURLFor

adminURLFor(id: number): string

- Defined in src/application/NodeManager.ts:128
Parameters
- id: number
  
  The ID of the node.
Returns string
The formatted URL to the node in the admin panel.

create

create(options: CreateNodeOptions): Promise<Node>

Creates a node.

see

CreateNodeOptions.

example

app.nodes.create({
 name: 'node04',
 locationId: 2,
 public: false,
 fqdn: 'n4.nodes.pterodactyl.test',
 scheme: 'https',
 behindProxy: false,
 memory: 1024,
 disk: 4000,
 daemonSftp: 2022,
 daemonListen: 8080,
 maintenanceMode: false
})
 .then(console.log)
 .catch(console.error);

Parameters

options: CreateNodeOptions

Create node options.

Returns Promise<Node>

The new node.

delete

delete(id: number): Promise<void>

- Defined in src/application/NodeManager.ts:355
Deletes a node. Note: there must be no servers on the node for this operation to work. Please ensure this before attempting to delete the node.
example
```
app.nodes.delete(3).catch(console.error);
```
Parameters
- id: number
  
  The ID of the node.
Returns Promise<void>

fetch

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

Overrides BaseManager.fetch
- Defined in src/application/NodeManager.ts:144
Fetches a node from the API by its ID. This will check the cache first unless the force option is specified.
example
```
app.nodes.fetch(2).then(console.log).catch(console.error);
```
Parameters
- id: number
  
  The ID of the node.
- Optional options: Include<FetchOptions>
Returns Promise<Node>
The fetched node.
Overrides BaseManager.fetch
- Defined in src/application/NodeManager.ts:158
Fetches a list of nodes from the API with the given options (default is undefined).
see
Include and FetchOptions.

example
```
app.nodes.fetch({ include:['servers'] })
 .then(console.log)
 .catch(console.error);
```
Parameters
- Optional options: Include<FetchOptions>
Returns Promise<Dict<number, Node>>
The fetched nodes.

fetchAll

fetchAll(options?: Include<Omit<FetchOptions, "page">>): Promise<Dict<number, Node>>

- Defined in src/application/NodeManager.ts:189
Fetches all nodes from the API with the given options (default is undefined).
see
Include and FetchOptions.

example
```
app.nodes.fetchAll({ include:['servers'] })
 .then(console.log)
 .catch(console.error);
```
Parameters
- Optional options: Include<Omit<FetchOptions, "page">>
Returns Promise<Dict<number, Node>>
The fetched nodes.

fetchDeployable

fetchDeployable(options: NodeDeploymentOptions): Promise<Dict<number, Node>>

- Defined in src/application/NodeManager.ts:208
Fetches the deployable nodes from the API following the specified deployable node options. Note that memory and disk are required for deployment options.
see
NodeDeploymentOptions.

example
```
app.nodes.fetchDeployable({ memory: 1024, disk: 4000 })
 .then(console.log)
 .catch(console.error);
```
Parameters
- options: NodeDeploymentOptions
  
  Deployable node options.
Returns Promise<Dict<number, Node>>
The deployable nodes.

getConfig

getConfig(id: number): Promise<NodeConfiguration>

- Defined in src/application/NodeManager.ts:276
Fetches the node configuration.
example
```
app.nodes.getConfig(2).then(console.log).catch(console.error);
```
Parameters
- id: number
  
  The ID of the node.
Returns Promise<NodeConfiguration>
The node configuration.

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

query

query(entity: string, options: Filter<{ sort?: string }>): Promise<Dict<number, Node>>

- Defined in src/application/NodeManager.ts:245
Queries the API for nodes that match the specified query filters. This fetches from the API directly and does not check the cache. Use cache methods for filtering and sorting.
Available query filters:
- uuid
- name
- fqdn
- daemonTokenId
Available sort options:
- id
- uuid
- memory
- disk
example
```
app.nodes.query('nodes.pterodactyl.test', { filter: 'daemonTokenId' })
 .then(console.log)
 .catch(console.error);
```
Parameters
- entity: string
  
  The entity to query.
- options: Filter<{ sort?: string }>
  
  The query options to filter by.
Returns Promise<Dict<number, Node>>
The queried nodes.

resolve

resolve(obj: Resolvable<Node>): undefined | Node

- Defined in src/application/NodeManager.ts:112
Resolves a node from an object. This can be:
- a string
- a number
- an object
Parameters
- obj: Resolvable<Node>
  
  The object to resolve from.
Returns undefined | Node
The resolved node or undefined if not found.

update

update(id: number, options: Partial<CreateNodeOptions>): Promise<Node>

- Defined in src/application/NodeManager.ts:327
Updates a node with the specified options.
see
CreateNodeOptions.

example
```
app.nodes.update(4, { maintenanceMode: true })
 .then(console.log)
 .catch(console.error);
```
Parameters
- id: number
  
  The ID of the node.
- options: Partial<CreateNodeOptions>
  
  Update node options.
Returns Promise<Node>
The updated node.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: PteroApp

Returns NodeManager

Properties

cache

client

meta

Accessors

FILTERS

Returns readonly string[]

INCLUDES

Returns readonly string[]

SORTS

Returns readonly string[]

Methods

_patch

Parameters

data: any

Returns any

adminURLFor

Parameters

id: number

Returns string

create

Parameters

options: CreateNodeOptions

Returns Promise<Node>

delete

Parameters

id: number

Returns Promise<void>

fetch

Parameters

id: number

Optional options: Include<FetchOptions>

Returns Promise<Node>

Parameters

Optional options: Include<FetchOptions>

Returns Promise<Dict<number, Node>>

fetchAll

Parameters

Optional options: Include<Omit<FetchOptions, "page">>

Returns Promise<Dict<number, Node>>

fetchDeployable

Parameters

options: NodeDeploymentOptions

Returns Promise<Dict<number, Node>>

getConfig

Parameters

id: number

Returns Promise<NodeConfiguration>

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

query

Parameters

entity: string

options: Filter<{ sort?: string }>

Returns Promise<Dict<number, Node>>

resolve

Parameters

obj: Resolvable<Node>

Returns undefined | Node