convertLegacyRouteRef()

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

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

Signature:

function convertLegacyRouteRef<TParams extends AnyRouteRefParams>(ref: LegacyRouteRef<TParams>): RouteRef<TParams>;

Parameters

Parameter	Type	Description
ref	LegacyRouteRef<TParams>

Returns:

RouteRef<TParams>

Remarks

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