NodeAllocationManager | @devnote-dev/pterojs

Hierarchy

BaseManager
- NodeAllocationManager

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new NodeAllocationManager(client: PteroApp): NodeAllocationManager

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

Properties

cache

cache: Dict<number, Dict<number, Allocation>>

client

client: PteroApp

Accessors

FILTERS

get FILTERS(): readonly never[]

Overrides BaseManager.FILTERS
- Defined in src/application/NodeAllocationManager.ts:15
Allowed filter arguments for allocations.

Returns readonly never[]

INCLUDES

get INCLUDES(): readonly string[]

Overrides BaseManager.INCLUDES
- Defined in src/application/NodeAllocationManager.ts:20
Allowed include arguments for allocations.

Returns readonly string[]

SORTS

get SORTS(): readonly never[]

Overrides BaseManager.SORTS
- Defined in src/application/NodeAllocationManager.ts:25
Allowed sort arguments for allocations.

Returns readonly never[]

Methods

_patch

_patch(node: number, data: any): any

- Defined in src/application/NodeAllocationManager.ts:42
Parameters
- node: number
- data: any
Returns any

adminURLFor

adminURLFor(id: number): string

- Defined in src/application/NodeAllocationManager.ts:65
Parameters
- id: number
  
  The ID of the allocation.
Returns string
The formatted URL to the allocation in the admin panel.

create

create(node: number, ip: string, ports: string[]): Promise<void>

- Defined in src/application/NodeAllocationManager.ts:174
Creates a number of allocations based on the ports specified. Note that the created allocations will not be returned due to the number that can be created in a single request, which can cause unwanted issues.
example
```
app.allocations.create(4, '10.0.0.1', ['8000-9000'])
 .catch(console.error);
```
Parameters
- node: number
  
  The ID of the node.
- ip: string
  
  The IP for the allocation.
- ports: string[]
  
  A list of ports or port ranges for the allocation.
Returns Promise<void>

delete

delete(node: number, id: number): Promise<void>

- Defined in src/application/NodeAllocationManager.ts:213
Deletes an allocation from a node.
example
```
app.allocations.delete(4, 92).catch(console.error);
```
Parameters
- node: number
  
  The ID of the node.
- id: number
  
  The ID of the allocation.
Returns Promise<void>

fetch

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

Overrides BaseManager.fetch
- Defined in src/application/NodeAllocationManager.ts:84
Fetches a list of allocations on a specific node from the API with the given options (default is undefined).
see
Include and FetchOptions.

example
```
app.allocations.fetch(4, { page: 3 })
 .then(console.log)
 .catch(console.error);
```
Parameters
- node: number
- options: Include<FetchOptions> = {}
Returns Promise<Dict<number, Allocation>>
The fetched allocations.

fetchAll

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

- Defined in src/application/NodeAllocationManager.ts:115
Fetches all allocations on a specific node from the API with the given options (default is undefined).
see
Include and FetchOptions.

example
```
app.allocations.fetchAll().then(console.log).catch(console.error);
```
Parameters
- node: number
- Optional options: Include<Omit<FetchOptions, "page">>
Returns Promise<Dict<number, Allocation>>
The fetched allocations.

fetchAvailable

fetchAvailable(node: number, single: true): Promise<undefined | Allocation>
fetchAvailable(node: number, single: false): Promise<Dict<number, Allocation>>

- Defined in src/application/NodeAllocationManager.ts:134
Fetches the available allocations on a node and returns a single one.
example
```
app.allocations.fetchAvailable(4, true)
 .then(console.log)
 .catch(console.error);
```
Parameters
- node: number
  
  The ID of the node.
- single: true
  
  Whether to return a single allocation.
Returns Promise<undefined | Allocation>
The available allocation(s).
- Defined in src/application/NodeAllocationManager.ts:150
Fetches the available allocations on a node.
example
```
app.allocations.fetchAvailable(4, false)
 .then(all => all.forEach(a => console.log(a)))
 .catch(console.error);
```
Parameters
- node: number
  
  The ID of the node.
- single: false
  
  Whether to return a single allocation.
Returns Promise<Dict<number, Allocation>>
The available allocation(s).

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

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: PteroApp

Returns NodeAllocationManager

Properties

cache

client

meta

Accessors

FILTERS

Returns readonly never[]

INCLUDES

Returns readonly string[]

SORTS

Returns readonly never[]

Methods

_patch

Parameters

node: number

data: any

Returns any

adminURLFor

Parameters

id: number

Returns string

create

Parameters

node: number

ip: string

ports: string[]

Returns Promise<void>

delete

Parameters

node: number

id: number

Returns Promise<void>

fetch

Parameters

node: number

options: Include<FetchOptions> = {}

Returns Promise<Dict<number, Allocation>>

fetchAll

Parameters

node: number

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

Returns Promise<Dict<number, Allocation>>

fetchAvailable

Parameters

node: number

single: true

Returns Promise<undefined | Allocation>

Parameters

node: number

single: false

Returns Promise<Dict<number, Allocation>>

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