Class NestEggsManager

Hierarchy

BaseManager
- NestEggsManager

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new NestEggsManager(client: PteroApp): NestEggsManager

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

Properties

cache

cache: Dict<number, Egg>

client

client: PteroApp

meta

meta: PaginationMeta = ...

Accessors

FILTERS

get FILTERS(): readonly never[]

Overrides BaseManager.FILTERS
- Defined in src/application/NestEggsManager.ts:14
Allowed filter arguments for eggs (none).

Returns readonly never[]

INCLUDES

get INCLUDES(): readonly string[]

Overrides BaseManager.INCLUDES
- Defined in src/application/NestEggsManager.ts:26
Allowed include arguments for eggs:
- nest
- servers
- config
- script
- variables
Returns readonly string[]

SORTS

get SORTS(): readonly never[]

Overrides BaseManager.SORTS
- Defined in src/application/NestEggsManager.ts:37
Allowed sort arguments for eggs (none).

Returns readonly never[]

Methods

_patch

_patch(data: any): any

- Defined in src/application/NestEggsManager.ts:52
Transforms the raw egg object(s) into typed objects.

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

adminURLFor

adminURLFor(id: number): string

- Defined in src/application/NestEggsManager.ts:77
Parameters
- id: number
  
  The ID of the egg.
Returns string
The formatted URL to the egg in the admin panel.

fetch

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

Overrides BaseManager.fetch
- Defined in src/application/NestEggsManager.ts:94
Fetches an egg from the API by its ID. This will check the cache first unless the force option is specified.
example
```
app.nests.eggs.fetch(1, 16).then(console.log).catch(console.error);
```
Parameters
- nest: number
  
  The ID of the nest.
- id: number
  
  The ID of the egg.
- Optional options: Include<FetchOptions>
Returns Promise<Egg>
The fetched egg.
Overrides BaseManager.fetch
- Defined in src/application/NestEggsManager.ts:113
Fetches a list of eggs from the API by its ID. This will check the cache first unless the force option is specified.
example
```
app.nests.eggs.fetch(1)
 .then(eggs => eggs.forEach(e => console.log(e)))
 .catch(console.error);
```
Parameters
- nest: number
  
  The ID of the nest.
- Optional options: Include<FetchOptions>
Returns Promise<Dict<number, Egg>>
The fetched eggs.

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

Generated using TypeDoc