Class TypesEntitiesResource

Entities by type resource

See

https://www.swcombine.com/ws/v2.0/documentation/types/entity_type/ SW Combine API Documentation

Hierarchy (View Summary)

BaseResource
- TypesEntitiesResource

Index

Constructors

Methods

get list listRaw

Constructors

constructor

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

Methods

get

get<T extends TypesEntityType>(
options: GetTypesEntityOptions<T>,
): Promise<TypesEntityGetResponseMap[T]>
Get specific entity type information
Type Parameters
- T extends TypesEntityType
Parameters
- options: GetTypesEntityOptions<T>
Returns Promise<TypesEntityGetResponseMap[T]>
- Defined in src/resources/TypesResource.ts:161

list

list<T extends TypesEntityType>(
options: ListTypesEntitiesOptions<T>,
): Promise<TypesEntityListItem[]>
Get all entities of a type (paginated)
Type Parameters
- T extends TypesEntityType
Parameters
- options: ListTypesEntitiesOptions<T>
  Entity type (plural, e.g., 'vehicles', 'ships'), optional class filter, and optional pagination parameters
Returns Promise<TypesEntityListItem[]>
Example
```
const ships = await client.types.entities.list({ entityType: 'ships' });
const moreShips = await client.types.entities.list({ entityType: 'ships', start_index: 51, item_count: 50 });
const fighters = await client.types.entities.list({ entityType: 'ships', class: 'fighter', start_index: 1, item_count: 50 });
```
- Defined in src/resources/TypesResource.ts:100

listRaw

listRaw<T extends TypesEntityType>(
options: ListTypesEntitiesOptions<T>,
): Promise<TypesEntitiesListMetaResponse>
Returns normalized pagination metadata and items for any TypesEntityType.
Type Parameters
- T extends TypesEntityType
Parameters
- options: ListTypesEntitiesOptions<T>
  Entity list options. start_index defaults to 1, item_count defaults to 50, and class is optional for class-filtered results.
Returns Promise<TypesEntitiesListMetaResponse>
TypesEntitiesListMetaResponse with pagination attributes and normalized items.
Example
```
const response = await client.types.entities.listRaw({
  entityType: 'vehicles',
  start_index: 1,
  item_count: 50,
});
console.log(response.attributes?.total);
console.log(response.items[0]?.attributes.uid);
```
Example
```
const response = await client.types.entities.listRaw({
  entityType: 'ships',
  class: 'fighter',
  start_index: 1,
  item_count: 25,
});

for (const item of response.items) {
  console.log(item.attributes.uid, item.value);
}
```
- Defined in src/resources/TypesResource.ts:135