Header menu logo Navs

Route Module

Functions and values

Function or value Description

cache strategy definition

Full Usage: cache strategy definition

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

This function allows you to define if the route can be restored from an in memory cache or if it should be always re-rendered when activated.

strategy : CacheStrategy
definition : RouteDefinition<'a>
Returns: RouteDefinition<'a>

canActivate guard definition

Full Usage: canActivate guard definition

Parameters:
Returns: RouteDefinition<'a> The route definition with the guard added
Modifiers: inline
Type parameters: 'a

A function to define if a route can be activated.

guard : RouteContext voption -> RouteContext -> GuardResponse

A function that returns a task of boolean

definition : RouteDefinition<'a>

The route definition

Returns: RouteDefinition<'a>

The route definition with the guard added

canActivateAsync guard definition

Full Usage: canActivateAsync guard definition

Parameters:
Returns: RouteDefinition<'a> The route definition with the guard added
Modifiers: inline
Type parameters: 'a

A function to define if a route can be activated.

guard : RouteContext voption -> RouteContext -> Async<GuardResponse>

A function that returns a boolean

definition : RouteDefinition<'a>

The route definition

Returns: RouteDefinition<'a>

The route definition with the guard added

canActivateTask guard definition

Full Usage: canActivateTask guard definition

Parameters:
Returns: RouteDefinition<'a> The route definition with the guard added
Modifiers: inline
Type parameters: 'a

A Task function to define if a route can be activated.

guard : RouteContext voption -> RouteContext -> CancellationToken -> Task<GuardResponse>

A function that returns a task of boolean

definition : RouteDefinition<'a>

The route definition

Returns: RouteDefinition<'a>

The route definition with the guard added

canDeactivate guard definition

Full Usage: canDeactivate guard definition

Parameters:
Returns: RouteDefinition<'a> The route definition with the guard added
Modifiers: inline
Type parameters: 'a

A function to define if a route can be activated.

guard : RouteContext voption -> RouteContext -> GuardResponse

A function that returns a task of boolean

definition : RouteDefinition<'a>

The route definition

Returns: RouteDefinition<'a>

The route definition with the guard added

canDeactivateAsync guard definition

Full Usage: canDeactivateAsync guard definition

Parameters:
Returns: RouteDefinition<'a> The route definition with the guard added
Modifiers: inline
Type parameters: 'a

A Task function to define if a route can be deactivated.

guard : RouteContext voption -> RouteContext -> Async<GuardResponse>

A function that returns a boolean

definition : RouteDefinition<'a>

The route definition

Returns: RouteDefinition<'a>

The route definition with the guard added

canDeactivateTask guard definition

Full Usage: canDeactivateTask guard definition

Parameters:
Returns: RouteDefinition<'a> The route definition with the guard added
Modifiers: inline
Type parameters: 'a

A Task function to define if a route can be deactivated.

guard : RouteContext voption -> RouteContext -> CancellationToken -> Task<GuardResponse>

A function that returns a task of boolean.

definition : RouteDefinition<'a>

The route definition

Returns: RouteDefinition<'a>

The route definition with the guard added

Type something to start searching.