Skip to main content

CatalogClient.getEntityByRef()

Home > @backstage/catalog-client > CatalogClient > getEntityByRef

Gets a single entity from the catalog by its ref (kind, namespace, name) triplet.

Signature:

getEntityByRef(entityRef: string | CompoundEntityRef, options?: CatalogRequestOptions): Promise<Entity | 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<Entity | undefined>

The matching entity, or undefined if there was no entity with that ref