Skip to content

Functions: createRoute()

ts
function createRoute<TOptions, TProps>(options, ...args): ToRoute<TOptions, CreateRouteProps<TOptions> extends TProps ? undefined : TProps>;

Type Parameters

Type Parameter
TOptions extends CreateRouteOptions
TProps extends | PropsGetter<TOptions, any[any]> | RoutePropsRecord<TOptions, any[any]> | PropsGetter<TOptions, DefineSetupFnComponent<RouterViewProps, EmitsOptions, SlotsType<{ default?: (props) => VNode<RendererNode, RendererElement, { [key: string]: any; }>; }>, RouterViewProps & | { [x: `on${Capitalize<string>}`]: undefined | (...args) => any; } | { [x: `on${Capitalize<string>}`]: undefined | (...args) => any; }, PublicProps>>

Parameters

ParameterType
optionsTOptions
...argsCreateRouteWithProps<TOptions, TProps>

Returns

ToRoute<TOptions, CreateRouteProps<TOptions> extends TProps ? undefined : TProps>