convertLegacyRouteRef()

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

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

Signature:

function convertLegacyRouteRef<TParams extends AnyRouteRefParams>(ref: LegacyExternalRouteRef<TParams>): ExternalRouteRef<TParams>;

Parameters

Parameter	Type	Description
ref	LegacyExternalRouteRef<TParams>

Returns:

ExternalRouteRef<TParams>

Remarks

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