Skip to content

Functions: createRoute()

ts
function createRoute<TOptions, TProps>(options, ...args): ToRoute<TOptions, CreateRouteProps<TOptions> extends TProps ? undefined : TProps> & InternalRouteHooks<TOptions["context"]>;

Type Parameters

Type Parameter
TOptions extends CreateRouteOptions
TProps extends | PropsGetter<TOptions, any[any]> | RoutePropsRecord<TOptions, any[any]> | RouterViewPropsGetter<TOptions>

Parameters

ParameterType
optionsTOptions
...argsCreateRouteWithProps<TOptions, TProps>

Returns

ToRoute<TOptions, CreateRouteProps<TOptions> extends TProps ? undefined : TProps> & InternalRouteHooks<TOptions["context"]>