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, TOptional extends boolean>(ref: LegacyExternalRouteRef<TParams, TOptional>): ExternalRouteRef<TParams, TOptional>;

Parameters

Parameter	Type	Description
ref	LegacyExternalRouteRef<TParams, TOptional>

Returns:

ExternalRouteRef<TParams, TOptional>

Remarks

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