Skip to main content

CatalogClient.refreshEntity()

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

Refreshes (marks for reprocessing) an entity in the catalog.

Signature:

refreshEntity(entityRef: string, options?: CatalogRequestOptions): Promise<void>;

Parameters

Parameter

Type

Description

entityRef

string

An entity ref on string form (e.g. 'component/default:my-component')

options

CatalogRequestOptions

(Optional) Additional options

**Returns:**

Promise<void>