Skip to main content
Version: Next

CatalogClient.getLocationByRef()

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

Gets a registered location by its ref.

Signature:

getLocationByRef(locationRef: string, options?: CatalogRequestOptions): Promise<Location | undefined>;

Parameters

Parameter

Type

Description

locationRef

string

A location ref, e.g. "url:https://github.com/..."

options

CatalogRequestOptions

(Optional) Additional options

**Returns:**

Promise<Location | undefined>