Class GalaxyPlanetsResource

Galaxy planets resource

See

https://www.swcombine.com/ws/v2.0/documentation/galaxy/planets/ SW Combine API Documentation

Hierarchy (View Summary)

BaseResource
- GalaxyPlanetsResource

Index

Constructors

Methods

Constructors

constructor

new GalaxyPlanetsResource(http: HttpClient): GalaxyPlanetsResource
Parameters
- http: HttpClient
Returns GalaxyPlanetsResource
Inherited from BaseResource.constructor
- Defined in src/resources/BaseResource.ts:14

Methods

get

get(options: GetPlanetOptions): Promise<Planet>
Get planet by UID.

Returns the Planet object directly — not wrapped in a Page.
Parameters
- options: GetPlanetOptions
Returns Promise<Planet>
The Planet entity.
Example
```
const planet = await client.galaxy.planets.get({ uid: '9:123' });
console.log(planet.name); // access properties directly, not planet.data
```
- Defined in src/resources/GalaxyResource.ts:75

list

list(
    options?: {
        item_count?: number;
        pageDelay?: number;
        start_index?: number;
    },
): Promise<Page<GalaxyPlanetListItem>>
List all planets (paginated)
Parameters
- Optionaloptions: { item_count?: number; pageDelay?: number; start_index?: number }
  Optional pagination parameters
Returns Promise<Page<GalaxyPlanetListItem>>
Example
```
const planets = await client.galaxy.planets.list();
const morePlanets = await client.galaxy.planets.list({ start_index: 51, item_count: 50 });
```
- Defined in src/resources/GalaxyResource.ts:39