Skip to main content

createRouteRef()

Home > @backstage/core-plugin-api > createRouteRef

Create a RouteRef from a route descriptor.

Signature:

function createRouteRef<Params extends {
    [param in ParamKey]: string;
}, ParamKey extends string = never>(config: {
    id: string;
    params?: ParamKey[];
}): RouteRef<OptionalParams<Params>>;

Parameters​

Parameter

Type

Description

config

{ id: string; params?: ParamKey[]; }

Description of the route reference to be created.

**Returns:**

RouteRef<OptionalParams<Params>>