IHubEntityManager
Baseline CRUD+Search functions required for all Store classes
Methods
Method | Returns | Notes |
---|---|---|
|
Promise<> |
Create and Store a new Entity |
|
Promise<void> |
Destroy an Entity |
|
Promise<> |
Get an entity by an identifier. Implementations can handle this differently as needed. i.e. a HubProject can be fetched by item id (guid) or by a slug. |
|
Promise<IHubSearchResponse<>> |
Search for Entitys of type Note: When implementing, this should be a search for things of type i.e. Searching for Teams, not searching for content shared to a team. |
|
Promise<> |
Update an existing Entity |
fetch
Get an entity by an identifier. Implementations can handle this differently as needed. i.e. a HubProject can be fetched by item id (guid) or by a slug.
Parameters
Returns
search
Search for Entitys of type T
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
query Required | IQuery | ||
opts Required | IHubSearchOptions |
Returns
Note: When implementing, this should be a search for things of type T
not searching "within" the T
.
i.e. Searching for Teams, not searching for content shared to a team.
Interface defined in common/src/core/types/IHubEntityManager.ts:11
Create and Store a new Entity