Class GalaxySectorsResource

Galaxy sectors resource

See

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

Hierarchy (View Summary)

BaseResource
- GalaxySectorsResource

Index

Constructors

Methods

get list listRaw

Constructors

constructor

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

Methods

get

get(options: GetSectorOptions): Promise<Sector>
Get sector by name or UID
Parameters
- options: GetSectorOptions
  Sector identifier (use lowercase sector name, e.g., 'seswenna')
Returns Promise<Sector>
Example
```
const sector = await client.galaxy.sectors.get({ uid: 'seswenna' });
```
- Defined in src/resources/GalaxyResource.ts:98

list

list(
options?: { item_count?: number; start_index?: number },
): Promise<GalaxySectorListItem[]>
List all sectors (paginated)
Parameters
- Optionaloptions: { item_count?: number; start_index?: number }
  Optional pagination parameters
Returns Promise<GalaxySectorListItem[]>
Example
```
const sectors = await client.galaxy.sectors.list();
const moreSectors = await client.galaxy.sectors.list({ start_index: 51, item_count: 50 });
```
- Defined in src/resources/GalaxyResource.ts:86

listRaw

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