Add additional docs

Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>
This commit is contained in:
Dominik Henneke
2021-10-12 11:09:51 +02:00
parent c1d50273de
commit bd924fece8
2 changed files with 9 additions and 5 deletions
+1 -5
View File
@@ -761,17 +761,13 @@ export interface StarredEntitiesApi {
toggleStarred(entityRef: string): Promise<void>;
}
// Warning: (ae-missing-release-tag) "StarredEntitiesApiObservable" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type StarredEntitiesApiObservable = {
starredEntities: Set<string>;
isStarred: (entityRef: string) => boolean;
};
// Warning: (ae-missing-release-tag) "starredEntitiesApiRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
// @public
export const starredEntitiesApiRef: ApiRef<StarredEntitiesApi>;
// Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts
@@ -16,10 +16,18 @@
import { ApiRef, createApiRef, Observable } from '@backstage/core-plugin-api';
/**
* An API to store starred entities
*
* @public
*/
export const starredEntitiesApiRef: ApiRef<StarredEntitiesApi> = createApiRef({
id: 'catalog-react.starred-entities',
});
/**
* @public
*/
export type StarredEntitiesApiObservable = {
/**
* A set of entity references that are starred