NodeLocationManager | @devnote-dev/pterojs

Hierarchy

BaseManager
- NodeLocationManager

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new NodeLocationManager(client: PteroApp): NodeLocationManager

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

Properties

cache

cache: Dict<number, NodeLocation>

client

client: PteroApp

Accessors

FILTERS

get FILTERS(): readonly string[]

Overrides BaseManager.FILTERS
- Defined in src/application/NodeLocationManager.ts:28
Allowed filter arguments for locations:
- short
- long
Returns readonly string[]

INCLUDES

get INCLUDES(): readonly string[]

Overrides BaseManager.INCLUDES
- Defined in src/application/NodeLocationManager.ts:37
Allowed include arguments for locations:
- nodes
- servers
Returns readonly string[]

SORTS

get SORTS(): readonly never[]

Overrides BaseManager.SORTS
- Defined in src/application/NodeLocationManager.ts:42
Allowed sort arguments for locations (none).

Returns readonly never[]

Methods

_patch

_patch(data: any): any

- Defined in src/application/NodeLocationManager.ts:64
Transforms the raw location object(s) into typed objects.

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

adminURLFor

adminURLFor(id: number): string

- Defined in src/application/NodeLocationManager.ts:116
Parameters
- id: number
  
  The ID of the location.
Returns string
The formatted URL to the location in the admin panel.

create

create(short: string, long: string): Promise<NodeLocation>

- Defined in src/application/NodeLocationManager.ts:246
Creates a location.
example
```
app.locations.create('ca', 'canada')
 .then(console.log)
 .catch(console.error);
```
Parameters
- short: string
  
  The short name for the location (usually the country code).
- long: string
  
  The long name for the location.
Returns Promise<NodeLocation>
The new location.

delete

delete(id: number): Promise<void>

- Defined in src/application/NodeLocationManager.ts:290
Deletes a location.
example
```
app.locations.delete(9).catch(console.error);
```
Parameters
- id: number
  
  The ID of the location.
Returns Promise<void>

fetch

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

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

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

fetchAll

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

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

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

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, NodeLocation>>

- Defined in src/application/NodeLocationManager.ts:214
Queries the API for locations 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:
- short
- long
example
```
app.locations.query('us', { filter: 'long' })
 .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, NodeLocation>>
The queried locations.

resolve

resolve(obj: any): undefined | NodeLocation

- Defined in src/application/NodeLocationManager.ts:101
Resolves a location from an object. This can be:
- a string
- a number
- an object
Parameters
- obj: any
  
  The object to resolve from.
Returns undefined | NodeLocation
The resolved location or undefined if not found.

update

update(id: number, options: { long?: string; short?: string }): Promise<NodeLocation>

- Defined in src/application/NodeLocationManager.ts:266
Updates a location.
example
```
app.locations.update(10, { long: 'united kingdom' })
 .then(console.log)
 .catch(console.error);
```
Parameters
- id: number
  
  The ID of the location.
- options: { long?: string; short?: string }
  
  The updated short and/or long name of the location.
  - Optional long?: string
  - Optional short?: string
Returns Promise<NodeLocation>
The updated location.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: PteroApp

Returns NodeLocationManager

Properties

cache

client

meta

Accessors

FILTERS

Returns readonly string[]

INCLUDES

Returns readonly string[]

SORTS

Returns readonly never[]

Methods

_patch

Parameters

data: any

Returns any

adminURLFor

Parameters

id: number

Returns string

create

Parameters

short: string

long: string

Returns Promise<NodeLocation>

delete

Parameters

id: number

Returns Promise<void>

fetch

Parameters

id: number

Optional options: Include<FetchOptions>

Returns Promise<NodeLocation>

Parameters

Optional options: Include<FetchOptions>

Returns Promise<Dict<number, NodeLocation>>

fetchAll

Parameters

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

Returns Promise<Dict<number, NodeLocation>>

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, NodeLocation>>

resolve

Parameters

obj: any

Returns undefined | NodeLocation

update

Parameters

id: number

options: { long?: string; short?: string }

Optional long?: string

Optional short?: string

Returns Promise<NodeLocation>