CatalogClient.getLocationByEntity()
Home > @backstage/catalog-client
> CatalogClient
> getLocationByEntity
Gets a location associated with an entity.
Signature:
getLocationByEntity(entityRef: CompoundEntityRef | string, options?: CatalogRequestOptions): Promise<Location | undefined>;
Parameters
Parameter | Type | Description |
---|---|---|
entityRef | CompoundEntityRef | string | A complete entity ref, either on string or compound form |
options | CatalogRequestOptions | (Optional) Additional options |
Returns:
Promise<Location | undefined>