Header menu logo Navs

RouteDefinitionExtensions Type

Extensions for a builder-like API for defining routes in the application

Static members

Static member Description

RouteDefinitionExtensions.CacheOnVisit(routeDef)

Full Usage: RouteDefinitionExtensions.CacheOnVisit(routeDef)

Parameters:
Returns: RouteDefinition<'View>
Modifiers: inline
Type parameters: 'View

Ensure that rendered view used for this route is picked up from the in-memory cache.

routeDef : RouteDefinition<'View>
Returns: RouteDefinition<'View>

RouteDefinitionExtensions.CanActivate(routeDef, guards)

Full Usage: RouteDefinitionExtensions.CanActivate(routeDef, guards)

Parameters:
Returns: RouteDefinition<'View>
Modifiers: inline
Type parameters: 'View

Takes a sequence of route guards and adds them to the route definition as guards that will be executed when the route is activated.

routeDef : RouteDefinition<'View>
guards : Func<RouteContext, INavigable<'View>, CancellationToken, Task<GuardResponse>> array
Returns: RouteDefinition<'View>

RouteDefinitionExtensions.CanDeactivate(routeDef, guards)

Full Usage: RouteDefinitionExtensions.CanDeactivate(routeDef, guards)

Parameters:
Returns: RouteDefinition<'View>
Modifiers: inline
Type parameters: 'View

Takes a sequence of route guards and adds them to the route definition as guards that will be executed when the route is deactivated.

routeDef : RouteDefinition<'View>
guards : Func<RouteContext, INavigable<'View>, CancellationToken, Task<GuardResponse>> array
Returns: RouteDefinition<'View>

RouteDefinitionExtensions.Child(routeDef, child)

Full Usage: RouteDefinitionExtensions.Child(routeDef, child)

Parameters:
Returns: RouteDefinition<'View>
Modifiers: inline
Type parameters: 'View

Takes a route definition and adds it as a child of the parent route definition.

routeDef : RouteDefinition<'View>
child : RouteDefinition<'View>
Returns: RouteDefinition<'View>

RouteDefinitionExtensions.Children(routeDef, children)

Full Usage: RouteDefinitionExtensions.Children(routeDef, children)

Parameters:
Returns: RouteDefinition<'View>
Modifiers: inline
Type parameters: 'View

Takes a sequence of route definitions and adds them as children of the parent route definition.

routeDef : RouteDefinition<'View>
children : RouteDefinition<'View> array
Returns: RouteDefinition<'View>

RouteDefinitionExtensions.NoCacheOnVisit(routeDef)

Full Usage: RouteDefinitionExtensions.NoCacheOnVisit(routeDef)

Parameters:
Returns: RouteDefinition<'View>
Modifiers: inline
Type parameters: 'View

Ensure that rendered view used for this route is always re-rendered when the route is activated.

routeDef : RouteDefinition<'View>
Returns: RouteDefinition<'View>

Type something to start searching.