Backstage
    Preparing search index...
    • Create a RouteRef from a route descriptor.

      Type Parameters

      • TParams extends { [param in string]: string } | undefined = undefined
      • TParamKeys extends string = string

      Parameters

      • Optionalconfig: {
            aliasFor?: string;
            params?: string extends TParamKeys ? (keyof TParams)[] : TParamKeys[];
        }

        Description of the route reference to be created.

        • OptionalaliasFor?: string
        • Optional Readonlyparams?: string extends TParamKeys ? (keyof TParams)[] : TParamKeys[]

          A list of parameter names that the path that this route ref is bound to must contain

      Returns RouteRef<
          keyof TParams extends never
              ? undefined
              : string extends TParamKeys ? TParams : { [param in string]: string },
      >