Class GalaxySystemsResource

Galaxy systems resource

See

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

Hierarchy (View Summary)

BaseResource
- GalaxySystemsResource

Index

Constructors

Methods

Constructors

constructor

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

Methods

get

get(options: GetSystemOptions): Promise<System>
Get system by UID.

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

list

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