Skip to main content

useRelatedEntities()

Home > @backstage/plugin-catalog-react > useRelatedEntities

Fetches all entities that appear in the entity's relations, optionally filtered by relation type and kind.

Signature:

function useRelatedEntities(entity: Entity, relationFilter: {
    type?: string;
    kind?: string;
}): {
    entities: Entity[] | undefined;
    loading: boolean;
    error: Error | undefined;
};

Parameters​

ParameterTypeDescription
entityEntity
relationFilter{ type?: string; kind?: string; }

Returns:

{ entities: Entity[] | undefined; loading: boolean; error: Error | undefined; }