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

Constructors

constructor

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

Methods

get

get(options: GetSectorOptions): Promise<Sector>
Get sector by name or UID.

Returns the Sector object directly — not wrapped in a Page.
Parameters
- options: GetSectorOptions
  Sector identifier (use lowercase sector name, e.g., 'seswenna')
Returns Promise<Sector>
The Sector entity.
Example
```
const sector = await client.galaxy.sectors.get({ uid: 'seswenna' });
console.log(sector.name); // access properties directly, not sector.data
```
- Defined in src/resources/GalaxyResource.ts:130

list

list(
    options?: {
        item_count?: number;
        pageDelay?: number;
        start_index?: number;
    },
): Promise<Page<GalaxySectorListItem>>
List all sectors (paginated)
Parameters
- Optionaloptions: { item_count?: number; pageDelay?: number; start_index?: number }
  Optional pagination parameters
Returns Promise<Page<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:93