CatalogClient.getEntityByName()

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

Warning: This API is now obsolete.

Use getEntityByRef instead

Signature:

getEntityByName(compoundName: CompoundEntityRef, options?: CatalogRequestOptions): Promise<Entity | undefined>;

Parameters

Parameter	Type	Description
compoundName	CompoundEntityRef
options	CatalogRequestOptions	(Optional)

**Returns:**

Promise<Entity | undefined>