Interface StarredEntitiesApi

An API to store and retrieve starred entities

interface StarredEntitiesApi {
starredEntitie$(): Observable<Set<string>>;
toggleStarred(entityRef: string): Promise<void>;
}

Implemented by

Index

Methods

starredEntitie$ toggleStarred

Methods

starredEntitie$

starredEntitie$(): Observable<Set<string>>
Observe the set of starred entity references.

Returns Observable<Set<string>>
- Defined in plugins/catalog-react/src/apis/StarredEntitiesApi/StarredEntitiesApi.ts:45

toggleStarred

toggleStarred(entityRef: string): Promise<void>
Toggle the star state of the entity
Parameters
- entityRef: string
  an entity reference to toggle
Returns Promise<void>
- Defined in plugins/catalog-react/src/apis/StarredEntitiesApi/StarredEntitiesApi.ts:40