Class EggsModule

Module for accessing Pterodactyl eggs endpoints. This module provides methods to access egg details, create eggs, update eggs, etc.

Index

Constructors

Methods

fetchAll fetchOne

Constructors

constructor

new EggsModule(client: PteroApp): EggsModule
Parameters
- client: PteroApp
Returns EggsModule
- Defined in src/modules/EggsModule.ts:17

Methods

fetchAll

fetchAll(
    data: NestIdRequest,
    include?: IncludeParameters[],
    pagination?: PaginationOptions,
): Promise<EggAttributes[]>
Fetches a list of eggs within a specific nest.
Parameters
- data: NestIdRequest
  The request data containing the nest ID.
- Optionalinclude: IncludeParameters[]
  Optional include parameters for related resources.
- Optionalpagination: PaginationOptions
  Optional pagination options.
Returns Promise<EggAttributes[]>
A promise that resolves to an array of egg attributes.
Example
```
const eggs = await ptero.eggs.fetchAll({ id: 1 });
console.log(eggs);
```
- Defined in src/modules/EggsModule.ts:35

fetchOne

fetchOne(
data: NestEggRequest,
include?: IncludeParameters[],
): Promise<EggAttributes>
Fetches a single egg by its ID within a specific nest.
Parameters
- data: NestEggRequest
  The request data containing the nest ID and egg ID.
- Optionalinclude: IncludeParameters[]
  Optional include parameters for related resources.
Returns Promise<EggAttributes>
A promise that resolves to the egg attributes.
Example
```
const egg = await ptero.eggs.fetchOne({ nestId: 1, eggId: 1 });
console.log(egg);
```
- Defined in src/modules/EggsModule.ts:55