MakeSubRouteRef

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

Warning: This API is now obsolete.

this type is deprecated and will be removed in the future

Creates a SubRouteRef type given the desired parameters and parent route parameters. The parameters types are merged together while ensuring that there is no overlap between the two.

Signature:

export type MakeSubRouteRef<Params extends {
    [param in string]: string;
}, ParentParams extends AnyParams> = keyof Params & keyof ParentParams extends never ? SubRouteRef<OptionalParams<MergeParams<Params, ParentParams>>> : never;

References: AnyParams, SubRouteRef, OptionalParams, MergeParams