Documentation / @imvu/rest / APICollection

Interface: APICollection<T>

Defined in: packages/rest/src/types.ts:47

A normalized, bounded page from a REST collection.

Type Parameters

Type Parameter	Default type
T extends object	Record<string, any>

Properties

data

data: T;

Defined in: packages/rest/src/types.ts:49

---

edges?

edges?: APIResource<Record<string, any>>[];

Defined in: packages/rest/src/types.ts:57

The edge documents themselves, for collections whose edges carry their own data (e.g. chat participants: seat, outfit, join time, with ref → the user).

---

items

items: APIResource<Record<string, any>>[];

Defined in: packages/rest/src/types.ts:52

Each item resolved through its edge's ref (e.g. the products on a wishlist).

---

itemUrls

itemUrls: string[];

Defined in: packages/rest/src/types.ts:50

---

relations

relations: APIRelations;

Defined in: packages/rest/src/types.ts:59

---

totalCount

totalCount: number;

Defined in: packages/rest/src/types.ts:58

---

updates

updates: APIUpdateTarget | null;

Defined in: packages/rest/src/types.ts:60

---

url

url: string;

Defined in: packages/rest/src/types.ts:48