Header menu logo Navs

Route Module

Functions and values

Function or value Description

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 -> INavigable<'a> -> 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 -> INavigable<'a> -> 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 Task function to define if a route can be deactivated.

guard : RouteContext -> INavigable<'a> -> 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 -> INavigable<'a> -> 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.