Class NestsModule

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

Index

Constructors

Methods

fetchAll fetchOne

Constructors

constructor

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

Methods

fetchAll

fetchAll(
include?: IncludeParameters[],
pagination?: PaginationOptions,
): Promise<NestAttributes[]>
Fetches a list of nests with optional sorting and pagination.
Parameters
- Optionalinclude: IncludeParameters[]
  Optional include parameters for related resources.
- Optionalpagination: PaginationOptions
  Optional pagination options.
Returns Promise<NestAttributes[]>
A promise that resolves to an array of nest attributes.
Example
```
const nests = await ptero.nests.fetchAll();
console.log(nests);
```
- Defined in src/modules/NestsModule.ts:36

fetchOne

fetchOne(
data: NestIdRequest,
include?: IncludeParameters[],
): Promise<NestAttributes>
Fetches a single nest by its ID.
Parameters
- data: NestIdRequest
  The request data containing the nest ID.
- Optionalinclude: IncludeParameters[]
  Optional include parameters for related resources.
Returns Promise<NestAttributes>
A promise that resolves to the nest attributes.
Example
```
const nest = await ptero.nests.fetchOne({ id: 1 });
console.log(nest);
```
- Defined in src/modules/NestsModule.ts:54