convertLegacyRouteRef()

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

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

Signature:

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

Parameters

Parameter	Type	Description
ref	SubRouteRef<TParams>

Returns:

LegacySubRouteRef<TParams>

Remarks

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