convertLegacyRouteRef()

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

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

Signature:

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

Parameters

Parameter	Type	Description
ref	ExternalRouteRef<TParams>

Returns:

LegacyExternalRouteRef<TParams, true>

Remarks

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