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

get list listRaw

Constructors

constructor

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

Methods

get

get(options: GetSystemOptions): Promise<System>
Get system by UID
Parameters
- options: GetSystemOptions
Returns Promise<System>
- Defined in src/resources/GalaxyResource.ts:133

list

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

listRaw

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