Resolve PR comments
* rename starredEntities$ to starredEntitie$ * delete star and unstar from the public interface Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>
This commit is contained in:
@@ -143,7 +143,7 @@ export class DefaultStarredEntitiesApi implements StarredEntitiesApi {
|
||||
// (undocumented)
|
||||
star(entity: Entity): Promise<void>;
|
||||
// (undocumented)
|
||||
starredEntities$(): Observable<StarredEntitiesApiObservable>;
|
||||
starredEntitie$(): Observable<StarredEntitiesApiObservable>;
|
||||
// (undocumented)
|
||||
toggleStarred(entity: Entity): Promise<void>;
|
||||
// (undocumented)
|
||||
@@ -763,10 +763,8 @@ export const rootRoute: RouteRef<undefined>;
|
||||
|
||||
// @public
|
||||
export interface StarredEntitiesApi {
|
||||
star(entity: Entity): Promise<void>;
|
||||
starredEntities$(): Observable<StarredEntitiesApiObservable>;
|
||||
starredEntitie$(): Observable<StarredEntitiesApiObservable>;
|
||||
toggleStarred(entity: Entity): Promise<void>;
|
||||
unstar(entity: Entity): 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)
|
||||
|
||||
@@ -110,7 +110,7 @@ describe('DefaultStarredEntitiesApi', () => {
|
||||
|
||||
beforeEach(async () => {
|
||||
await new Promise<void>(resolve => {
|
||||
starredEntitiesApi.starredEntities$().subscribe({
|
||||
starredEntitiesApi.starredEntitie$().subscribe({
|
||||
next: (...args) => {
|
||||
handler(...args);
|
||||
|
||||
|
||||
@@ -78,7 +78,7 @@ export class DefaultStarredEntitiesApi implements StarredEntitiesApi {
|
||||
);
|
||||
}
|
||||
|
||||
starredEntities$(): Observable<StarredEntitiesApiObservable> {
|
||||
starredEntitie$(): Observable<StarredEntitiesApiObservable> {
|
||||
return this.observable;
|
||||
}
|
||||
|
||||
|
||||
@@ -49,23 +49,9 @@ export interface StarredEntitiesApi {
|
||||
*/
|
||||
toggleStarred(entity: Entity): Promise<void>;
|
||||
|
||||
/**
|
||||
* Star the entity
|
||||
*
|
||||
* @param entity - the entity to be starred
|
||||
*/
|
||||
star(entity: Entity): Promise<void>;
|
||||
|
||||
/**
|
||||
* Unstar the entity
|
||||
*
|
||||
* @param entity - the entity to be unstarred
|
||||
*/
|
||||
unstar(entity: Entity): Promise<void>;
|
||||
|
||||
/**
|
||||
* Observe the state of starred entities and receive a handler
|
||||
* to check the star state of an entity.
|
||||
*/
|
||||
starredEntities$(): Observable<StarredEntitiesApiObservable>;
|
||||
starredEntitie$(): Observable<StarredEntitiesApiObservable>;
|
||||
}
|
||||
|
||||
@@ -24,7 +24,7 @@ export const useStarredEntities = () => {
|
||||
const starredEntitiesApi = useApi(starredEntitiesApiRef);
|
||||
|
||||
const { starredEntities, isStarred: isStarredEntity } = useObservable(
|
||||
starredEntitiesApi.starredEntities$(),
|
||||
starredEntitiesApi.starredEntitie$(),
|
||||
{ starredEntities: new Set<string>(), isStarred: _ => false },
|
||||
);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user