Skip to main content

convertLegacyRouteRef()

Home > @backstage/core-compat-api > convertLegacyRouteRef

A temporary helper to convert a legacy sub route ref to the new system.

Signature:

function convertLegacyRouteRef<TParams extends AnyRouteRefParams>(ref: LegacySubRouteRef<TParams>): SubRouteRef<TParams>;

Parameters

Parameter

Type

Description

ref

LegacySubRouteRef<TParams>

**Returns:**

SubRouteRef<TParams>

Remarks

In the future the legacy createSubRouteRef will instead create refs compatible with both systems.