createSubRouteRef()

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

Create a SubRouteRef from a route descriptor.

Signature:

function createSubRouteRef<Path extends string, ParentParams extends AnyParams = never>(config: {
    id: string;
    path: Path;
    parent: RouteRef<ParentParams>;
}): MakeSubRouteRef<PathParams<Path>, ParentParams>;

Parameters

Parameter	Type	Description
config	{ id: string; path: Path; parent: RouteRef<ParentParams>; }	Description of the route reference to be created.

Returns:

MakeSubRouteRef<PathParams<Path>, ParentParams>

Parameters​

Parameters