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

get list listRaw

Constructors

constructor

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

Methods

get

get(options: GetPlanetOptions): Promise<Planet>
Get planet by UID
Parameters
- options: GetPlanetOptions
Returns Promise<Planet>
- Defined in src/resources/GalaxyResource.ts:60

list

list(
options?: { item_count?: number; start_index?: number },
): Promise<GalaxyPlanetListItem[]>
List all planets (paginated)
Parameters
- Optionaloptions: { item_count?: number; start_index?: number }
  Optional pagination parameters
Returns Promise<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:51

listRaw

listRaw(
options?: { item_count?: number; start_index?: number },
): Promise<GalaxyPlanetListRawResponse>
Parameters
- Optionaloptions: { item_count?: number; start_index?: number }
Returns Promise<GalaxyPlanetListRawResponse>
- Defined in src/resources/GalaxyResource.ts:36