Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -134,3 +134,5 @@ resources/frags/test

resources/asdf2.frag
resources/asdf2.json

.DS_Store
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This helps macOS devs avoid accidentally pushing this system file

Original file line number Diff line number Diff line change
Expand Up @@ -445,8 +445,37 @@ export class FragmentsModel {

/**
* Get all the data of the specified items.
*
* By default, the API returns the item’s built-in attributes only.
* Relations are not traversed unless explicitly enabled via the `config`
* parameter.
*
* @param ids - The IDs of the items to look up.
* @param config - The configuration of the items data.
* Default configuration:
* ```ts
* {
* attributesDefault: true,
* relationsDefault: { attributes: false, relations: false },
* }
* ```
*
* @example
* // Retrieve all built-in attributes and all related entities (full graph)
* await getItemsData(ids, {
* attributesDefault: true,
* relationsDefault: { attributes: true, relations: true },
* });
*
* @example
* // Retrieve built-in attributes and Property Sets only (via IsDefinedBy)
* await getItemsData(ids, {
* attributesDefault: true,
* relations: {
* IsDefinedBy: { attributes: true, relations: true },
* DefinesOccurrence: { attributes: false, relations: false },
* },
* });
*/
async getItemsData(ids: Identifier[], config?: Partial<ItemsDataConfig>) {
return this._itemsManager.getItemsData(this, ids, config);
Expand Down