Search
Preparing search index...
The search index is not available
RxComp RouterModule
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Globals
RxComp RouterModule
Index
Enumerations
Route
Location
Strategy
Classes
Activation
End
Activation
Start
Child
Activation
End
Child
Activation
Start
Enter
Transition
Guards
Check
End
Guards
Check
Start
Leave
Transition
Location
Strategy
Location
Strategy
Hash
Location
Strategy
Path
Navigation
Cancel
Navigation
End
Navigation
Error
Navigation
Start
Once
Transition
Resolve
End
Resolve
Start
Route
Route
Config
Load
End
Route
Config
Load
Start
Route
Path
Route
Segment
Route
Snapshot
Router
Event
Router
Link
Active
Directive
Router
Link
Directive
Router
Module
Router
Outlet
Structure
Router
Service
Routes
Recognized
Transition
View
Interfaces
IBase
Route
ICan
Activate
ICan
Activate
Child
ICan
Deactivate
ICan
Load
ILocation
Strategy
INavigation
Extras
IRoute
IRoute
Path
IRouter
Event
ITransition
ITransition
Key
IView
Meta
Type aliases
Data
IRoutes
Params
Route
Component
Router
Activator
Router
Activator
Result
Router
Key
Value
Router
Link
Routes
Transition
Callback
Variables
MEMORY
factories
pipes
Functions
as
Observable
clear
Routes_
decode
Param
encode
Param
get
Flat
Routes_
get
Flat
Snapshots_
is
Promise
make
Activator
Response$_
make
Can
Activate
Child
Response$_
make
Can
Activate
Response$_
make
Can
Deactivate
Response$_
make
Can
Load
Response$_
make
Observer$_
map
Can
Activate$_
map
Can
Activate
Child$_
map
Can
Deactivate$_
map
Can
Load$_
resolve
Route_
resolve
Routes_
session
Storage
Get_
session
Storage
Set_
transition$
transition
Once
transition
Onced
Type aliases
Data
Data
:
{}
Type declaration
[
key:
string
]:
any
IRoutes
IRoutes
:
IRoute
[]
Params
Params
:
{}
Type declaration
[
key:
string
]:
any
Route
Component
Route
Component
:
string
|
number
|
{}
Router
Activator
Router
Activator
:
Observable
<
boolean
>
|
(
(
)
=>
boolean
)
|
boolean
Router
Activator
Result
Router
Activator
Result
:
Observable
<
boolean
|
RouteComponent
[]
>
|
Promise
<
boolean
|
RouteComponent
[]
>
|
boolean
|
RouteComponent
[]
Router
Key
Value
Router
Key
Value
:
{}
Type declaration
[
key:
string
]:
RouterKeyValue
|
string
|
null
Router
Link
Router
Link
:
string
|
RouteComponent
[]
Routes
Routes
:
Route
[]
Transition
Callback
Transition
Callback
:
(
node
:
IElement
)
=>
Observable
<
void
>
|
Promise
<
void
>
|
(
(
)
=>
void
)
|
void
Type declaration
(
node
:
IElement
)
:
Observable
<
void
>
|
Promise
<
void
>
|
(
(
)
=>
void
)
|
void
Parameters
node:
IElement
Returns
Observable
<
void
>
|
Promise
<
void
>
|
(
(
)
=>
void
)
|
void
Variables
Const
MEMORY
MEMORY
:
{}
Type declaration
[
key:
string
]:
any
Const
factories
factories
:
typeof
Factory
[]
= [RouterOutletStructure,RouterLinkDirective,RouterLinkActiveDirective,]
Const
pipes
pipes
:
typeof
Pipe
[]
= []
Functions
as
Observable
as
Observable<T>
(
args
:
any
[]
, callback
:
(
...
args
:
any
[]
)
=>
Observable
<
T
>
|
Promise
<
T
>
|
(
(
)
=>
T
)
|
T
)
:
Observable
<
T
>
Type parameters
T
Parameters
args:
any
[]
callback:
(
...
args
:
any
[]
)
=>
Observable
<
T
>
|
Promise
<
T
>
|
(
(
)
=>
T
)
|
T
(
...
args
:
any
[]
)
:
Observable
<
T
>
|
Promise
<
T
>
|
(
(
)
=>
T
)
|
T
Parameters
Rest
...
args:
any
[]
Returns
Observable
<
T
>
|
Promise
<
T
>
|
(
(
)
=>
T
)
|
T
Returns
Observable
<
T
>
clear
Routes_
clear
Routes_
(
routes
:
Routes
, currentSnapshot
:
RouteSnapshot
)
:
void
Parameters
routes:
Routes
currentSnapshot:
RouteSnapshot
Returns
void
decode
Param
decode
Param
(
value
:
string
)
:
string
Parameters
value:
string
Returns
string
encode
Param
encode
Param
(
value
:
string
)
:
string
Parameters
value:
string
Returns
string
get
Flat
Routes_
get
Flat
Routes_
(
routes
:
Routes
)
:
Routes
Parameters
routes:
Routes
Returns
Routes
get
Flat
Snapshots_
get
Flat
Snapshots_
(
currentSnapshot
:
RouteSnapshot
)
:
RouteSnapshot
[]
Parameters
currentSnapshot:
RouteSnapshot
Returns
RouteSnapshot
[]
is
Promise
is
Promise<T>
(
object
:
any
)
:
object
is
Promise
<
T
>
Type parameters
T
Parameters
object:
any
Returns
object
is
Promise
<
T
>
make
Activator
Response$_
make
Activator
Response$_
(
event
:
RouterEvent
, activators
:
Observable
<
boolean
|
RouteComponent
[]
>
[]
)
:
Observable
<
RouterEvent
>
Parameters
event:
RouterEvent
activators:
Observable
<
boolean
|
RouteComponent
[]
>
[]
Returns
Observable
<
RouterEvent
>
make
Can
Activate
Child
Response$_
make
Can
Activate
Child
Response$_
(
events$
:
ReplaySubject
<
RouterEvent
>
, event
:
GuardsCheckStart
)
:
Observable
<
RouterEvent
>
Parameters
events$:
ReplaySubject
<
RouterEvent
>
event:
GuardsCheckStart
Returns
Observable
<
RouterEvent
>
make
Can
Activate
Response$_
make
Can
Activate
Response$_
(
events$
:
ReplaySubject
<
RouterEvent
>
, event
:
ChildActivationStart
)
:
Observable
<
RouterEvent
>
Parameters
events$:
ReplaySubject
<
RouterEvent
>
event:
ChildActivationStart
Returns
Observable
<
RouterEvent
>
make
Can
Deactivate
Response$_
make
Can
Deactivate
Response$_
(
events$
:
ReplaySubject
<
RouterEvent
>
, event
:
GuardsCheckStart
, currentRoute
?:
RouteSnapshot
)
:
Observable
<
RouterEvent
>
Parameters
events$:
ReplaySubject
<
RouterEvent
>
event:
GuardsCheckStart
Optional
currentRoute:
RouteSnapshot
Returns
Observable
<
RouterEvent
>
make
Can
Load
Response$_
make
Can
Load
Response$_
(
events$
:
ReplaySubject
<
RouterEvent
>
, event
:
GuardsCheckStart
)
:
Observable
<
RouterEvent
>
Parameters
events$:
ReplaySubject
<
RouterEvent
>
event:
GuardsCheckStart
Returns
Observable
<
RouterEvent
>
make
Observer$_
make
Observer$_
(
callback
:
(
)
=>
RouterActivatorResult
)
:
any
Parameters
callback:
(
)
=>
RouterActivatorResult
(
)
:
RouterActivatorResult
Returns
RouterActivatorResult
Returns
any
map
Can
Activate$_
map
Can
Activate$_
(
activator
:
ICanActivate
)
:
(
route
:
RouteSnapshot
)
=>
Observable
<
boolean
|
RouteComponent
[]
>
Parameters
activator:
ICanActivate
Returns
(
route
:
RouteSnapshot
)
=>
Observable
<
boolean
|
RouteComponent
[]
>
(
route
:
RouteSnapshot
)
:
Observable
<
boolean
|
RouteComponent
[]
>
Parameters
route:
RouteSnapshot
Returns
Observable
<
boolean
|
RouteComponent
[]
>
map
Can
Activate
Child$_
map
Can
Activate
Child$_
(
activator
:
ICanActivateChild
)
:
(
childRoute
:
RouteSnapshot
)
=>
Observable
<
boolean
|
RouteComponent
[]
>
Parameters
activator:
ICanActivateChild
Returns
(
childRoute
:
RouteSnapshot
)
=>
Observable
<
boolean
|
RouteComponent
[]
>
(
childRoute
:
RouteSnapshot
)
:
Observable
<
boolean
|
RouteComponent
[]
>
Parameters
childRoute:
RouteSnapshot
Returns
Observable
<
boolean
|
RouteComponent
[]
>
map
Can
Deactivate$_
map
Can
Deactivate$_<T>
(
activator
:
ICanDeactivate
<
T
>
)
:
(
component
:
T
, currentRoute
:
RouteSnapshot
)
=>
Observable
<
boolean
|
RouteComponent
[]
>
Type parameters
T
Parameters
activator:
ICanDeactivate
<
T
>
Returns
(
component
:
T
, currentRoute
:
RouteSnapshot
)
=>
Observable
<
boolean
|
RouteComponent
[]
>
(
component
:
T
, currentRoute
:
RouteSnapshot
)
:
Observable
<
boolean
|
RouteComponent
[]
>
Parameters
component:
T
currentRoute:
RouteSnapshot
Returns
Observable
<
boolean
|
RouteComponent
[]
>
map
Can
Load$_
map
Can
Load$_
(
activator
:
ICanLoad
)
:
(
route
:
RouteSnapshot
, segments
:
RouteSegment
[]
)
=>
Observable
<
boolean
|
RouteComponent
[]
>
Parameters
activator:
ICanLoad
Returns
(
route
:
RouteSnapshot
, segments
:
RouteSegment
[]
)
=>
Observable
<
boolean
|
RouteComponent
[]
>
(
route
:
RouteSnapshot
, segments
:
RouteSegment
[]
)
:
Observable
<
boolean
|
RouteComponent
[]
>
Parameters
route:
RouteSnapshot
segments:
RouteSegment
[]
Returns
Observable
<
boolean
|
RouteComponent
[]
>
resolve
Route_
resolve
Route_
(
routes
:
Routes
, route
:
Route
, initialUrl
:
string
, previousRoute
?:
RouteSnapshot
)
:
RouteSnapshot
|
undefined
Parameters
routes:
Routes
route:
Route
initialUrl:
string
Optional
previousRoute:
RouteSnapshot
Returns
RouteSnapshot
|
undefined
resolve
Routes_
resolve
Routes_
(
routes
:
Routes
, childRoutes
:
Routes
, initialUrl
:
string
, previousRoute
?:
RouteSnapshot
)
:
RouteSnapshot
|
undefined
Parameters
routes:
Routes
childRoutes:
Routes
initialUrl:
string
Optional
previousRoute:
RouteSnapshot
Returns
RouteSnapshot
|
undefined
session
Storage
Get_
session
Storage
Get_
(
key
:
string
)
:
any
Parameters
key:
string
Returns
any
session
Storage
Set_
session
Storage
Set_
(
key
:
string
, value
:
any
)
:
void
Parameters
key:
string
value:
any
Returns
void
transition$
transition$
(
callback
:
(
complete
:
(
result
:
boolean
)
=>
void
)
=>
void
)
:
any
Parameters
callback:
(
complete
:
(
result
:
boolean
)
=>
void
)
=>
void
(
complete
:
(
result
:
boolean
)
=>
void
)
:
void
Parameters
complete:
(
result
:
boolean
)
=>
void
(
result
:
boolean
)
:
void
Parameters
result:
boolean
Returns
void
Returns
void
Returns
any
transition
Once
transition
Once
(
)
:
void
Returns
void
transition
Onced
transition
Onced
(
)
:
any
Returns
any
Globals
Route
Location
Strategy
Activation
End
Activation
Start
Child
Activation
End
Child
Activation
Start
Guards
Check
End
Guards
Check
Start
Location
Strategy
Location
Strategy
Hash
Location
Strategy
Path
Navigation
Cancel
Navigation
End
Navigation
Error
Navigation
Start
Resolve
End
Resolve
Start
Route
Route
Config
Load
End
Route
Config
Load
Start
Route
Path
Route
Segment
Route
Snapshot
Router
Event
Router
Link
Active
Directive
Router
Link
Directive
Router
Module
Router
Outlet
Structure
Routes
Recognized
View
IBase
Route
ICan
Activate
ICan
Activate
Child
ICan
Deactivate
ICan
Load
ILocation
Strategy
INavigation
Extras
IRoute
IRoute
Path
IRouter
Event
Data
IRoutes
Params
Route
Component
Router
Activator
Router
Activator
Result
Router
Key
Value
Router
Link
Routes
as
Observable
is
Promise
transition$
transition
Once
transition
Onced