Skip to main content
Version: Next

CatalogApi.getLocationByEntity()

Home > @backstage/catalog-client > CatalogApi > getLocationByEntity

Gets a location associated with an entity.

Signature:

getLocationByEntity(entityRef: string | CompoundEntityRef, options?: CatalogRequestOptions): Promise<Location | undefined>;

Parameters

Parameter

Type

Description

entityRef

string | CompoundEntityRef

A complete entity ref, either on string or compound form

options

CatalogRequestOptions

(Optional) Additional options

**Returns:**

Promise<Location | undefined>