@angular-wave/angular.ts 0.7.0-beta.0 → 0.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1095) hide show
  1. package/.github/workflows/ci.yml +58 -14
  2. package/.github/workflows/gh-pages.yml +75 -0
  3. package/.husky/pre-commit +2 -0
  4. package/@types/animations/animate-children-directive.d.ts +4 -2
  5. package/@types/animations/animate-swap.d.ts +2 -2
  6. package/@types/animations/animate.d.ts +12 -5
  7. package/@types/animations/interface.d.ts +17 -0
  8. package/@types/animations/raf-scheduler.d.ts +29 -16
  9. package/@types/core/compile/attributes.d.ts +6 -3
  10. package/@types/core/compile/compile.d.ts +26 -19
  11. package/@types/core/controller/controller.d.ts +1 -1
  12. package/@types/core/di/injector.d.ts +1 -2
  13. package/@types/core/di/internal-injector.d.ts +15 -8
  14. package/@types/core/di/ng-module.d.ts +3 -4
  15. package/@types/core/error-handler.d.ts +7 -0
  16. package/@types/core/exception-handler.d.ts +5 -10
  17. package/@types/core/filter/filter.d.ts +20 -4
  18. package/@types/core/interpolate/interpolate.d.ts +3 -3
  19. package/@types/core/location/location.d.ts +1 -1
  20. package/@types/core/parse/interface.d.ts +79 -0
  21. package/@types/core/parse/interpreter.d.ts +19 -8
  22. package/@types/core/parse/parse.d.ts +2 -94
  23. package/@types/core/parse/parser/parser.d.ts +2 -2
  24. package/@types/core/pubsub/pubsub.d.ts +21 -0
  25. package/@types/core/sanitize/interface.d.ts +10 -0
  26. package/@types/core/sanitize/sanitize-uri.d.ts +31 -44
  27. package/@types/core/sce/sce.d.ts +107 -33
  28. package/@types/core/scope/scope.d.ts +26 -39
  29. package/@types/core/task-tracker-factory.d.ts +10 -5
  30. package/@types/directive/aria/aria.d.ts +4 -1
  31. package/@types/directive/bind/bind.d.ts +6 -6
  32. package/@types/directive/channel/channel.d.ts +2 -2
  33. package/@types/directive/class/class.d.ts +3 -3
  34. package/@types/directive/cloak/cloak.d.ts +2 -2
  35. package/@types/directive/controller/controller.d.ts +2 -2
  36. package/@types/directive/events/events.d.ts +4 -4
  37. package/@types/directive/form/form.d.ts +1 -1
  38. package/@types/directive/if/if.d.ts +2 -2
  39. package/@types/directive/include/include.d.ts +6 -20
  40. package/@types/directive/init/init.d.ts +2 -2
  41. package/@types/directive/input/input.d.ts +4 -4
  42. package/@types/directive/model/model.d.ts +10 -10
  43. package/@types/directive/model-options/model-options.d.ts +1 -1
  44. package/@types/directive/non-bindable/non-bindable.d.ts +2 -2
  45. package/@types/directive/observe/observe.d.ts +2 -2
  46. package/@types/directive/options/options.d.ts +2 -2
  47. package/@types/directive/repeat/repeat.d.ts +2 -2
  48. package/@types/directive/script/script.d.ts +2 -2
  49. package/@types/directive/select/select.d.ts +2 -2
  50. package/@types/directive/setter/setter.d.ts +6 -3
  51. package/@types/directive/show-hide/show-hide.d.ts +4 -4
  52. package/@types/directive/style/style.d.ts +2 -2
  53. package/@types/directive/switch/switch.d.ts +6 -6
  54. package/@types/directive/transclude/transclude.d.ts +3 -1
  55. package/@types/directive/validators/validators.d.ts +14 -14
  56. package/@types/filters/filter.d.ts +2 -7
  57. package/@types/filters/filters.d.ts +2 -2
  58. package/@types/filters/limit-to.d.ts +2 -6
  59. package/@types/filters/order-by.d.ts +4 -3
  60. package/@types/injection-tokens.d.ts +20 -0
  61. package/@types/interface.d.ts +302 -0
  62. package/@types/loader.d.ts +16 -18
  63. package/@types/public.d.ts +7 -8
  64. package/@types/router/common/glob.d.ts +25 -8
  65. package/@types/router/common/queue.d.ts +62 -13
  66. package/@types/router/common/trace.d.ts +8 -14
  67. package/@types/router/directives/state-directives.d.ts +11 -10
  68. package/@types/router/directives/view-directive.d.ts +3 -5
  69. package/@types/router/globals.d.ts +25 -7
  70. package/@types/router/params/interface.d.ts +606 -0
  71. package/@types/router/params/param.d.ts +1 -1
  72. package/@types/router/resolve/interface.d.ts +200 -0
  73. package/@types/router/state/interface.d.ts +983 -0
  74. package/@types/router/state/state-builder.d.ts +9 -2
  75. package/@types/router/state/state-object.d.ts +13 -3
  76. package/@types/router/state/state-registry.d.ts +18 -4
  77. package/@types/router/state/state-service.d.ts +18 -10
  78. package/@types/router/state/views.d.ts +14 -8
  79. package/@types/router/state-filters.d.ts +8 -4
  80. package/@types/router/template-factory.d.ts +4 -4
  81. package/@types/router/transition/interface.d.ts +876 -11
  82. package/@types/router/transition/transition-service.d.ts +4 -3
  83. package/@types/router/transition/transition.d.ts +25 -15
  84. package/@types/router/view/interface.d.ts +44 -0
  85. package/@types/router/view/view.d.ts +17 -5
  86. package/@types/services/anchor-scroll.d.ts +0 -1
  87. package/@types/shared/interface.d.ts +6 -0
  88. package/@types/shared/utils.d.ts +19 -44
  89. package/CHANGELOG.md +38 -38
  90. package/CODE_OF_CONDUCT.md +1 -1
  91. package/CONTRIBUTING.md +9 -9
  92. package/DEVELOPERS.md +30 -30
  93. package/Makefile +1 -1
  94. package/README.md +24 -26
  95. package/RELEASE.md +3 -3
  96. package/TRIAGING.md +3 -3
  97. package/dist/angular-ts.esm.js +4218 -3743
  98. package/dist/angular-ts.umd.js +4223 -3748
  99. package/dist/angular-ts.umd.min.js +1 -1
  100. package/docs/.cspell.yml +2 -2
  101. package/docs/.github/dependabot.yml +12 -12
  102. package/docs/README.md +10 -7
  103. package/docs/assets/icons/logo.svg +1 -0
  104. package/docs/assets/scss/_variables_project.scss +1 -0
  105. package/docs/content/en/_index.md +5 -64
  106. package/docs/content/en/docs/_index.md +3 -4
  107. package/docs/docker-compose.yaml +1 -0
  108. package/docs/go.mod +1 -1
  109. package/docs/go.sum +6 -6
  110. package/docs/hugo-disabled.toml +6 -7
  111. package/docs/hugo.yaml +45 -64
  112. package/docs/layouts/404.html +2 -8
  113. package/docs/layouts/_markup/render-heading.html +1 -0
  114. package/docs/package-lock.json +2293 -0
  115. package/docs/package.json +18 -7
  116. package/index.html +3 -12
  117. package/package.json +3 -3
  118. package/src/angular.spec.js +1 -99
  119. package/src/animations/animate-children-directive.js +4 -3
  120. package/src/animations/animate-css.js +2 -2
  121. package/src/animations/animate-css.md +1 -1
  122. package/src/animations/animate-queue.js +1 -1
  123. package/src/animations/animate-runner.js +3 -3
  124. package/src/animations/animate-swap.js +2 -2
  125. package/src/animations/animate.js +4 -2
  126. package/src/animations/animate.md +8 -8
  127. package/src/animations/animation.js +1 -0
  128. package/src/animations/interface.ts +19 -0
  129. package/src/animations/raf-scheduler.js +70 -54
  130. package/src/animations/raf-scheduler.spec.js +6 -0
  131. package/src/animations/shared.js +1 -1
  132. package/src/core/compile/attributes.js +17 -16
  133. package/src/core/compile/compile.js +2742 -2631
  134. package/src/core/compile/compile.md +13 -13
  135. package/src/core/compile/compile.spec.js +376 -479
  136. package/src/core/controller/controller.js +1 -1
  137. package/src/core/controller/controller.spec.js +27 -20
  138. package/src/core/di/injector.js +36 -11
  139. package/src/core/di/injector.md +6 -6
  140. package/src/core/di/internal-injector.js +21 -21
  141. package/src/core/di/ng-module.js +23 -10
  142. package/src/core/di/ng-module.spec.js +16 -16
  143. package/src/core/error-handler.ts +7 -0
  144. package/src/core/exception-handler.js +4 -9
  145. package/src/core/filter/filter.js +12 -4
  146. package/src/core/filter/filter.md +5 -5
  147. package/src/core/interpolate/interpolate.js +6 -6
  148. package/src/core/interpolate/interpolate.spec.js +1 -1
  149. package/src/core/location/location.js +3 -3
  150. package/src/core/parse/ast/ast.js +2 -2
  151. package/src/core/parse/ast/ast.spec.js +1 -9
  152. package/src/core/parse/interface.ts +84 -0
  153. package/src/core/parse/interpreter.js +33 -28
  154. package/src/core/parse/parse.js +14 -61
  155. package/src/core/parse/parse.md +6 -6
  156. package/src/core/parse/parser/parser.js +1 -1
  157. package/src/core/pubsub/pubsub.js +20 -0
  158. package/src/core/pubsub/pubsub.spec.js +14 -1
  159. package/src/core/sanitize/interface.ts +10 -0
  160. package/src/core/sanitize/sanitize-uri.js +47 -56
  161. package/src/core/sanitize/sanitize-uri.spec.js +1 -1
  162. package/src/core/sce/sce.js +376 -307
  163. package/src/core/sce/sce.md +13 -13
  164. package/src/core/scope/scope.js +121 -122
  165. package/src/core/scope/scope.spec.js +11 -11
  166. package/src/core/task-tracker-factory.js +7 -0
  167. package/src/directive/aria/aria.js +20 -21
  168. package/src/directive/attrs/attrs.js +2 -1
  169. package/src/directive/attrs/attrs.md +7 -7
  170. package/src/directive/bind/bind.js +7 -8
  171. package/src/directive/bind/bind.md +3 -3
  172. package/src/directive/channel/channel.js +1 -2
  173. package/src/directive/class/class.js +1 -2
  174. package/src/directive/cloak/cloak.js +1 -2
  175. package/src/directive/cloak/cloak.md +1 -1
  176. package/src/directive/controller/controller.js +1 -1
  177. package/src/directive/controller/controller.md +2 -2
  178. package/src/directive/events/events.js +3 -3
  179. package/src/directive/events/events.md +2 -2
  180. package/src/directive/form/form.js +5 -5
  181. package/src/directive/if/if.js +1 -1
  182. package/src/directive/include/include.js +23 -12
  183. package/src/directive/include/include.md +2 -2
  184. package/src/directive/include/include.spec.js +1 -0
  185. package/src/directive/init/init.js +1 -1
  186. package/src/directive/input/input-example.html +15 -0
  187. package/src/directive/input/input.js +15 -9
  188. package/src/directive/input/input.md +54 -54
  189. package/src/directive/input/input.spec.js +12 -14
  190. package/src/directive/messages/messages.js +4 -4
  191. package/src/directive/messages/messages.md +2 -2
  192. package/src/directive/model/model.js +3 -3
  193. package/src/directive/model-options/model-options.js +3 -3
  194. package/src/directive/model-options/model-options.md +1 -1
  195. package/src/directive/non-bindable/non-bindable.js +1 -2
  196. package/src/directive/non-bindable/non-bindable.md +1 -1
  197. package/src/directive/observe/observe.js +1 -1
  198. package/src/directive/observe/test.html +1 -1
  199. package/src/directive/options/options-example.html +13 -0
  200. package/src/directive/options/options.js +36 -26
  201. package/src/directive/options/options.md +1 -1
  202. package/src/directive/options/options.spec.js +207 -146
  203. package/src/directive/ref/ref.js +9 -4
  204. package/src/directive/repeat/repeat.js +15 -15
  205. package/src/directive/repeat/repeat.md +3 -3
  206. package/src/directive/script/script.js +3 -3
  207. package/src/directive/select/select.js +2 -2
  208. package/src/directive/select/select.md +3 -3
  209. package/src/directive/select/select.spec.js +1 -1
  210. package/src/directive/setter/setter.js +9 -7
  211. package/src/directive/setter/setter.spec.js +5 -4
  212. package/src/directive/show-hide/show-hide.js +2 -2
  213. package/src/directive/show-hide/show-hide.md +4 -4
  214. package/src/directive/style/style.js +2 -2
  215. package/src/directive/style/style.spec.js +1 -1
  216. package/src/directive/switch/switch.js +7 -8
  217. package/src/directive/transclude/transclude.js +2 -3
  218. package/src/directive/validators/validators.js +41 -40
  219. package/src/examples/counter.html +20 -0
  220. package/src/filters/filter.js +1 -1
  221. package/src/filters/filters.js +1 -1
  222. package/src/filters/limit-to.js +1 -1
  223. package/src/filters/order-by.js +5 -1
  224. package/src/filters/order-by.md +1 -1
  225. package/src/filters/order-by.spec.js +4 -4
  226. package/src/index.spec.js +11 -0
  227. package/src/injection-tokens.js +71 -0
  228. package/src/interface.ts +329 -0
  229. package/src/loader.js +22 -19
  230. package/src/loader.md +7 -7
  231. package/src/public.js +13 -8
  232. package/src/public.spec.js +1 -0
  233. package/src/router/common/{glob.html → common.html} +1 -0
  234. package/src/router/common/{glob.test.js → common.test.js} +1 -1
  235. package/src/router/common/glob.js +29 -7
  236. package/src/router/common/glob.spec.js +31 -1
  237. package/src/router/common/queue.js +69 -14
  238. package/src/router/common/queue.spec.js +80 -0
  239. package/src/router/common/trace.js +21 -15
  240. package/src/router/directives/component-example.html +37 -0
  241. package/src/router/directives/state-directives.js +14 -13
  242. package/src/router/directives/state-directives.spec.js +49 -46
  243. package/src/router/directives/view-directive.js +7 -8
  244. package/src/router/directives/view-directive.spec.js +1 -1
  245. package/src/router/globals.js +24 -5
  246. package/src/router/hooks/update-globals.js +2 -0
  247. package/src/router/params/interface.ts +626 -0
  248. package/src/router/params/param-types.js +2 -2
  249. package/src/router/params/param.js +1 -1
  250. package/src/router/resolve/interface.ts +208 -0
  251. package/src/router/resolve/resolvable.js +2 -2
  252. package/src/router/state/interface.ts +1007 -0
  253. package/src/router/state/state-builder.js +6 -2
  254. package/src/router/state/state-builder.spec.js +21 -15
  255. package/src/router/state/state-object.js +19 -5
  256. package/src/router/state/state-queue-manager.js +3 -5
  257. package/src/router/state/state-registry.js +21 -9
  258. package/src/router/state/state-service.js +14 -8
  259. package/src/router/state/views.js +9 -4
  260. package/src/router/state-filters.js +6 -0
  261. package/src/router/template-factory.js +2 -2
  262. package/src/router/template-factory.spec.js +15 -9
  263. package/src/router/transition/interface.ts +922 -0
  264. package/src/router/transition/transition-service.js +2 -1
  265. package/src/router/transition/transition.js +17 -7
  266. package/src/router/url/url-matcher.js +2 -2
  267. package/src/router/view/interface.ts +51 -0
  268. package/src/router/view/view.js +17 -10
  269. package/src/router/view/view.spec.js +3 -3
  270. package/src/router/view-scroll.spec.js +3 -4
  271. package/src/services/anchor-scroll.html +1 -1
  272. package/src/services/anchor-scroll.js +0 -4
  273. package/src/services/http/http.md +8 -8
  274. package/src/services/log.md +1 -1
  275. package/src/services/template-request.js +12 -8
  276. package/src/shared/dom.js +2 -2
  277. package/src/shared/interface.ts +6 -0
  278. package/src/shared/noderef.js +1 -3
  279. package/src/shared/utils.js +21 -53
  280. package/src/src.html +2 -1
  281. package/tsconfig.json +2 -1
  282. package/tsconfig.types.json +1 -0
  283. package/typedoc/assets/hierarchy.js +1 -1
  284. package/typedoc/assets/navigation.js +1 -1
  285. package/typedoc/assets/search.js +1 -1
  286. package/typedoc/classes/animations_animate-cache.AnimateCacheProvider.html +4 -40
  287. package/typedoc/classes/animations_animate-css-driver.AnimateCssDriverProvider.html +4 -58
  288. package/typedoc/classes/animations_animate-css.AnimateCssProvider.html +8 -44
  289. package/typedoc/classes/animations_animate-js-driver.AnimateJsDriverProvider.html +4 -58
  290. package/typedoc/classes/animations_animate-js.AnimateJsProvider.html +4 -58
  291. package/typedoc/classes/animations_animate-queue.AnimateQueueProvider.html +4 -69
  292. package/typedoc/classes/animations_animate-runner.AnimateAsyncRunFactoryProvider.html +4 -40
  293. package/typedoc/classes/animations_animate-runner.AnimateRunner.html +4 -263
  294. package/typedoc/classes/animations_animate-runner.AnimateRunnerFactoryProvider.html +4 -40
  295. package/typedoc/classes/animations_animate.AnimateProvider.html +42 -108
  296. package/typedoc/classes/animations_animation.AnimationProvider.html +8 -55
  297. package/typedoc/classes/animations_raf-scheduler.RafSchedulerProvider.html +246 -86
  298. package/typedoc/classes/core_cache_cache-factory.TemplateCacheProvider.html +4 -29
  299. package/typedoc/classes/core_compile_attributes.Attributes.html +22 -230
  300. package/typedoc/classes/core_compile_compile.CompileProvider.html +83 -160
  301. package/typedoc/classes/core_controller_controller.ControllerProvider.html +5 -74
  302. package/typedoc/classes/core_di_internal-injector.InjectorService.html +12 -144
  303. package/typedoc/classes/core_di_internal-injector.ProviderInjector.html +7 -119
  304. package/typedoc/classes/core_di_ng-module.NgModule.html +8 -260
  305. package/typedoc/classes/core_exception-handler.ExceptionHandlerProvider.html +9 -74
  306. package/typedoc/classes/core_filter_filter.FilterProvider.html +146 -76
  307. package/typedoc/classes/core_interpolate_interpolate.InterpolateProvider.html +12 -92
  308. package/typedoc/classes/core_location_location.Location.html +6 -388
  309. package/typedoc/classes/core_location_location.LocationHashbangUrl.html +6 -341
  310. package/typedoc/classes/core_location_location.LocationHtml5Url.html +6 -341
  311. package/typedoc/classes/core_location_location.LocationProvider.html +4 -113
  312. package/typedoc/classes/core_parse_ast_ast.AST.html +4 -359
  313. package/typedoc/classes/core_parse_interpreter.ASTInterpreter.html +60 -337
  314. package/typedoc/classes/core_parse_lexer_lexer.Lexer.html +4 -238
  315. package/typedoc/classes/core_parse_parse.ParseProvider.html +9 -57
  316. package/typedoc/classes/core_parse_parser_parser.Parser.html +6 -75
  317. package/typedoc/classes/core_pubsub_pubsub.PubSub.html +4 -146
  318. package/typedoc/classes/core_pubsub_pubsub.PubSubProvider.html +576 -0
  319. package/typedoc/classes/core_sanitize_sanitize-uri.SanitizeUriProvider.html +172 -344
  320. package/typedoc/classes/core_sce_sce.SceDelegateProvider.html +10 -146
  321. package/typedoc/classes/core_sce_sce.SceProvider.html +10 -63
  322. package/typedoc/classes/core_scope_scope.RootScopeProvider.html +6 -53
  323. package/typedoc/classes/core_scope_scope.Scope.html +179 -1493
  324. package/typedoc/classes/core_task-tracker-factory.TaskTracker.html +4 -84
  325. package/typedoc/classes/core_task-tracker-factory.TaskTrackerFactoryProvider.html +23 -128
  326. package/typedoc/classes/directive_aria_aria.AriaProvider.html +4 -51
  327. package/typedoc/classes/directive_form_form.FormController.html +5 -430
  328. package/typedoc/classes/directive_model_model.NgModelController.html +17 -996
  329. package/typedoc/classes/loader.Angular.html +72 -209
  330. package/typedoc/classes/router_common_glob.Glob.html +198 -171
  331. package/typedoc/classes/router_common_queue.Queue.html +252 -198
  332. package/typedoc/classes/router_common_trace.Trace.html +4 -249
  333. package/typedoc/classes/{router_globals.UIRouterGlobals.html → router_globals.RouterGlobals.html} +222 -109
  334. package/typedoc/classes/router_params_param-factory.ParamFactory.html +4 -73
  335. package/typedoc/classes/router_params_param-type.ParamType.html +4 -150
  336. package/typedoc/classes/router_params_param-types.ParamTypes.html +4 -95
  337. package/typedoc/classes/router_params_param.Param.html +4 -260
  338. package/typedoc/classes/router_params_state-params.StateParams.html +4 -40
  339. package/typedoc/classes/router_path_path-node.PathNode.html +4 -174
  340. package/typedoc/classes/router_path_path-utils.PathUtils.html +4 -128
  341. package/typedoc/classes/router_resolve_resolvable.Resolvable.html +4 -256
  342. package/typedoc/classes/router_resolve_resolve-context.ResolveContext.html +4 -150
  343. package/typedoc/classes/router_state-provider.StateProvider.html +4 -84
  344. package/typedoc/classes/router_state_state-builder.StateBuilder.html +4 -106
  345. package/typedoc/classes/router_state_state-matcher.StateMatcher.html +4 -73
  346. package/typedoc/classes/router_state_state-object.StateObject.html +155 -224
  347. package/typedoc/classes/router_state_state-queue-manager.StateQueueManager.html +4 -128
  348. package/typedoc/classes/router_state_state-registry.StateRegistryProvider.html +36 -334
  349. package/typedoc/classes/router_state_state-service.StateProvider.html +66 -336
  350. package/typedoc/classes/router_state_target-state.TargetState.html +4 -252
  351. package/typedoc/classes/{router_state_views.Ng1ViewConfig.html → router_state_views.ViewConfig.html} +58 -183
  352. package/typedoc/classes/router_template-factory.TemplateFactoryProvider.html +8 -209
  353. package/typedoc/classes/router_transition_hook-builder.HookBuilder.html +13 -75
  354. package/typedoc/classes/router_transition_hook-registry.RegisteredHook.html +4 -201
  355. package/typedoc/classes/router_transition_reject-factory.Rejection.html +4 -183
  356. package/typedoc/classes/router_transition_transition-event-type.TransitionEventType.html +4 -117
  357. package/typedoc/classes/router_transition_transition-hook.TransitionHook.html +4 -280
  358. package/typedoc/classes/router_transition_transition-service.TransitionProvider.html +11 -244
  359. package/typedoc/classes/router_transition_transition.Transition.html +412 -604
  360. package/typedoc/classes/router_url_url-config.UrlConfigProvider.html +4 -149
  361. package/typedoc/classes/router_url_url-matcher.UrlMatcher.html +4 -274
  362. package/typedoc/classes/router_url_url-rule.BaseUrlRule.html +4 -95
  363. package/typedoc/classes/router_url_url-rule.UrlRuleFactory.html +4 -124
  364. package/typedoc/classes/router_url_url-rules.UrlRules.html +4 -222
  365. package/typedoc/classes/router_url_url-service.UrlService.html +4 -373
  366. package/typedoc/classes/router_view-scroll.ViewScrollProvider.html +4 -69
  367. package/typedoc/classes/router_view_view.ViewService.html +166 -369
  368. package/typedoc/classes/services_anchor-scroll.AnchorScrollProvider.html +4 -164
  369. package/typedoc/classes/services_browser.Browser.html +4 -276
  370. package/typedoc/classes/services_browser.BrowserProvider.html +4 -29
  371. package/typedoc/classes/services_http-backend_http-backend.HttpBackendProvider.html +4 -40
  372. package/typedoc/classes/services_http_http.HttpParamSerializerProvider.html +4 -40
  373. package/typedoc/classes/services_http_http.HttpProvider.html +4 -84
  374. package/typedoc/classes/services_log.LogProvider.html +4 -91
  375. package/typedoc/classes/services_template-request.TemplateRequestProvider.html +8 -55
  376. package/typedoc/classes/shared_noderef.NodeRef.html +4 -301
  377. package/typedoc/enums/core_parse_ast-type.ASTType.html +4 -212
  378. package/typedoc/enums/router_common_trace.Category.html +492 -0
  379. package/typedoc/enums/router_transition_interface.TransitionHookPhase.html +10 -94
  380. package/typedoc/enums/router_transition_interface.TransitionHookScope.html +390 -0
  381. package/typedoc/enums/router_transition_reject-factory.RejectType.html +4 -80
  382. package/typedoc/functions/animations_animate-cache.animateCache.html +4 -84
  383. package/typedoc/functions/animations_animate-children-directive.__AnimateChildrenDirective.html +6 -31
  384. package/typedoc/functions/animations_animate-swap.ngAnimateSwapDirective.html +6 -31
  385. package/typedoc/functions/animations_shared.applyAnimationClassesFactory.html +4 -18
  386. package/typedoc/functions/animations_shared.applyAnimationFromStyles.html +4 -18
  387. package/typedoc/functions/animations_shared.applyAnimationStyles.html +4 -18
  388. package/typedoc/functions/animations_shared.applyAnimationToStyles.html +4 -18
  389. package/typedoc/functions/animations_shared.applyGeneratedPreparationClasses.html +4 -18
  390. package/typedoc/functions/animations_shared.applyInlineStyle.html +4 -18
  391. package/typedoc/functions/animations_shared.assertArg.html +4 -18
  392. package/typedoc/functions/animations_shared.blockKeyframeAnimations.html +4 -18
  393. package/typedoc/functions/animations_shared.clearGeneratedClasses.html +4 -18
  394. package/typedoc/functions/animations_shared.concatWithSpace.html +4 -18
  395. package/typedoc/functions/animations_shared.extractElementNode.html +4 -18
  396. package/typedoc/functions/animations_shared.mergeAnimationDetails.html +4 -18
  397. package/typedoc/functions/animations_shared.mergeClasses.html +4 -18
  398. package/typedoc/functions/animations_shared.packageStyles.html +4 -18
  399. package/typedoc/functions/animations_shared.pendClasses.html +4 -18
  400. package/typedoc/functions/animations_shared.prepareAnimationOptions.html +4 -18
  401. package/typedoc/functions/animations_shared.removeFromArray.html +4 -18
  402. package/typedoc/functions/animations_shared.resolveElementClasses.html +4 -18
  403. package/typedoc/functions/animations_shared.stripCommentsFromElement.html +4 -18
  404. package/typedoc/functions/core_controller_controller.identifierForController.html +4 -18
  405. package/typedoc/functions/core_di_injector.annotate.html +4 -18
  406. package/typedoc/functions/core_di_injector.createInjector.html +4 -18
  407. package/typedoc/functions/core_location_location.serverBase.html +4 -18
  408. package/typedoc/functions/core_location_location.stripBaseUrl.html +4 -18
  409. package/typedoc/functions/core_location_location.stripFile.html +4 -18
  410. package/typedoc/functions/core_location_location.stripHash.html +4 -18
  411. package/typedoc/functions/core_parse_interpreter.isAssignable.html +4 -18
  412. package/typedoc/functions/core_parse_parse.constantWatchDelegate.html +4 -18
  413. package/typedoc/functions/core_sce_sce.adjustMatcher.html +4 -18
  414. package/typedoc/functions/core_sce_sce.escapeForRegexp.html +4 -18
  415. package/typedoc/functions/core_scope_scope.createScope.html +4 -18
  416. package/typedoc/functions/core_scope_scope.nextId.html +4 -18
  417. package/typedoc/functions/core_url-utils_url-utils.getBaseUrl.html +4 -18
  418. package/typedoc/functions/core_url-utils_url-utils.urlIsAllowedOriginFactory.html +4 -18
  419. package/typedoc/functions/core_url-utils_url-utils.urlIsSameOrigin.html +4 -18
  420. package/typedoc/functions/core_url-utils_url-utils.urlIsSameOriginAsBaseUrl.html +4 -18
  421. package/typedoc/functions/core_url-utils_url-utils.urlResolve.html +4 -18
  422. package/typedoc/functions/core_url-utils_url-utils.urlsAreSameOrigin.html +4 -18
  423. package/typedoc/functions/directive_aria_aria.ngCheckedAriaDirective.html +4 -29
  424. package/typedoc/functions/directive_aria_aria.ngClickAriaDirective.html +6 -31
  425. package/typedoc/functions/directive_aria_aria.ngDblclickAriaDirective.html +4 -29
  426. package/typedoc/functions/directive_aria_aria.ngDisabledAriaDirective.html +4 -29
  427. package/typedoc/functions/directive_aria_aria.ngHideAriaDirective.html +4 -29
  428. package/typedoc/functions/directive_aria_aria.ngMessagesAriaDirective.html +4 -18
  429. package/typedoc/functions/directive_aria_aria.ngModelAriaDirective.html +4 -29
  430. package/typedoc/functions/directive_aria_aria.ngReadonlyAriaDirective.html +4 -29
  431. package/typedoc/functions/directive_aria_aria.ngRequiredAriaDirective.html +4 -29
  432. package/typedoc/functions/directive_aria_aria.ngShowAriaDirective.html +4 -29
  433. package/typedoc/functions/directive_aria_aria.ngValueAriaDirective.html +4 -29
  434. package/typedoc/functions/directive_bind_bind.ngBindDirective.html +6 -20
  435. package/typedoc/functions/directive_bind_bind.ngBindHtmlDirective.html +6 -31
  436. package/typedoc/functions/directive_bind_bind.ngBindTemplateDirective.html +6 -20
  437. package/typedoc/functions/directive_channel_channel.ngChannelDirective.html +6 -20
  438. package/typedoc/functions/directive_cloak_cloak.ngCloakDirective.html +6 -20
  439. package/typedoc/functions/directive_controller_controller.ngControllerDirective.html +6 -20
  440. package/typedoc/functions/directive_events_events.createEventDirective.html +10 -24
  441. package/typedoc/functions/directive_form_form.setupValidity.html +4 -18
  442. package/typedoc/functions/directive_if_if.ngIfDirective.html +6 -31
  443. package/typedoc/functions/directive_include_include.ngIncludeDirective.html +33 -178
  444. package/typedoc/functions/directive_include_include.ngIncludeFillContentDirective.html +6 -31
  445. package/typedoc/functions/directive_init_init.ngInitDirective.html +6 -20
  446. package/typedoc/functions/directive_input_input.badInputChecker.html +4 -18
  447. package/typedoc/functions/directive_input_input.countDecimals.html +4 -18
  448. package/typedoc/functions/directive_input_input.createDateInputType.html +4 -18
  449. package/typedoc/functions/directive_input_input.createDateParser.html +4 -18
  450. package/typedoc/functions/directive_input_input.hiddenInputBrowserCacheDirective.html +6 -20
  451. package/typedoc/functions/directive_input_input.inputDirective.html +4 -29
  452. package/typedoc/functions/directive_input_input.isNumberInteger.html +4 -18
  453. package/typedoc/functions/directive_input_input.isValidForStep.html +4 -18
  454. package/typedoc/functions/directive_input_input.ngValueDirective.html +6 -20
  455. package/typedoc/functions/directive_input_input.numberFormatterParser.html +4 -18
  456. package/typedoc/functions/directive_input_input.numberInputType.html +4 -18
  457. package/typedoc/functions/directive_input_input.rangeInputType.html +4 -18
  458. package/typedoc/functions/directive_input_input.weekParser.html +4 -18
  459. package/typedoc/functions/directive_messages_messages.ngMessagesDirective.html +4 -29
  460. package/typedoc/functions/directive_messages_messages.ngMessagesIncludeDirective.html +4 -29
  461. package/typedoc/functions/directive_model-options_model-options.ngModelOptionsDirective.html +6 -20
  462. package/typedoc/functions/directive_model_model.ngModelDirective.html +4 -18
  463. package/typedoc/functions/directive_non-bindable_non-bindable.ngNonBindableDirective.html +6 -20
  464. package/typedoc/functions/directive_observe_observe.ngObserveDirective.html +6 -20
  465. package/typedoc/functions/directive_ref_ref.ngRefDirective.html +4 -29
  466. package/typedoc/functions/directive_repeat_repeat.ngRepeatDirective.html +6 -31
  467. package/typedoc/functions/directive_script_script.scriptDirective.html +6 -31
  468. package/typedoc/functions/directive_select_select.optionDirective.html +4 -29
  469. package/typedoc/functions/directive_select_select.selectDirective.html +6 -20
  470. package/typedoc/functions/directive_setter_setter.ngSetterDirective.html +34 -33
  471. package/typedoc/functions/directive_show-hide_show-hide.ngHideDirective.html +6 -31
  472. package/typedoc/functions/directive_show-hide_show-hide.ngShowDirective.html +6 -31
  473. package/typedoc/functions/directive_style_style.ngStyleDirective.html +6 -20
  474. package/typedoc/functions/directive_switch_switch.ngSwitchDefaultDirective.html +6 -20
  475. package/typedoc/functions/directive_switch_switch.ngSwitchDirective.html +6 -31
  476. package/typedoc/functions/directive_switch_switch.ngSwitchWhenDirective.html +6 -20
  477. package/typedoc/functions/filters_filter.filterFilter.html +13 -92
  478. package/typedoc/functions/filters_filters.formatNumber.html +4 -18
  479. package/typedoc/functions/filters_filters.jsonFilter.html +14 -40
  480. package/typedoc/functions/filters_limit-to.limitToFilter.html +13 -106
  481. package/typedoc/functions/filters_order-by.orderByFilter.html +18 -80
  482. package/typedoc/functions/public.publishExternalAPI.html +12 -30
  483. package/typedoc/{types/types.Injectable.html → functions/router_common_glob.hasGlobs.html} +53 -41
  484. package/typedoc/functions/router_directives_state-directives._StateRefActiveDirective.html +15 -33
  485. package/typedoc/functions/router_directives_state-directives._StateRefDirective.html +4 -29
  486. package/typedoc/functions/router_directives_state-directives._StateRefDynamicDirective.html +17 -102
  487. package/typedoc/functions/router_directives_view-directive._ViewDirectiveFill.html +4 -39
  488. package/typedoc/functions/router_hooks_core-resolvables.registerAddCoreResolvables.html +4 -18
  489. package/typedoc/functions/router_hooks_core-resolvables.treeChangesCleanup.html +4 -18
  490. package/typedoc/functions/router_hooks_ignored-transition.registerIgnoredTransitionHook.html +4 -18
  491. package/typedoc/functions/router_hooks_invalid-transition.registerInvalidTransitionHook.html +4 -18
  492. package/typedoc/functions/router_hooks_lazy-load.lazyLoadState.html +4 -18
  493. package/typedoc/functions/router_hooks_lazy-load.registerLazyLoadHook.html +4 -18
  494. package/typedoc/functions/router_hooks_on-enter-exit-retain.registerOnEnterHook.html +4 -18
  495. package/typedoc/functions/router_hooks_on-enter-exit-retain.registerOnExitHook.html +4 -18
  496. package/typedoc/functions/router_hooks_on-enter-exit-retain.registerOnRetainHook.html +4 -18
  497. package/typedoc/functions/router_hooks_redirect-to.registerRedirectToHook.html +4 -18
  498. package/typedoc/functions/router_hooks_resolve.registerEagerResolvePath.html +4 -18
  499. package/typedoc/functions/router_hooks_resolve.registerLazyResolveState.html +4 -18
  500. package/typedoc/functions/router_hooks_resolve.registerResolveRemaining.html +4 -18
  501. package/typedoc/functions/router_hooks_update-globals.registerUpdateGlobalState.html +4 -18
  502. package/typedoc/functions/router_hooks_url.registerUpdateUrl.html +4 -18
  503. package/typedoc/functions/router_hooks_views.registerActivateViews.html +4 -18
  504. package/typedoc/functions/router_hooks_views.registerLoadEnteringViews.html +4 -18
  505. package/typedoc/functions/router_path_path-utils.makeTargetState.html +4 -18
  506. package/typedoc/functions/router_state-filters._IncludedByStateFilter.html +18 -65
  507. package/typedoc/functions/router_state-filters._IsStateFilter.html +15 -59
  508. package/typedoc/functions/router_state_state-builder.resolvablesBuilder.html +4 -18
  509. package/typedoc/functions/router_state_state-registry.getLocals.html +4 -18
  510. package/typedoc/functions/{router_state_views.getNg1ViewConfigFactory.html → router_state_views.getViewConfigFactory.html} +14 -30
  511. package/typedoc/functions/router_state_views.ng1ViewsBuilder.html +4 -18
  512. package/typedoc/functions/router_transition_hook-registry.makeEvent.html +4 -18
  513. package/typedoc/functions/router_transition_hook-registry.matchState.html +4 -18
  514. package/typedoc/functions/services_browser.trimEmptyHash.html +4 -18
  515. package/typedoc/functions/services_cookie-reader.getCookies.html +4 -18
  516. package/typedoc/functions/services_http-backend_http-backend.createHttpBackend.html +4 -18
  517. package/typedoc/functions/services_http_http.defaultHttpResponseTransform.html +4 -18
  518. package/typedoc/functions/shared_common._removeFrom.html +4 -18
  519. package/typedoc/functions/shared_common.allTrueR.html +4 -18
  520. package/typedoc/functions/shared_common.ancestors.html +4 -18
  521. package/typedoc/functions/shared_common.anyTrueR.html +4 -18
  522. package/typedoc/functions/shared_common.applyPairs.html +4 -18
  523. package/typedoc/functions/shared_common.arrayTuples.html +4 -18
  524. package/typedoc/functions/shared_common.assertFn.html +4 -18
  525. package/typedoc/functions/shared_common.copy.html +4 -18
  526. package/typedoc/functions/shared_common.createProxyFunctions.html +4 -18
  527. package/typedoc/functions/shared_common.defaults.html +4 -18
  528. package/typedoc/functions/shared_common.deregAll.html +4 -18
  529. package/typedoc/functions/shared_common.equals.html +4 -18
  530. package/typedoc/functions/shared_common.filter.html +4 -18
  531. package/typedoc/functions/shared_common.find.html +4 -18
  532. package/typedoc/functions/shared_common.flatten.html +4 -18
  533. package/typedoc/functions/shared_common.flattenR.html +4 -18
  534. package/typedoc/functions/shared_common.inherit.html +4 -18
  535. package/typedoc/functions/shared_common.map.html +4 -18
  536. package/typedoc/functions/shared_common.omit.html +4 -18
  537. package/typedoc/functions/shared_common.pairs.html +4 -18
  538. package/typedoc/functions/shared_common.pick.html +4 -18
  539. package/typedoc/functions/shared_common.pushR.html +4 -18
  540. package/typedoc/functions/shared_common.silenceUncaughtInPromise.html +4 -18
  541. package/typedoc/functions/shared_common.silentRejection.html +4 -18
  542. package/typedoc/functions/shared_common.tail.html +4 -18
  543. package/typedoc/functions/shared_common.uniqR.html +4 -18
  544. package/typedoc/functions/shared_common.unnest.html +4 -18
  545. package/typedoc/functions/shared_common.unnestR.html +4 -18
  546. package/typedoc/functions/shared_dom.appendNodesToElement.html +4 -18
  547. package/typedoc/functions/shared_dom.buildFragment.html +4 -18
  548. package/typedoc/functions/shared_dom.cleanElementData.html +4 -18
  549. package/typedoc/functions/shared_dom.createElementFromHTML.html +4 -18
  550. package/typedoc/functions/shared_dom.createNodelistFromHTML.html +4 -18
  551. package/typedoc/functions/shared_dom.dealoc.html +4 -18
  552. package/typedoc/functions/shared_dom.deleteCacheData.html +4 -18
  553. package/typedoc/functions/shared_dom.domInsert.html +4 -18
  554. package/typedoc/functions/shared_dom.emptyElement.html +4 -18
  555. package/typedoc/functions/shared_dom.getBlockNodes.html +4 -18
  556. package/typedoc/functions/shared_dom.getBooleanAttrName.html +4 -18
  557. package/typedoc/functions/shared_dom.getCacheData.html +4 -18
  558. package/typedoc/functions/shared_dom.getController.html +4 -18
  559. package/typedoc/functions/shared_dom.getExpando.html +4 -18
  560. package/typedoc/functions/shared_dom.getInheritedData.html +4 -18
  561. package/typedoc/functions/shared_dom.getInjector.html +4 -18
  562. package/typedoc/functions/shared_dom.getIsolateScope.html +4 -18
  563. package/typedoc/functions/shared_dom.getOrSetCacheData.html +4 -18
  564. package/typedoc/functions/shared_dom.getScope.html +4 -18
  565. package/typedoc/functions/shared_dom.isRoot.html +4 -18
  566. package/typedoc/functions/shared_dom.isTextNode.html +4 -18
  567. package/typedoc/functions/shared_dom.kebabToCamel.html +4 -18
  568. package/typedoc/functions/shared_dom.parseHtml.html +4 -18
  569. package/typedoc/functions/shared_dom.removeElement.html +4 -18
  570. package/typedoc/functions/shared_dom.removeElementData.html +4 -18
  571. package/typedoc/functions/shared_dom.setCacheData.html +4 -18
  572. package/typedoc/functions/shared_dom.setInheritedData.html +4 -18
  573. package/typedoc/functions/shared_dom.setIsolateScope.html +4 -18
  574. package/typedoc/functions/shared_dom.setScope.html +4 -18
  575. package/typedoc/functions/shared_dom.snakeToCamel.html +4 -18
  576. package/typedoc/functions/shared_dom.startingTag.html +4 -18
  577. package/typedoc/functions/shared_hof.all.html +4 -18
  578. package/typedoc/functions/shared_hof.compose.html +4 -18
  579. package/typedoc/functions/shared_hof.curry.html +4 -18
  580. package/typedoc/functions/shared_hof.is.html +4 -18
  581. package/typedoc/functions/shared_hof.or.html +4 -18
  582. package/typedoc/functions/shared_hof.parse.html +4 -18
  583. package/typedoc/functions/shared_hof.pattern.html +4 -18
  584. package/typedoc/functions/shared_hof.pipe.html +4 -18
  585. package/typedoc/functions/shared_hof.val.html +4 -18
  586. package/typedoc/functions/shared_predicates.isInjectable.html +4 -18
  587. package/typedoc/functions/shared_predicates.isPromise.html +4 -18
  588. package/typedoc/functions/shared_strings.beforeAfterSubstr.html +4 -18
  589. package/typedoc/functions/shared_strings.fnToString.html +4 -18
  590. package/typedoc/functions/shared_strings.functionToString.html +4 -18
  591. package/typedoc/functions/shared_strings.joinNeighborsR.html +4 -18
  592. package/typedoc/functions/shared_strings.kebobString.html +4 -18
  593. package/typedoc/functions/shared_strings.maxLength.html +4 -18
  594. package/typedoc/functions/shared_strings.padString.html +4 -18
  595. package/typedoc/functions/shared_strings.splitOnDelim.html +4 -18
  596. package/typedoc/functions/shared_strings.stringify.html +4 -18
  597. package/typedoc/functions/shared_strings.stripLastPathElement.html +4 -18
  598. package/typedoc/functions/shared_strings.trimHashVal.html +4 -18
  599. package/typedoc/functions/shared_test-utils.bootstrap.html +4 -18
  600. package/typedoc/functions/shared_test-utils.browserTrigger.html +4 -18
  601. package/typedoc/functions/shared_test-utils.wait.html +4 -18
  602. package/typedoc/functions/shared_utils.addDateMinutes.html +4 -18
  603. package/typedoc/functions/shared_utils.arrayRemove.html +4 -18
  604. package/typedoc/functions/shared_utils.assert.html +4 -18
  605. package/typedoc/functions/shared_utils.assertArg.html +4 -18
  606. package/typedoc/functions/shared_utils.assertArgFn.html +4 -18
  607. package/typedoc/functions/shared_utils.assertNotHasOwnProperty.html +4 -18
  608. package/typedoc/functions/shared_utils.baseExtend.html +4 -18
  609. package/typedoc/functions/shared_utils.bind.html +4 -18
  610. package/typedoc/functions/shared_utils.concat.html +4 -18
  611. package/typedoc/functions/shared_utils.convertTimezoneToLocal.html +4 -18
  612. package/typedoc/functions/shared_utils.csp.html +4 -18
  613. package/typedoc/functions/shared_utils.directiveNormalize.html +4 -18
  614. package/typedoc/functions/shared_utils.encodeUriQuery.html +4 -18
  615. package/typedoc/functions/shared_utils.encodeUriSegment.html +4 -18
  616. package/typedoc/functions/shared_utils.equals.html +4 -18
  617. package/typedoc/functions/shared_utils.errorHandlingConfig.html +4 -18
  618. package/typedoc/functions/shared_utils.extend.html +5 -19
  619. package/typedoc/functions/shared_utils.fromJson.html +4 -18
  620. package/typedoc/functions/shared_utils.getNgAttribute.html +4 -18
  621. package/typedoc/functions/shared_utils.getNodeName.html +4 -18
  622. package/typedoc/functions/shared_utils.hasAnimate.html +4 -18
  623. package/typedoc/functions/shared_utils.hasCustomToString.html +4 -18
  624. package/typedoc/functions/{shared_utils.merge.html → shared_utils.hasOwn.html} +45 -106
  625. package/typedoc/functions/shared_utils.hashKey.html +4 -18
  626. package/typedoc/functions/shared_utils.includes.html +4 -18
  627. package/typedoc/functions/shared_utils.inherit.html +4 -18
  628. package/typedoc/functions/shared_utils.isArrayBuffer.html +4 -18
  629. package/typedoc/functions/shared_utils.isArrayLike.html +7 -18
  630. package/typedoc/functions/shared_utils.isBlankObject.html +8 -18
  631. package/typedoc/functions/shared_utils.isBlob.html +4 -18
  632. package/typedoc/functions/shared_utils.isBoolean.html +4 -18
  633. package/typedoc/functions/shared_utils.isDate.html +4 -18
  634. package/typedoc/functions/shared_utils.isDefined.html +4 -18
  635. package/typedoc/functions/shared_utils.isElement.html +4 -18
  636. package/typedoc/functions/shared_utils.isError.html +4 -18
  637. package/typedoc/functions/shared_utils.isFile.html +4 -18
  638. package/typedoc/functions/shared_utils.isFormData.html +4 -18
  639. package/typedoc/functions/shared_utils.isFunction.html +4 -18
  640. package/typedoc/functions/shared_utils.isNull.html +4 -18
  641. package/typedoc/functions/shared_utils.isNullOrUndefined.html +4 -18
  642. package/typedoc/functions/shared_utils.isNumber.html +4 -18
  643. package/typedoc/functions/shared_utils.isNumberNaN.html +4 -18
  644. package/typedoc/functions/shared_utils.isObject.html +4 -18
  645. package/typedoc/functions/shared_utils.isObjectEmpty.html +4 -18
  646. package/typedoc/functions/shared_utils.isPromiseLike.html +4 -18
  647. package/typedoc/functions/shared_utils.isProxy.html +4 -18
  648. package/typedoc/functions/shared_utils.isRegExp.html +4 -18
  649. package/typedoc/functions/shared_utils.isScope.html +4 -18
  650. package/typedoc/functions/shared_utils.isString.html +4 -18
  651. package/typedoc/functions/shared_utils.isTypedArray.html +4 -18
  652. package/typedoc/functions/shared_utils.isUndefined.html +4 -18
  653. package/typedoc/functions/shared_utils.isValidObjectMaxDepth.html +4 -18
  654. package/typedoc/functions/shared_utils.isWindow.html +4 -18
  655. package/typedoc/functions/shared_utils.lowercase.html +4 -18
  656. package/typedoc/functions/shared_utils.mergeClasses.html +4 -18
  657. package/typedoc/functions/shared_utils.minErr.html +5 -19
  658. package/typedoc/functions/shared_utils.nextUid.html +4 -18
  659. package/typedoc/functions/shared_utils.parseKeyValue.html +4 -18
  660. package/typedoc/functions/shared_utils.setHashKey.html +4 -18
  661. package/typedoc/functions/shared_utils.shallowCopy.html +4 -18
  662. package/typedoc/functions/shared_utils.simpleCompare.html +4 -18
  663. package/typedoc/functions/shared_utils.sliceArgs.html +4 -18
  664. package/typedoc/functions/shared_utils.snakeCase.html +4 -18
  665. package/typedoc/functions/shared_utils.stringify.html +4 -18
  666. package/typedoc/functions/shared_utils.timezoneToOffset.html +4 -18
  667. package/typedoc/functions/shared_utils.toDebugString.html +4 -18
  668. package/typedoc/functions/shared_utils.toInt.html +4 -18
  669. package/typedoc/functions/shared_utils.toJson.html +5 -19
  670. package/typedoc/functions/shared_utils.toKeyValue.html +4 -18
  671. package/typedoc/functions/shared_utils.trim.html +4 -18
  672. package/typedoc/functions/shared_utils.tryDecodeURIComponent.html +9 -19
  673. package/typedoc/functions/shared_utils.uppercase.html +4 -18
  674. package/typedoc/hierarchy.html +8 -11
  675. package/typedoc/index.html +29 -32
  676. package/typedoc/interfaces/animations_animate.AnimationOptions.html +4 -62
  677. package/typedoc/interfaces/{types.Annotated.html → animations_raf-scheduler.ServiceProvider.html} +47 -51
  678. package/typedoc/interfaces/core_cache_cache.ExpandoStore.html +4 -51
  679. package/typedoc/interfaces/core_compile_compile.LinkFnMapping.html +20 -67
  680. package/typedoc/interfaces/core_compile_compile.NodeLinkFnCtx.html +596 -0
  681. package/typedoc/interfaces/core_compile_compile.SimpleChange.html +4 -40
  682. package/typedoc/interfaces/core_location_location.DefaultPorts.html +4 -51
  683. package/typedoc/interfaces/core_location_location.Html5Mode.html +4 -51
  684. package/typedoc/interfaces/core_parse_ast_ast.Token.html +4 -84
  685. package/typedoc/interfaces/{core_parse_parse.CompiledExpressionHandlerMap.html → core_parse_interface.CompiledExpressionHandlerMap.html} +22 -75
  686. package/typedoc/interfaces/{core_parse_parse.CompiledExpressionProps.html → core_parse_interface.CompiledExpressionProps.html} +189 -137
  687. package/typedoc/interfaces/core_parse_lexer_lexer.LexerOptions.html +4 -40
  688. package/typedoc/interfaces/core_parse_parser_parser.ParsedAST.html +4 -29
  689. package/typedoc/interfaces/core_sanitize_interface.SanitizerFn.html +305 -0
  690. package/typedoc/interfaces/core_scope_scope.AsyncQueueTask.html +4 -51
  691. package/typedoc/interfaces/core_scope_scope.Listener.html +6 -108
  692. package/typedoc/interfaces/directive_model-options_model-options.ModelOptionsConfig.html +4 -73
  693. package/typedoc/interfaces/{types.ChangesObject.html → interface.ChangesObject.html} +29 -101
  694. package/typedoc/interfaces/interface.ComponentOptions.html +712 -0
  695. package/typedoc/interfaces/{types.Controller.html → interface.Controller.html} +19 -119
  696. package/typedoc/interfaces/{types.Directive.html → interface.Directive.html} +159 -323
  697. package/typedoc/interfaces/{types.DirectivePrePost.html → interface.DirectivePrePost.html} +18 -53
  698. package/typedoc/interfaces/interface.NgModelController.html +1362 -0
  699. package/typedoc/interfaces/{types.NgModelOptions.html → interface.NgModelOptions.html} +32 -105
  700. package/typedoc/interfaces/interface.Provider.html +1056 -0
  701. package/typedoc/interfaces/interface.TranscludeFunctionObject.html +723 -0
  702. package/typedoc/interfaces/loader.AngularBootstrapConfig.html +4 -29
  703. package/typedoc/interfaces/router_params_interface.ParamDeclaration.html +1211 -0
  704. package/typedoc/interfaces/router_params_interface.ParamTypeDefinition.html +1273 -0
  705. package/typedoc/interfaces/router_params_interface.RawParams.html +295 -0
  706. package/typedoc/interfaces/router_params_interface.Replace.html +429 -0
  707. package/typedoc/{types/animations_raf-scheduler.RafSchedulerFunction.html → interfaces/router_resolve_interface.CustomAsyncPolicy.html} +51 -26
  708. package/typedoc/interfaces/router_resolve_interface.ProviderLike.html +580 -0
  709. package/typedoc/interfaces/router_resolve_interface.ResolvableLiteral.html +601 -0
  710. package/typedoc/interfaces/router_resolve_interface.ResolvePolicy.html +638 -0
  711. package/typedoc/interfaces/router_state_interface.HrefOptions.html +530 -0
  712. package/typedoc/interfaces/{types.ServiceProviderClass.html → router_state_interface.LazyLoadResult.html} +46 -51
  713. package/typedoc/interfaces/router_state_interface.StateDeclaration.html +2461 -0
  714. package/typedoc/interfaces/router_state_interface.TargetStateDef.html +468 -0
  715. package/typedoc/interfaces/router_state_interface.TransitionPromise.html +1192 -0
  716. package/typedoc/interfaces/router_state_interface.ViewDeclaration.html +1499 -0
  717. package/typedoc/interfaces/router_template-factory.BindingTuple.html +4 -40
  718. package/typedoc/interfaces/router_transition_interface.HookMatchCriteria.html +719 -0
  719. package/typedoc/interfaces/router_transition_interface.HookRegOptions.html +482 -0
  720. package/typedoc/interfaces/router_transition_interface.IHookRegistry.html +2969 -0
  721. package/typedoc/interfaces/router_transition_interface.IMatchingNodes.html +594 -0
  722. package/typedoc/interfaces/{animations_raf-scheduler.RafSchedulerObject.html → router_transition_interface.PathType.html} +64 -52
  723. package/typedoc/interfaces/router_transition_interface.PathTypes.html +588 -0
  724. package/typedoc/{variables/core_di_ng-module.PROVIDE_LITERAL.html → interfaces/router_transition_interface.RegisteredHooks.html} +27 -24
  725. package/typedoc/{functions/shared_utils.replaceInline.html → interfaces/router_transition_interface.TransitionCreateHookFn.html} +44 -59
  726. package/typedoc/interfaces/router_transition_interface.TransitionHookFn.html +352 -0
  727. package/typedoc/interfaces/router_transition_interface.TransitionHookOptions.html +627 -0
  728. package/typedoc/interfaces/router_transition_interface.TransitionOptions.html +1096 -0
  729. package/typedoc/interfaces/router_transition_interface.TransitionStateHookFn.html +374 -0
  730. package/typedoc/interfaces/router_transition_interface.TreeChanges.html +769 -0
  731. package/typedoc/interfaces/{types.TranscludeFunctionObject.html → router_view_interface.ActiveUIView.html} +197 -199
  732. package/typedoc/interfaces/router_view_interface.ViewConfig.html +651 -0
  733. package/typedoc/interfaces/{types.OnChangesObject.html → router_view_interface.ViewContext.html} +65 -58
  734. package/typedoc/interfaces/services_anchor-scroll.AnchorScrollObject.html +4 -29
  735. package/typedoc/interfaces/services_log.LogService.html +4 -80
  736. package/typedoc/{types/core_parse_parse.CompiledExpressionFunction.html → interfaces/shared_interface.TypedMap.html} +28 -26
  737. package/typedoc/interfaces/shared_utils.ErrorHandlingConfig.html +4 -40
  738. package/typedoc/media/CONTRIBUTING.md +9 -9
  739. package/typedoc/media/DEVELOPERS.md +30 -30
  740. package/typedoc/modules/animations_animate-cache.html +4 -7
  741. package/typedoc/modules/animations_animate-children-directive.html +4 -9
  742. package/typedoc/modules/animations_animate-css-driver.html +4 -7
  743. package/typedoc/modules/animations_animate-css.html +4 -7
  744. package/typedoc/modules/animations_animate-js-driver.html +4 -7
  745. package/typedoc/modules/animations_animate-js.html +4 -7
  746. package/typedoc/modules/animations_animate-queue.html +4 -7
  747. package/typedoc/modules/animations_animate-runner.html +4 -7
  748. package/typedoc/modules/animations_animate-swap.html +4 -7
  749. package/typedoc/modules/animations_animate.html +4 -7
  750. package/typedoc/modules/animations_animation.html +4 -7
  751. package/typedoc/modules/animations_interface.html +322 -0
  752. package/typedoc/modules/animations_raf-scheduler.html +19 -52
  753. package/typedoc/modules/animations_shared.html +4 -7
  754. package/typedoc/modules/core_cache_cache-factory.html +4 -7
  755. package/typedoc/modules/core_cache_cache.html +4 -7
  756. package/typedoc/modules/core_compile_attributes.html +4 -7
  757. package/typedoc/modules/core_compile_compile.html +31 -7
  758. package/typedoc/modules/core_controller_controller.html +4 -7
  759. package/typedoc/modules/core_di_injector.html +4 -65
  760. package/typedoc/modules/core_di_internal-injector.html +4 -7
  761. package/typedoc/modules/core_di_ng-module.html +4 -34
  762. package/typedoc/{types/types.AnnotatedFunction.html → modules/core_error-handler.html} +86 -35
  763. package/typedoc/modules/core_exception-handler.html +52 -19
  764. package/typedoc/modules/core_filter_filter.html +4 -7
  765. package/typedoc/modules/core_interpolate_interpolate.html +4 -7
  766. package/typedoc/modules/core_location_location.html +4 -7
  767. package/typedoc/modules/core_parse_ast-type.html +4 -7
  768. package/typedoc/modules/core_parse_ast_ast-node.html +4 -7
  769. package/typedoc/modules/core_parse_ast_ast.html +4 -69
  770. package/typedoc/modules/core_parse_interface.html +470 -0
  771. package/typedoc/modules/core_parse_interpreter.html +4 -7
  772. package/typedoc/modules/core_parse_lexer_lexer.html +4 -7
  773. package/typedoc/modules/core_parse_lexer_token.html +4 -7
  774. package/typedoc/modules/core_parse_parse.html +4 -220
  775. package/typedoc/modules/core_parse_parser_parser.html +4 -7
  776. package/typedoc/modules/core_pubsub_pubsub.html +95 -7
  777. package/typedoc/modules/core_sanitize_interface.html +320 -0
  778. package/typedoc/modules/core_sanitize_sanitize-uri.html +68 -7
  779. package/typedoc/modules/core_sce_sce.html +5 -8
  780. package/typedoc/modules/core_scope_scope.html +4 -7
  781. package/typedoc/modules/core_task-tracker-factory.html +134 -7
  782. package/typedoc/modules/core_url-utils_url-utils.html +4 -7
  783. package/typedoc/modules/directive_aria_aria.html +4 -7
  784. package/typedoc/modules/directive_attrs_attrs.html +4 -7
  785. package/typedoc/modules/directive_bind_bind.html +4 -7
  786. package/typedoc/modules/directive_channel_channel.html +4 -7
  787. package/typedoc/modules/directive_class_class.html +4 -7
  788. package/typedoc/modules/directive_cloak_cloak.html +4 -7
  789. package/typedoc/modules/directive_controller_controller.html +4 -7
  790. package/typedoc/modules/directive_events_events.html +4 -7
  791. package/typedoc/modules/directive_form_form.html +4 -7
  792. package/typedoc/modules/directive_if_if.html +4 -7
  793. package/typedoc/modules/directive_include_include.html +4 -7
  794. package/typedoc/modules/directive_init_init.html +4 -7
  795. package/typedoc/modules/directive_input_input.html +4 -7
  796. package/typedoc/modules/directive_messages_messages.html +4 -7
  797. package/typedoc/modules/directive_model-options_model-options.html +4 -9
  798. package/typedoc/modules/directive_model_model.html +4 -7
  799. package/typedoc/modules/directive_non-bindable_non-bindable.html +4 -9
  800. package/typedoc/modules/directive_observe_observe.html +4 -7
  801. package/typedoc/modules/directive_options_options.html +4 -7
  802. package/typedoc/modules/directive_ref_ref.html +4 -7
  803. package/typedoc/modules/directive_repeat_repeat.html +4 -7
  804. package/typedoc/modules/directive_script_script.html +4 -7
  805. package/typedoc/modules/directive_select_select.html +4 -7
  806. package/typedoc/modules/directive_setter_setter.html +4 -7
  807. package/typedoc/modules/directive_show-hide_show-hide.html +4 -7
  808. package/typedoc/modules/directive_style_style.html +4 -7
  809. package/typedoc/modules/directive_switch_switch.html +4 -7
  810. package/typedoc/modules/directive_transclude_transclude.html +4 -7
  811. package/typedoc/modules/directive_validators_validators.html +4 -7
  812. package/typedoc/modules/filters_filter.html +4 -7
  813. package/typedoc/modules/filters_filters.html +4 -7
  814. package/typedoc/modules/filters_limit-to.html +4 -7
  815. package/typedoc/modules/filters_order-by.html +4 -7
  816. package/typedoc/modules/index.html +4 -84
  817. package/typedoc/{types/types.transcludeWithScope.html → modules/injection-tokens.html} +84 -27
  818. package/typedoc/modules/{types.html → interface.html} +111 -420
  819. package/typedoc/modules/loader.html +4 -7
  820. package/typedoc/modules/public.html +4 -7
  821. package/typedoc/modules/router_common_glob.html +66 -188
  822. package/typedoc/modules/router_common_queue.html +4 -7
  823. package/typedoc/modules/router_common_trace.html +69 -34
  824. package/typedoc/modules/router_directives_state-directives.html +4 -7
  825. package/typedoc/modules/router_directives_view-directive.html +4 -7
  826. package/typedoc/modules/router_globals.html +74 -13
  827. package/typedoc/modules/router_hooks_core-resolvables.html +4 -7
  828. package/typedoc/modules/router_hooks_ignored-transition.html +4 -7
  829. package/typedoc/modules/router_hooks_invalid-transition.html +4 -7
  830. package/typedoc/modules/router_hooks_lazy-load.html +4 -7
  831. package/typedoc/modules/router_hooks_on-enter-exit-retain.html +4 -7
  832. package/typedoc/modules/router_hooks_redirect-to.html +4 -7
  833. package/typedoc/modules/router_hooks_resolve.html +4 -7
  834. package/typedoc/modules/router_hooks_update-globals.html +4 -7
  835. package/typedoc/modules/router_hooks_url.html +4 -7
  836. package/typedoc/modules/router_hooks_views.html +4 -7
  837. package/typedoc/modules/router_params_interface.html +402 -0
  838. package/typedoc/modules/router_params_param-factory.html +4 -7
  839. package/typedoc/modules/router_params_param-type.html +4 -7
  840. package/typedoc/modules/router_params_param-types.html +4 -7
  841. package/typedoc/modules/router_params_param.html +4 -7
  842. package/typedoc/modules/router_params_state-params.html +4 -7
  843. package/typedoc/modules/router_path_path-node.html +4 -7
  844. package/typedoc/modules/router_path_path-utils.html +4 -7
  845. package/typedoc/modules/router_resolve_interface.html +521 -0
  846. package/typedoc/modules/router_resolve_resolvable.html +4 -7
  847. package/typedoc/modules/router_resolve_resolve-context.html +4 -7
  848. package/typedoc/modules/router_state-filters.html +4 -7
  849. package/typedoc/modules/router_state-provider.html +4 -7
  850. package/typedoc/modules/router_state_interface.html +606 -0
  851. package/typedoc/modules/router_state_state-builder.html +4 -7
  852. package/typedoc/modules/router_state_state-matcher.html +4 -7
  853. package/typedoc/modules/router_state_state-object.html +68 -7
  854. package/typedoc/modules/router_state_state-queue-manager.html +4 -7
  855. package/typedoc/modules/router_state_state-registry.html +68 -7
  856. package/typedoc/modules/router_state_state-service.html +4 -7
  857. package/typedoc/modules/router_state_target-state.html +4 -7
  858. package/typedoc/modules/router_state_views.html +16 -21
  859. package/typedoc/modules/router_template-factory.html +4 -7
  860. package/typedoc/modules/router_transition_hook-builder.html +4 -7
  861. package/typedoc/modules/router_transition_hook-registry.html +4 -7
  862. package/typedoc/modules/router_transition_interface.html +557 -21
  863. package/typedoc/modules/router_transition_reject-factory.html +4 -7
  864. package/typedoc/modules/router_transition_transition-event-type.html +4 -9
  865. package/typedoc/modules/router_transition_transition-hook.html +4 -7
  866. package/typedoc/modules/router_transition_transition-service.html +4 -9
  867. package/typedoc/modules/router_transition_transition.html +68 -7
  868. package/typedoc/modules/router_url_url-config.html +4 -7
  869. package/typedoc/modules/router_url_url-matcher.html +4 -7
  870. package/typedoc/modules/router_url_url-rule.html +4 -7
  871. package/typedoc/modules/router_url_url-rules.html +4 -7
  872. package/typedoc/modules/router_url_url-service.html +4 -7
  873. package/typedoc/modules/router_view-scroll.html +4 -7
  874. package/typedoc/modules/router_view_interface.html +373 -0
  875. package/typedoc/modules/router_view_view.html +4 -7
  876. package/typedoc/modules/services_anchor-scroll.html +4 -7
  877. package/typedoc/modules/services_browser.html +4 -7
  878. package/typedoc/modules/services_cookie-reader.html +4 -7
  879. package/typedoc/modules/services_http-backend_http-backend.html +4 -7
  880. package/typedoc/modules/services_http_http.html +4 -7
  881. package/typedoc/modules/services_log.html +4 -7
  882. package/typedoc/modules/services_template-request.html +4 -7
  883. package/typedoc/modules/shared_common.html +4 -7
  884. package/typedoc/modules/shared_constants.html +4 -7
  885. package/typedoc/modules/shared_dom.html +4 -7
  886. package/typedoc/modules/shared_hof.html +4 -7
  887. package/typedoc/modules/shared_interface.html +436 -0
  888. package/typedoc/modules/shared_noderef.html +4 -7
  889. package/typedoc/modules/shared_predicates.html +4 -7
  890. package/typedoc/modules/shared_strings.html +4 -7
  891. package/typedoc/modules/shared_test-utils.html +4 -7
  892. package/typedoc/modules/shared_utils.html +30 -60
  893. package/typedoc/modules.html +298 -31
  894. package/typedoc/types/animations_animate.AnimationMethod.html +4 -18
  895. package/typedoc/types/animations_interface.RafScheduler.html +602 -0
  896. package/typedoc/types/core_cache_cache-factory.TemplateCache.html +4 -18
  897. package/typedoc/types/core_compile_compile.ApplyDirectivesToNodeFn.html +4 -18
  898. package/typedoc/types/core_compile_compile.BoundTranscludeFn.html +4 -18
  899. package/typedoc/types/core_compile_compile.CompileFn.html +4 -18
  900. package/typedoc/types/core_compile_compile.CompileNodesFn.html +4 -18
  901. package/typedoc/types/core_compile_compile.CompositeLinkFn.html +4 -18
  902. package/typedoc/types/core_compile_compile.NodeLinkFn.html +6 -50
  903. package/typedoc/types/core_compile_compile.PublicLinkFn.html +13 -18
  904. package/typedoc/types/core_compile_compile.TranscludeFn.html +4 -18
  905. package/typedoc/types/{core_exception-handler.ErrorHandler.html → core_error-handler.ErrorHandler.html} +10 -21
  906. package/typedoc/types/core_exception-handler.LogService.html +4 -18
  907. package/typedoc/types/core_parse_ast_ast-node.ASTNode.html +4 -293
  908. package/typedoc/types/{core_parse_parse.CompiledExpression.html → core_parse_interface.CompiledExpression.html} +15 -21
  909. package/typedoc/types/core_parse_interface.CompiledExpressionFunction.html +347 -0
  910. package/typedoc/types/core_parse_interface.ParseService.html +474 -0
  911. package/typedoc/types/core_parse_interpreter.DecoratedASTNode.html +4 -18
  912. package/typedoc/types/core_scope_scope.ListenerFunction.html +4 -18
  913. package/typedoc/{variables/router_common_trace.Category.html → types/core_task-tracker-factory.AnnotatedFactory.html} +30 -32
  914. package/typedoc/types/core_url-utils_url-utils.HttpProtocol.html +4 -18
  915. package/typedoc/types/{types.CloneAttachFunction.html → interface.CloneAttachFunction.html} +8 -27
  916. package/typedoc/types/interface.ControllerConstructor.html +315 -0
  917. package/typedoc/types/interface.DirectiveCompileFn.html +406 -0
  918. package/typedoc/types/{types.DirectiveController.html → interface.DirectiveController.html} +11 -22
  919. package/typedoc/types/{types.DirectiveFactory.html → interface.DirectiveFactory.html} +14 -25
  920. package/typedoc/types/{types.DirectiveLinkFn.html → interface.DirectiveLinkFn.html} +62 -68
  921. package/typedoc/types/{types.Expression.html → interface.Expression.html} +16 -19
  922. package/typedoc/types/interface.FilterFactory.html +310 -0
  923. package/typedoc/types/interface.FilterFn.html +314 -0
  924. package/typedoc/types/{types.TAttributes.html → interface.Injectable.html} +16 -25
  925. package/typedoc/types/interface.InjectableFactory.html +309 -0
  926. package/typedoc/types/{types.Attributes.html → interface.OnChangesObject.html} +16 -24
  927. package/typedoc/types/{types.TController.html → interface.TController.html} +10 -21
  928. package/typedoc/types/{types.FilterFactory.html → router_resolve_interface.PolicyAsync.html} +21 -24
  929. package/typedoc/types/{types.TElement.html → router_resolve_interface.PolicyWhen.html} +15 -24
  930. package/typedoc/types/router_state_interface.RedirectToResult.html +287 -0
  931. package/typedoc/{variables/index.angular.html → types/router_state_interface.ResolveTypes.html} +27 -25
  932. package/typedoc/types/{types.TScope.html → router_state_interface.StateOrName.html} +22 -25
  933. package/typedoc/types/{animations_raf-scheduler.RafScheduler.html → router_state_interface._StateDeclaration.html} +28 -30
  934. package/typedoc/types/{types.ServiceProvider.html → router_transition_interface.HookFn.html} +28 -25
  935. package/typedoc/types/router_transition_interface.HookMatchCriterion.html +270 -0
  936. package/typedoc/{variables/router_transition_interface.TransitionHookScope.html → types/router_transition_interface.HookResult.html} +61 -50
  937. package/typedoc/types/{types.DirectiveCompileFn.html → router_transition_interface.IHookRegistration.html} +54 -68
  938. package/typedoc/{variables/core_parse_ast_ast.literals.html → types/router_transition_interface.IStateMatch.html} +28 -28
  939. package/typedoc/types/services_anchor-scroll.AnchorScrollFunction.html +4 -18
  940. package/typedoc/types/services_anchor-scroll.AnchorScrollService.html +4 -18
  941. package/typedoc/types/services_browser.UrlChangeListener.html +4 -18
  942. package/typedoc/types/services_log.LogCall.html +4 -18
  943. package/typedoc/types/shared_interface.Mapper.html +337 -0
  944. package/typedoc/types/shared_interface.Predicate.html +305 -0
  945. package/typedoc/types/shared_interface.PredicateBinary.html +330 -0
  946. package/typedoc/variables/animations_shared.ACTIVE_CLASS_SUFFIX.html +4 -18
  947. package/typedoc/variables/animations_shared.ADD_CLASS_SUFFIX.html +4 -18
  948. package/typedoc/variables/animations_shared.ANIMATIONEND_EVENT.html +4 -18
  949. package/typedoc/variables/animations_shared.ANIMATION_DELAY_PROP.html +4 -18
  950. package/typedoc/variables/animations_shared.ANIMATION_DURATION_PROP.html +4 -18
  951. package/typedoc/variables/animations_shared.ANIMATION_ITERATION_COUNT_KEY.html +4 -18
  952. package/typedoc/variables/animations_shared.ANIMATION_PLAYSTATE_KEY.html +4 -18
  953. package/typedoc/variables/animations_shared.ANIMATION_PROP.html +4 -18
  954. package/typedoc/variables/animations_shared.CSS_PREFIX.html +4 -18
  955. package/typedoc/variables/animations_shared.DELAY_KEY.html +4 -18
  956. package/typedoc/variables/animations_shared.DURATION_KEY.html +4 -18
  957. package/typedoc/variables/animations_shared.EVENT_CLASS_PREFIX.html +4 -18
  958. package/typedoc/variables/animations_shared.NG_ANIMATE_CHILDREN_DATA.html +4 -18
  959. package/typedoc/variables/animations_shared.NG_ANIMATE_CLASSNAME.html +4 -18
  960. package/typedoc/variables/animations_shared.PREPARE_CLASS_SUFFIX.html +4 -18
  961. package/typedoc/variables/animations_shared.PROPERTY_KEY.html +4 -18
  962. package/typedoc/variables/animations_shared.REMOVE_CLASS_SUFFIX.html +4 -18
  963. package/typedoc/variables/animations_shared.SAFE_FAST_FORWARD_DURATION_VALUE.html +4 -18
  964. package/typedoc/variables/animations_shared.TIMING_KEY.html +4 -18
  965. package/typedoc/variables/animations_shared.TRANSITIONEND_EVENT.html +4 -18
  966. package/typedoc/variables/animations_shared.TRANSITION_DELAY_PROP.html +4 -18
  967. package/typedoc/variables/animations_shared.TRANSITION_DURATION_PROP.html +4 -18
  968. package/typedoc/variables/animations_shared.TRANSITION_PROP.html +4 -18
  969. package/typedoc/variables/animations_shared.ngMinErr.html +4 -18
  970. package/typedoc/variables/core_cache_cache.Cache.html +4 -18
  971. package/typedoc/variables/core_cache_cache.EXPANDO.html +4 -18
  972. package/typedoc/variables/core_cache_cache.ISOLATE_SCOPE_KEY.html +4 -18
  973. package/typedoc/variables/core_cache_cache.SCOPE_KEY.html +4 -18
  974. package/typedoc/variables/core_compile_compile.DirectiveSuffix.html +4 -18
  975. package/typedoc/variables/core_di_ng-module.ANIMATION_LITERAL.html +4 -18
  976. package/typedoc/variables/core_di_ng-module.COMPILE_LITERAL.html +4 -18
  977. package/typedoc/variables/core_di_ng-module.CONTROLLER_LITERAL.html +4 -18
  978. package/typedoc/variables/core_di_ng-module.FILTER_LITERAL.html +4 -18
  979. package/typedoc/variables/core_di_ng-module.INJECTOR_LITERAL.html +4 -18
  980. package/typedoc/variables/core_parse_interpreter.PURITY_ABSOLUTE.html +4 -18
  981. package/typedoc/variables/core_parse_interpreter.PURITY_RELATIVE.html +4 -18
  982. package/typedoc/variables/core_pubsub_pubsub.EventBus.html +4 -18
  983. package/typedoc/variables/core_sce_sce.SCE_CONTEXTS.html +4 -18
  984. package/typedoc/variables/core_scope_scope.NONSCOPE.html +4 -18
  985. package/typedoc/variables/core_scope_scope.__applyAsyncQueue.html +4 -18
  986. package/typedoc/variables/core_scope_scope._postUpdateQueue.html +4 -18
  987. package/typedoc/variables/directive_attrs_attrs.REGEX_STRING_REGEXP.html +4 -18
  988. package/typedoc/variables/directive_attrs_attrs.ngAttributeAliasDirectives.html +4 -18
  989. package/typedoc/variables/directive_class_class.ngClassDirective.html +7 -21
  990. package/typedoc/variables/directive_class_class.ngClassEvenDirective.html +7 -21
  991. package/typedoc/variables/directive_class_class.ngClassOddDirective.html +7 -21
  992. package/typedoc/variables/directive_events_events.ngEventDirectives.html +4 -18
  993. package/typedoc/variables/directive_form_form.PENDING_CLASS.html +4 -18
  994. package/typedoc/variables/directive_form_form.formDirective.html +4 -18
  995. package/typedoc/variables/directive_form_form.ngFormDirective.html +4 -18
  996. package/typedoc/variables/directive_form_form.nullFormCtrl.html +4 -18
  997. package/typedoc/variables/directive_input_input.EMAIL_REGEXP.html +4 -18
  998. package/typedoc/variables/directive_input_input.ISO_DATE_REGEXP.html +4 -18
  999. package/typedoc/variables/directive_input_input.URL_REGEXP.html +4 -18
  1000. package/typedoc/variables/directive_input_input.VALIDITY_STATE_PROPERTY.html +4 -18
  1001. package/typedoc/variables/directive_messages_messages.ngMessageDefaultDirective.html +4 -18
  1002. package/typedoc/variables/directive_messages_messages.ngMessageDirective.html +4 -18
  1003. package/typedoc/variables/directive_messages_messages.ngMessageExpDirective.html +4 -18
  1004. package/typedoc/variables/directive_model-options_model-options.defaultModelOptions.html +4 -18
  1005. package/typedoc/variables/directive_model_model.ngModelMinErr.html +4 -18
  1006. package/typedoc/variables/directive_options_options.ngOptionsDirective.html +24 -26
  1007. package/typedoc/variables/directive_transclude_transclude.ngTranscludeDirective.html +8 -22
  1008. package/typedoc/variables/directive_validators_validators.maxlengthDirective.html +14 -28
  1009. package/typedoc/variables/directive_validators_validators.minlengthDirective.html +6 -20
  1010. package/typedoc/variables/directive_validators_validators.patternDirective.html +14 -28
  1011. package/typedoc/variables/directive_validators_validators.requiredDirective.html +14 -28
  1012. package/typedoc/{types/types.AsyncModelValidators.html → variables/injection-tokens._injectTokens.html} +29 -25
  1013. package/typedoc/variables/public.VERSION.html +5 -23
  1014. package/typedoc/variables/router_common_trace.trace.html +4 -18
  1015. package/typedoc/variables/router_directives_view-directive.ngView.html +9 -28
  1016. package/typedoc/variables/router_hooks_resolve.RESOLVE_HOOK_PRIORITY.html +4 -18
  1017. package/typedoc/variables/router_params_param.DefType.html +4 -18
  1018. package/typedoc/variables/router_resolve_resolvable.defaultResolvePolicy.html +4 -18
  1019. package/typedoc/variables/router_resolve_resolve-context.resolvePolicies.html +4 -18
  1020. package/typedoc/variables/router_transition_transition-service.defaultTransOpts.html +4 -18
  1021. package/typedoc/variables/services_log.LogService.html +4 -25
  1022. package/typedoc/variables/shared_common.assertMap.html +4 -18
  1023. package/typedoc/variables/shared_common.assertPredicate.html +4 -18
  1024. package/typedoc/variables/shared_common.pushTo.html +4 -18
  1025. package/typedoc/variables/shared_common.removeFrom.html +4 -18
  1026. package/typedoc/variables/shared_constants.ALIASED_ATTR.html +4 -18
  1027. package/typedoc/variables/shared_constants.DIRTY_CLASS.html +4 -18
  1028. package/typedoc/variables/shared_constants.EMPTY_CLASS.html +4 -18
  1029. package/typedoc/variables/shared_constants.INVALID_CLASS.html +4 -18
  1030. package/typedoc/variables/shared_constants.NOT_EMPTY_CLASS.html +4 -18
  1031. package/typedoc/variables/shared_constants.PREFIX_REGEXP.html +4 -18
  1032. package/typedoc/variables/shared_constants.PRISTINE_CLASS.html +4 -18
  1033. package/typedoc/variables/shared_constants.SPECIAL_CHARS_REGEXP.html +4 -18
  1034. package/typedoc/variables/shared_constants.TOUCHED_CLASS.html +4 -18
  1035. package/typedoc/variables/shared_constants.UNTOUCHED_CLASS.html +4 -18
  1036. package/typedoc/variables/shared_constants.VALID_CLASS.html +4 -18
  1037. package/typedoc/variables/shared_dom.BOOLEAN_ATTR.html +4 -18
  1038. package/typedoc/variables/shared_hof.propEq.html +4 -18
  1039. package/typedoc/variables/shared_strings.hostRegex.html +4 -18
  1040. package/typedoc/variables/shared_strings.splitEqual.html +4 -18
  1041. package/typedoc/variables/shared_strings.splitHash.html +4 -18
  1042. package/typedoc/variables/shared_strings.splitQuery.html +4 -18
  1043. package/typedoc/variables/shared_utils.isProxySymbol.html +4 -18
  1044. package/typedoc/variables/shared_utils.ngAttrPrefixes.html +4 -18
  1045. package/typedoc.json +3 -1
  1046. package/@types/directive/change/change.d.ts +0 -4
  1047. package/@types/types.d.ts +0 -595
  1048. package/SECURITY.md +0 -16
  1049. package/TODO.md +0 -13
  1050. package/docs/content/en/about/featured-background.jpg +0 -0
  1051. package/docs/content/en/about/index.md +0 -37
  1052. package/docs/content/en/blog/_index.md +0 -8
  1053. package/docs/content/en/blog/news/_index.md +0 -4
  1054. package/docs/content/en/blog/news/first-post/featured-sunset-get.png +0 -0
  1055. package/docs/content/en/blog/news/first-post/index.md +0 -46
  1056. package/docs/content/en/blog/news/second-post.md +0 -238
  1057. package/docs/content/en/blog/releases/_index.md +0 -4
  1058. package/docs/content/en/blog/releases/in-depth-monoliths-detailed-spec.md +0 -238
  1059. package/docs/content/en/community/_index.md +0 -6
  1060. package/docs/content/en/docs/concepts/_index.md +0 -14
  1061. package/docs/content/en/docs/contribution-guidelines/_index.md +0 -77
  1062. package/docs/content/en/docs/examples/_index.md +0 -13
  1063. package/docs/content/en/docs/getting-started/_index.md +0 -35
  1064. package/docs/content/en/docs/getting-started/example-page.md +0 -231
  1065. package/docs/content/en/docs/overview/_index.md +0 -34
  1066. package/docs/content/en/docs/reference/_index.md +0 -12
  1067. package/docs/content/en/docs/reference/parameter-reference.md +0 -207
  1068. package/docs/content/en/docs/tasks/Ponycopters/_index.md +0 -12
  1069. package/docs/content/en/docs/tasks/Ponycopters/configuring-ponycopters.md +0 -230
  1070. package/docs/content/en/docs/tasks/Ponycopters/launching-ponycopters.md +0 -230
  1071. package/docs/content/en/docs/tasks/_index.md +0 -21
  1072. package/docs/content/en/docs/tasks/beds.md +0 -230
  1073. package/docs/content/en/docs/tasks/porridge.md +0 -230
  1074. package/docs/content/en/docs/tasks/task.md +0 -230
  1075. package/docs/content/en/docs/tutorials/_index.md +0 -12
  1076. package/docs/content/en/docs/tutorials/multi-bear.md +0 -230
  1077. package/docs/content/en/docs/tutorials/tutorial2.md +0 -230
  1078. package/docs/content/en/featured-background.jpg +0 -0
  1079. package/docs/content/en/search.md +0 -4
  1080. package/docs/layouts/_default/_markup/render-heading.html +0 -1
  1081. package/public/public/legacy.html +0 -13203
  1082. package/src/types.js +0 -427
  1083. package/typedoc/interfaces/types.FormController.html +0 -1541
  1084. package/typedoc/interfaces/types.Module.html +0 -1566
  1085. package/typedoc/interfaces/types.NgModelController.html +0 -2088
  1086. package/typedoc/types/core_parse_parse.ParseService.html +0 -266
  1087. package/typedoc/types/types.BootstrapConfig.html +0 -262
  1088. package/typedoc/types/types.ComponentOptions.html +0 -262
  1089. package/typedoc/types/types.ControllerConstructor.html +0 -262
  1090. package/typedoc/types/types.FilterFunction.html +0 -262
  1091. package/typedoc/types/types.ModelValidators.html +0 -266
  1092. package/typedoc/types/types.ServiceProviderFactory.html +0 -262
  1093. package/typedoc/types/types.TranscludeFunction.html +0 -262
  1094. package/typedoc/types/types.transcludeWithoutScope.html +0 -262
  1095. package/typedoc/variables/core_di_injector.path.html +0 -266
package/typedoc/interfaces/router_transition_interface.IHookRegistry.html ADDED
@@ -0,0 +1,2969 @@
1
+ <!doctype html>
2
+ <html class="default" lang="en" data-base="../">
3
+ <head>
4
+ <meta charset="utf-8" />
5
+ <meta http-equiv="x-ua-compatible" content="IE=edge" />
6
+ <title>IHookRegistry | AngularTS</title>
7
+ <meta name="description" content="Documentation for AngularTS" />
8
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
9
+ <link rel="stylesheet" href="../assets/style.css" />
10
+ <link rel="stylesheet" href="../assets/highlight.css" />
11
+ <script defer src="../assets/main.js"></script>
12
+ <script async src="../assets/icons.js" id="tsd-icons-script"></script>
13
+ <script async src="../assets/search.js" id="tsd-search-script"></script>
14
+ <script async src="../assets/navigation.js" id="tsd-nav-script"></script>
15
+ <script
16
+ async
17
+ src="../assets/hierarchy.js"
18
+ id="tsd-hierarchy-script"
19
+ ></script>
20
+ </head>
21
+ <body>
22
+ <script>
23
+ document.documentElement.dataset.theme =
24
+ localStorage.getItem("tsd-theme") || "os";
25
+ document.body.style.display = "none";
26
+ setTimeout(
27
+ () =>
28
+ window.app
29
+ ? app.showPage()
30
+ : document.body.style.removeProperty("display"),
31
+ 500,
32
+ );
33
+ </script>
34
+ <header class="tsd-page-toolbar">
35
+ <div class="tsd-toolbar-contents container">
36
+ <a href="../index.html" class="title">AngularTS</a>
37
+ <div id="tsd-toolbar-links"></div>
38
+ <button id="tsd-search-trigger" class="tsd-widget" aria-label="Search">
39
+ <svg
40
+ width="16"
41
+ height="16"
42
+ viewBox="0 0 16 16"
43
+ fill="none"
44
+ aria-hidden="true"
45
+ >
46
+ <use href="../assets/icons.svg#icon-search"></use>
47
+ </svg>
48
+ </button>
49
+ <dialog id="tsd-search" aria-label="Search">
50
+ <input
51
+ role="combobox"
52
+ id="tsd-search-input"
53
+ aria-controls="tsd-search-results"
54
+ aria-autocomplete="list"
55
+ aria-expanded="true"
56
+ autocapitalize="off"
57
+ autocomplete="off"
58
+ placeholder="Search the docs"
59
+ maxlength="100"
60
+ />
61
+ <ul role="listbox" id="tsd-search-results"></ul>
62
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
63
+ <div>Preparing search index...</div>
64
+ </div>
65
+ </dialog>
66
+ <a
67
+ href="#"
68
+ class="tsd-widget menu"
69
+ id="tsd-toolbar-menu-trigger"
70
+ data-toggle="menu"
71
+ aria-label="Menu"
72
+ ><svg
73
+ width="16"
74
+ height="16"
75
+ viewBox="0 0 16 16"
76
+ fill="none"
77
+ aria-hidden="true"
78
+ >
79
+ <use href="../assets/icons.svg#icon-menu"></use></svg
80
+ ></a>
81
+ </div>
82
+ </header>
83
+ <div class="container container-main">
84
+ <div class="col-content">
85
+ <div class="tsd-page-title">
86
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
87
+ <li>
88
+ <a href="../modules/router_transition_interface.html"
89
+ >router/transition/interface</a
90
+ >
91
+ </li>
92
+ <li><a href="" aria-current="page">IHookRegistry</a></li>
93
+ </ul>
94
+ <h1>Interface IHookRegistry</h1>
95
+ </div>
96
+ <section class="tsd-panel tsd-comment">
97
+ <div class="tsd-comment tsd-typography">
98
+ <p>
99
+ This interface specifies the api for registering Transition Hooks.
100
+ Both the [[TransitionService]] and also the [[Transition]] object
101
+ itself implement this interface. Note: the Transition object only
102
+ allows hooks to be registered before the Transition is started.
103
+ </p>
104
+ </div>
105
+ <div class="tsd-comment tsd-typography"></div>
106
+ </section>
107
+ <div class="tsd-signature">
108
+ <span class="tsd-signature-keyword">interface</span>
109
+ <span class="tsd-kind-interface">IHookRegistry</span>
110
+ <span class="tsd-signature-symbol">{</span><br />    <a
111
+ class="tsd-kind-property"
112
+ href="#_registeredhooks"
113
+ >_registeredHooks</a
114
+ ><span class="tsd-signature-symbol">:</span>
115
+ <span class="tsd-signature-symbol">{</span>
116
+ <span class="tsd-signature-symbol">[</span
117
+ ><span class="tsd-kind-index-signature">key</span
118
+ ><span class="tsd-signature-symbol">:</span>
119
+ <span class="tsd-signature-type">string</span
120
+ ><span class="tsd-signature-symbol">]:</span>
121
+ <a
122
+ href="../classes/router_transition_hook-registry.RegisteredHook.html"
123
+ class="tsd-signature-type tsd-kind-class"
124
+ >RegisteredHook</a
125
+ ><span class="tsd-signature-symbol">[]</span>
126
+ <span class="tsd-signature-symbol">}</span
127
+ ><span class="tsd-signature-symbol">;</span><br />    <a
128
+ class="tsd-kind-call-signature"
129
+ href="#gethooks-1"
130
+ >getHooks</a
131
+ ><span class="tsd-signature-symbol">(</span
132
+ ><span class="tsd-kind-parameter">hookName</span
133
+ ><span class="tsd-signature-symbol">:</span>
134
+ <span class="tsd-signature-type">string</span
135
+ ><span class="tsd-signature-symbol">)</span
136
+ ><span class="tsd-signature-symbol">:</span>
137
+ <a
138
+ href="../classes/router_transition_hook-registry.RegisteredHook.html"
139
+ class="tsd-signature-type tsd-kind-class"
140
+ >RegisteredHook</a
141
+ ><span class="tsd-signature-symbol">[]</span
142
+ ><span class="tsd-signature-symbol">;</span><br />    <a
143
+ class="tsd-kind-call-signature"
144
+ href="#onbefore-1"
145
+ >onBefore</a
146
+ ><span class="tsd-signature-symbol">(</span><br />        <span
147
+ class="tsd-kind-parameter"
148
+ >matchCriteria</span
149
+ ><span class="tsd-signature-symbol">:</span>
150
+ <a
151
+ href="router_transition_interface.HookMatchCriteria.html"
152
+ class="tsd-signature-type tsd-kind-interface"
153
+ >HookMatchCriteria</a
154
+ ><span class="tsd-signature-symbol">,</span><br />        <span
155
+ class="tsd-kind-parameter"
156
+ >callback</span
157
+ ><span class="tsd-signature-symbol">:</span>
158
+ <a
159
+ href="router_transition_interface.TransitionHookFn.html"
160
+ class="tsd-signature-type tsd-kind-interface"
161
+ >TransitionHookFn</a
162
+ ><span class="tsd-signature-symbol">,</span><br />        <span
163
+ class="tsd-kind-parameter"
164
+ >options</span
165
+ ><span class="tsd-signature-symbol">?:</span>
166
+ <a
167
+ href="router_transition_interface.HookRegOptions.html"
168
+ class="tsd-signature-type tsd-kind-interface"
169
+ >HookRegOptions</a
170
+ ><span class="tsd-signature-symbol">,</span><br />    <span
171
+ class="tsd-signature-symbol"
172
+ >)</span
173
+ ><span class="tsd-signature-symbol">:</span>
174
+ <span class="tsd-signature-type">Function</span
175
+ ><span class="tsd-signature-symbol">;</span><br />    <a
176
+ class="tsd-kind-call-signature"
177
+ href="#onenter-1"
178
+ >onEnter</a
179
+ ><span class="tsd-signature-symbol">(</span><br />        <span
180
+ class="tsd-kind-parameter"
181
+ >matchCriteria</span
182
+ ><span class="tsd-signature-symbol">:</span>
183
+ <a
184
+ href="router_transition_interface.HookMatchCriteria.html"
185
+ class="tsd-signature-type tsd-kind-interface"
186
+ >HookMatchCriteria</a
187
+ ><span class="tsd-signature-symbol">,</span><br />        <span
188
+ class="tsd-kind-parameter"
189
+ >callback</span
190
+ ><span class="tsd-signature-symbol">:</span>
191
+ <a
192
+ href="router_transition_interface.TransitionStateHookFn.html"
193
+ class="tsd-signature-type tsd-kind-interface"
194
+ >TransitionStateHookFn</a
195
+ ><span class="tsd-signature-symbol">,</span><br />        <span
196
+ class="tsd-kind-parameter"
197
+ >options</span
198
+ ><span class="tsd-signature-symbol">?:</span>
199
+ <a
200
+ href="router_transition_interface.HookRegOptions.html"
201
+ class="tsd-signature-type tsd-kind-interface"
202
+ >HookRegOptions</a
203
+ ><span class="tsd-signature-symbol">,</span><br />    <span
204
+ class="tsd-signature-symbol"
205
+ >)</span
206
+ ><span class="tsd-signature-symbol">:</span>
207
+ <span class="tsd-signature-type">Function</span
208
+ ><span class="tsd-signature-symbol">;</span><br />    <a
209
+ class="tsd-kind-call-signature"
210
+ href="#onerror-1"
211
+ >onError</a
212
+ ><span class="tsd-signature-symbol">(</span><br />        <span
213
+ class="tsd-kind-parameter"
214
+ >matchCriteria</span
215
+ ><span class="tsd-signature-symbol">:</span>
216
+ <a
217
+ href="router_transition_interface.HookMatchCriteria.html"
218
+ class="tsd-signature-type tsd-kind-interface"
219
+ >HookMatchCriteria</a
220
+ ><span class="tsd-signature-symbol">,</span><br />        <span
221
+ class="tsd-kind-parameter"
222
+ >callback</span
223
+ ><span class="tsd-signature-symbol">:</span>
224
+ <a
225
+ href="router_transition_interface.TransitionHookFn.html"
226
+ class="tsd-signature-type tsd-kind-interface"
227
+ >TransitionHookFn</a
228
+ ><span class="tsd-signature-symbol">,</span><br />        <span
229
+ class="tsd-kind-parameter"
230
+ >options</span
231
+ ><span class="tsd-signature-symbol">?:</span>
232
+ <a
233
+ href="router_transition_interface.HookRegOptions.html"
234
+ class="tsd-signature-type tsd-kind-interface"
235
+ >HookRegOptions</a
236
+ ><span class="tsd-signature-symbol">,</span><br />    <span
237
+ class="tsd-signature-symbol"
238
+ >)</span
239
+ ><span class="tsd-signature-symbol">:</span>
240
+ <span class="tsd-signature-type">Function</span
241
+ ><span class="tsd-signature-symbol">;</span><br />    <a
242
+ class="tsd-kind-call-signature"
243
+ href="#onexit-1"
244
+ >onExit</a
245
+ ><span class="tsd-signature-symbol">(</span><br />        <span
246
+ class="tsd-kind-parameter"
247
+ >matchCriteria</span
248
+ ><span class="tsd-signature-symbol">:</span>
249
+ <a
250
+ href="router_transition_interface.HookMatchCriteria.html"
251
+ class="tsd-signature-type tsd-kind-interface"
252
+ >HookMatchCriteria</a
253
+ ><span class="tsd-signature-symbol">,</span><br />        <span
254
+ class="tsd-kind-parameter"
255
+ >callback</span
256
+ ><span class="tsd-signature-symbol">:</span>
257
+ <a
258
+ href="router_transition_interface.TransitionStateHookFn.html"
259
+ class="tsd-signature-type tsd-kind-interface"
260
+ >TransitionStateHookFn</a
261
+ ><span class="tsd-signature-symbol">,</span><br />        <span
262
+ class="tsd-kind-parameter"
263
+ >options</span
264
+ ><span class="tsd-signature-symbol">?:</span>
265
+ <a
266
+ href="router_transition_interface.HookRegOptions.html"
267
+ class="tsd-signature-type tsd-kind-interface"
268
+ >HookRegOptions</a
269
+ ><span class="tsd-signature-symbol">,</span><br />    <span
270
+ class="tsd-signature-symbol"
271
+ >)</span
272
+ ><span class="tsd-signature-symbol">:</span>
273
+ <span class="tsd-signature-type">Function</span
274
+ ><span class="tsd-signature-symbol">;</span><br />    <a
275
+ class="tsd-kind-call-signature"
276
+ href="#onfinish-1"
277
+ >onFinish</a
278
+ ><span class="tsd-signature-symbol">(</span><br />        <span
279
+ class="tsd-kind-parameter"
280
+ >matchCriteria</span
281
+ ><span class="tsd-signature-symbol">:</span>
282
+ <a
283
+ href="router_transition_interface.HookMatchCriteria.html"
284
+ class="tsd-signature-type tsd-kind-interface"
285
+ >HookMatchCriteria</a
286
+ ><span class="tsd-signature-symbol">,</span><br />        <span
287
+ class="tsd-kind-parameter"
288
+ >callback</span
289
+ ><span class="tsd-signature-symbol">:</span>
290
+ <a
291
+ href="router_transition_interface.TransitionHookFn.html"
292
+ class="tsd-signature-type tsd-kind-interface"
293
+ >TransitionHookFn</a
294
+ ><span class="tsd-signature-symbol">,</span><br />        <span
295
+ class="tsd-kind-parameter"
296
+ >options</span
297
+ ><span class="tsd-signature-symbol">?:</span>
298
+ <a
299
+ href="router_transition_interface.HookRegOptions.html"
300
+ class="tsd-signature-type tsd-kind-interface"
301
+ >HookRegOptions</a
302
+ ><span class="tsd-signature-symbol">,</span><br />    <span
303
+ class="tsd-signature-symbol"
304
+ >)</span
305
+ ><span class="tsd-signature-symbol">:</span>
306
+ <span class="tsd-signature-type">Function</span
307
+ ><span class="tsd-signature-symbol">;</span><br />    <a
308
+ class="tsd-kind-call-signature"
309
+ href="#onretain-1"
310
+ >onRetain</a
311
+ ><span class="tsd-signature-symbol">(</span><br />        <span
312
+ class="tsd-kind-parameter"
313
+ >matchCriteria</span
314
+ ><span class="tsd-signature-symbol">:</span>
315
+ <a
316
+ href="router_transition_interface.HookMatchCriteria.html"
317
+ class="tsd-signature-type tsd-kind-interface"
318
+ >HookMatchCriteria</a
319
+ ><span class="tsd-signature-symbol">,</span><br />        <span
320
+ class="tsd-kind-parameter"
321
+ >callback</span
322
+ ><span class="tsd-signature-symbol">:</span>
323
+ <a
324
+ href="router_transition_interface.TransitionStateHookFn.html"
325
+ class="tsd-signature-type tsd-kind-interface"
326
+ >TransitionStateHookFn</a
327
+ ><span class="tsd-signature-symbol">,</span><br />        <span
328
+ class="tsd-kind-parameter"
329
+ >options</span
330
+ ><span class="tsd-signature-symbol">?:</span>
331
+ <a
332
+ href="router_transition_interface.HookRegOptions.html"
333
+ class="tsd-signature-type tsd-kind-interface"
334
+ >HookRegOptions</a
335
+ ><span class="tsd-signature-symbol">,</span><br />    <span
336
+ class="tsd-signature-symbol"
337
+ >)</span
338
+ ><span class="tsd-signature-symbol">:</span>
339
+ <span class="tsd-signature-type">Function</span
340
+ ><span class="tsd-signature-symbol">;</span><br />    <a
341
+ class="tsd-kind-call-signature"
342
+ href="#onstart-1"
343
+ >onStart</a
344
+ ><span class="tsd-signature-symbol">(</span><br />        <span
345
+ class="tsd-kind-parameter"
346
+ >matchCriteria</span
347
+ ><span class="tsd-signature-symbol">:</span>
348
+ <a
349
+ href="router_transition_interface.HookMatchCriteria.html"
350
+ class="tsd-signature-type tsd-kind-interface"
351
+ >HookMatchCriteria</a
352
+ ><span class="tsd-signature-symbol">,</span><br />        <span
353
+ class="tsd-kind-parameter"
354
+ >callback</span
355
+ ><span class="tsd-signature-symbol">:</span>
356
+ <a
357
+ href="router_transition_interface.TransitionHookFn.html"
358
+ class="tsd-signature-type tsd-kind-interface"
359
+ >TransitionHookFn</a
360
+ ><span class="tsd-signature-symbol">,</span><br />        <span
361
+ class="tsd-kind-parameter"
362
+ >options</span
363
+ ><span class="tsd-signature-symbol">?:</span>
364
+ <a
365
+ href="router_transition_interface.HookRegOptions.html"
366
+ class="tsd-signature-type tsd-kind-interface"
367
+ >HookRegOptions</a
368
+ ><span class="tsd-signature-symbol">,</span><br />    <span
369
+ class="tsd-signature-symbol"
370
+ >)</span
371
+ ><span class="tsd-signature-symbol">:</span>
372
+ <span class="tsd-signature-type">Function</span
373
+ ><span class="tsd-signature-symbol">;</span><br />    <a
374
+ class="tsd-kind-call-signature"
375
+ href="#onsuccess-1"
376
+ >onSuccess</a
377
+ ><span class="tsd-signature-symbol">(</span><br />        <span
378
+ class="tsd-kind-parameter"
379
+ >matchCriteria</span
380
+ ><span class="tsd-signature-symbol">:</span>
381
+ <a
382
+ href="router_transition_interface.HookMatchCriteria.html"
383
+ class="tsd-signature-type tsd-kind-interface"
384
+ >HookMatchCriteria</a
385
+ ><span class="tsd-signature-symbol">,</span><br />        <span
386
+ class="tsd-kind-parameter"
387
+ >callback</span
388
+ ><span class="tsd-signature-symbol">:</span>
389
+ <a
390
+ href="router_transition_interface.TransitionHookFn.html"
391
+ class="tsd-signature-type tsd-kind-interface"
392
+ >TransitionHookFn</a
393
+ ><span class="tsd-signature-symbol">,</span><br />        <span
394
+ class="tsd-kind-parameter"
395
+ >options</span
396
+ ><span class="tsd-signature-symbol">?:</span>
397
+ <a
398
+ href="router_transition_interface.HookRegOptions.html"
399
+ class="tsd-signature-type tsd-kind-interface"
400
+ >HookRegOptions</a
401
+ ><span class="tsd-signature-symbol">,</span><br />    <span
402
+ class="tsd-signature-symbol"
403
+ >)</span
404
+ ><span class="tsd-signature-symbol">:</span>
405
+ <span class="tsd-signature-type">Function</span
406
+ ><span class="tsd-signature-symbol">;</span><br /><span
407
+ class="tsd-signature-symbol"
408
+ >}</span
409
+ >
410
+ </div>
411
+ <section class="tsd-panel-group tsd-index-group">
412
+ <section class="tsd-panel tsd-index-panel">
413
+ <details class="tsd-index-content tsd-accordion" open>
414
+ <summary class="tsd-accordion-summary tsd-index-summary">
415
+ <svg
416
+ width="20"
417
+ height="20"
418
+ viewBox="0 0 24 24"
419
+ fill="none"
420
+ aria-hidden="true"
421
+ >
422
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
423
+ </svg>
424
+ <h5 class="tsd-index-heading uppercase">Index</h5>
425
+ </summary>
426
+ <div class="tsd-accordion-details">
427
+ <section class="tsd-index-section">
428
+ <h3 class="tsd-index-heading">Properties</h3>
429
+ <div class="tsd-index-list">
430
+ <a href="#_registeredhooks" class="tsd-index-link"
431
+ ><svg
432
+ class="tsd-kind-icon"
433
+ viewBox="0 0 24 24"
434
+ aria-label="Property"
435
+ >
436
+ <use href="../assets/icons.svg#icon-1024"></use></svg
437
+ ><span>_<wbr />registered<wbr />Hooks</span></a
438
+ >
439
+ </div>
440
+ </section>
441
+ <section class="tsd-index-section">
442
+ <h3 class="tsd-index-heading">Methods</h3>
443
+ <div class="tsd-index-list">
444
+ <a href="#gethooks" class="tsd-index-link"
445
+ ><svg
446
+ class="tsd-kind-icon"
447
+ viewBox="0 0 24 24"
448
+ aria-label="Method"
449
+ >
450
+ <use href="../assets/icons.svg#icon-2048"></use></svg
451
+ ><span>get<wbr />Hooks</span></a
452
+ >
453
+ <a href="#onbefore" class="tsd-index-link"
454
+ ><svg
455
+ class="tsd-kind-icon"
456
+ viewBox="0 0 24 24"
457
+ aria-label="Method"
458
+ >
459
+ <use href="../assets/icons.svg#icon-2048"></use></svg
460
+ ><span>on<wbr />Before</span></a
461
+ >
462
+ <a href="#onenter" class="tsd-index-link"
463
+ ><svg
464
+ class="tsd-kind-icon"
465
+ viewBox="0 0 24 24"
466
+ aria-label="Method"
467
+ >
468
+ <use href="../assets/icons.svg#icon-2048"></use></svg
469
+ ><span>on<wbr />Enter</span></a
470
+ >
471
+ <a href="#onerror" class="tsd-index-link"
472
+ ><svg
473
+ class="tsd-kind-icon"
474
+ viewBox="0 0 24 24"
475
+ aria-label="Method"
476
+ >
477
+ <use href="../assets/icons.svg#icon-2048"></use></svg
478
+ ><span>on<wbr />Error</span></a
479
+ >
480
+ <a href="#onexit" class="tsd-index-link"
481
+ ><svg
482
+ class="tsd-kind-icon"
483
+ viewBox="0 0 24 24"
484
+ aria-label="Method"
485
+ >
486
+ <use href="../assets/icons.svg#icon-2048"></use></svg
487
+ ><span>on<wbr />Exit</span></a
488
+ >
489
+ <a href="#onfinish" class="tsd-index-link"
490
+ ><svg
491
+ class="tsd-kind-icon"
492
+ viewBox="0 0 24 24"
493
+ aria-label="Method"
494
+ >
495
+ <use href="../assets/icons.svg#icon-2048"></use></svg
496
+ ><span>on<wbr />Finish</span></a
497
+ >
498
+ <a href="#onretain" class="tsd-index-link"
499
+ ><svg
500
+ class="tsd-kind-icon"
501
+ viewBox="0 0 24 24"
502
+ aria-label="Method"
503
+ >
504
+ <use href="../assets/icons.svg#icon-2048"></use></svg
505
+ ><span>on<wbr />Retain</span></a
506
+ >
507
+ <a href="#onstart" class="tsd-index-link"
508
+ ><svg
509
+ class="tsd-kind-icon"
510
+ viewBox="0 0 24 24"
511
+ aria-label="Method"
512
+ >
513
+ <use href="../assets/icons.svg#icon-2048"></use></svg
514
+ ><span>on<wbr />Start</span></a
515
+ >
516
+ <a href="#onsuccess" class="tsd-index-link"
517
+ ><svg
518
+ class="tsd-kind-icon"
519
+ viewBox="0 0 24 24"
520
+ aria-label="Method"
521
+ >
522
+ <use href="../assets/icons.svg#icon-2048"></use></svg
523
+ ><span>on<wbr />Success</span></a
524
+ >
525
+ </div>
526
+ </section>
527
+ </div>
528
+ </details>
529
+ </section>
530
+ </section>
531
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open>
532
+ <summary class="tsd-accordion-summary" data-key="section-Properties">
533
+ <svg
534
+ width="20"
535
+ height="20"
536
+ viewBox="0 0 24 24"
537
+ fill="none"
538
+ aria-hidden="true"
539
+ >
540
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
541
+ </svg>
542
+ <h2>Properties</h2>
543
+ </summary>
544
+ <section>
545
+ <section class="tsd-panel tsd-member">
546
+ <h3 class="tsd-anchor-link" id="_registeredhooks">
547
+ <code class="tsd-tag">Internal</code
548
+ ><span>_<wbr />registered<wbr />Hooks</span
549
+ ><a
550
+ href="#_registeredhooks"
551
+ aria-label="Permalink"
552
+ class="tsd-anchor-icon"
553
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
554
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
555
+ ></a>
556
+ </h3>
557
+ <div class="tsd-signature">
558
+ <span class="tsd-kind-property">_registeredHooks</span
559
+ ><span class="tsd-signature-symbol">:</span>
560
+ <span class="tsd-signature-symbol">{</span>
561
+ <span class="tsd-signature-symbol">[</span
562
+ ><span class="tsd-kind-index-signature">key</span
563
+ ><span class="tsd-signature-symbol">:</span>
564
+ <span class="tsd-signature-type">string</span
565
+ ><span class="tsd-signature-symbol">]:</span>
566
+ <a
567
+ href="../classes/router_transition_hook-registry.RegisteredHook.html"
568
+ class="tsd-signature-type tsd-kind-class"
569
+ >RegisteredHook</a
570
+ ><span class="tsd-signature-symbol">[]</span>
571
+ <span class="tsd-signature-symbol">}</span>
572
+ </div>
573
+ <div class="tsd-comment tsd-typography">
574
+ <p>place to store the hooks</p>
575
+ </div>
576
+ <div class="tsd-comment tsd-typography"></div>
577
+ </section>
578
+ </section>
579
+ </details>
580
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open>
581
+ <summary class="tsd-accordion-summary" data-key="section-Methods">
582
+ <svg
583
+ width="20"
584
+ height="20"
585
+ viewBox="0 0 24 24"
586
+ fill="none"
587
+ aria-hidden="true"
588
+ >
589
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
590
+ </svg>
591
+ <h2>Methods</h2>
592
+ </summary>
593
+ <section>
594
+ <section class="tsd-panel tsd-member">
595
+ <h3 class="tsd-anchor-link" id="gethooks">
596
+ <span>get<wbr />Hooks</span
597
+ ><a
598
+ href="#gethooks"
599
+ aria-label="Permalink"
600
+ class="tsd-anchor-icon"
601
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
602
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
603
+ ></a>
604
+ </h3>
605
+ <ul class="tsd-signatures">
606
+ <li class="">
607
+ <div class="tsd-signature tsd-anchor-link" id="gethooks-1">
608
+ <span class="tsd-kind-call-signature">getHooks</span
609
+ ><span class="tsd-signature-symbol">(</span
610
+ ><span class="tsd-kind-parameter">hookName</span
611
+ ><span class="tsd-signature-symbol">:</span>
612
+ <span class="tsd-signature-type">string</span
613
+ ><span class="tsd-signature-symbol">)</span
614
+ ><span class="tsd-signature-symbol">:</span>
615
+ <a
616
+ href="../classes/router_transition_hook-registry.RegisteredHook.html"
617
+ class="tsd-signature-type tsd-kind-class"
618
+ >RegisteredHook</a
619
+ ><span class="tsd-signature-symbol">[]</span
620
+ ><a
621
+ href="#gethooks-1"
622
+ aria-label="Permalink"
623
+ class="tsd-anchor-icon"
624
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
625
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
626
+ ></a>
627
+ </div>
628
+ <div class="tsd-description">
629
+ <div class="tsd-comment tsd-typography">
630
+ <p>
631
+ Returns all the registered hooks of a given
632
+ <code>hookName</code> type
633
+ </p>
634
+ <h4 id="example" class="tsd-anchor-link">
635
+ Example:<a
636
+ href="#example"
637
+ aria-label="Permalink"
638
+ class="tsd-anchor-icon"
639
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
640
+ <use
641
+ href="../assets/icons.svg#icon-anchor"
642
+ ></use></svg
643
+ ></a>
644
+ </h4>
645
+ <pre><code><span class="hl-10">$transitions</span><span class="hl-1">.</span><span class="hl-0">getHooks</span><span class="hl-1">(</span><span class="hl-2">&quot;onEnter&quot;</span><span class="hl-1">)</span>
646
+ </code><button>Copy</button></pre>
647
+ </div>
648
+ <div class="tsd-parameters">
649
+ <h4 class="tsd-parameters-title">Parameters</h4>
650
+ <ul class="tsd-parameter-list">
651
+ <li>
652
+ <span
653
+ ><span class="tsd-kind-parameter">hookName</span>:
654
+ <span class="tsd-signature-type">string</span></span
655
+ >
656
+ </li>
657
+ </ul>
658
+ </div>
659
+ <h4 class="tsd-returns-title">
660
+ Returns
661
+ <a
662
+ href="../classes/router_transition_hook-registry.RegisteredHook.html"
663
+ class="tsd-signature-type tsd-kind-class"
664
+ >RegisteredHook</a
665
+ ><span class="tsd-signature-symbol">[]</span>
666
+ </h4>
667
+ <div class="tsd-comment tsd-typography"></div>
668
+ </div>
669
+ </li>
670
+ </ul>
671
+ </section>
672
+ <section class="tsd-panel tsd-member">
673
+ <h3 class="tsd-anchor-link" id="onbefore">
674
+ <span>on<wbr />Before</span
675
+ ><a
676
+ href="#onbefore"
677
+ aria-label="Permalink"
678
+ class="tsd-anchor-icon"
679
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
680
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
681
+ ></a>
682
+ </h3>
683
+ <ul class="tsd-signatures">
684
+ <li class="">
685
+ <div class="tsd-signature tsd-anchor-link" id="onbefore-1">
686
+ <span class="tsd-kind-call-signature">onBefore</span
687
+ ><span class="tsd-signature-symbol">(</span><br />    <span
688
+ class="tsd-kind-parameter"
689
+ >matchCriteria</span
690
+ ><span class="tsd-signature-symbol">:</span>
691
+ <a
692
+ href="router_transition_interface.HookMatchCriteria.html"
693
+ class="tsd-signature-type tsd-kind-interface"
694
+ >HookMatchCriteria</a
695
+ ><span class="tsd-signature-symbol">,</span><br />    <span
696
+ class="tsd-kind-parameter"
697
+ >callback</span
698
+ ><span class="tsd-signature-symbol">:</span>
699
+ <a
700
+ href="router_transition_interface.TransitionHookFn.html"
701
+ class="tsd-signature-type tsd-kind-interface"
702
+ >TransitionHookFn</a
703
+ ><span class="tsd-signature-symbol">,</span><br />    <span
704
+ class="tsd-kind-parameter"
705
+ >options</span
706
+ ><span class="tsd-signature-symbol">?:</span>
707
+ <a
708
+ href="router_transition_interface.HookRegOptions.html"
709
+ class="tsd-signature-type tsd-kind-interface"
710
+ >HookRegOptions</a
711
+ ><span class="tsd-signature-symbol">,</span><br /><span
712
+ class="tsd-signature-symbol"
713
+ >)</span
714
+ ><span class="tsd-signature-symbol">:</span>
715
+ <span class="tsd-signature-type">Function</span
716
+ ><a
717
+ href="#onbefore-1"
718
+ aria-label="Permalink"
719
+ class="tsd-anchor-icon"
720
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
721
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
722
+ ></a>
723
+ </div>
724
+ <div class="tsd-description">
725
+ <div class="tsd-comment tsd-typography">
726
+ <p>
727
+ Registers a [[TransitionHookFn]], called
728
+ <em>before a transition starts</em>.
729
+ </p>
730
+ <p>
731
+ Registers a transition lifecycle hook, which is invoked
732
+ before a transition even begins. This hook can be useful
733
+ to implement logic which prevents a transition from even
734
+ starting, such as authentication, redirection
735
+ </p>
736
+ <p>
737
+ See [[TransitionHookFn]] for the signature of the
738
+ function.
739
+ </p>
740
+ <p>
741
+ The [[HookMatchCriteria]] is used to determine which
742
+ Transitions the hook should be invoked for. To match all
743
+ Transitions, use an empty criteria object
744
+ <code>{}</code>.
745
+ </p>
746
+ <h3 id="lifecycle" class="tsd-anchor-link">
747
+ Lifecycle<a
748
+ href="#lifecycle"
749
+ aria-label="Permalink"
750
+ class="tsd-anchor-icon"
751
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
752
+ <use
753
+ href="../assets/icons.svg#icon-anchor"
754
+ ></use></svg
755
+ ></a>
756
+ </h3>
757
+ <p>
758
+ <code>onBefore</code> hooks are invoked
759
+ <em>before a Transition starts</em>. No resolves have
760
+ been fetched yet. Each <code>onBefore</code> hook is
761
+ invoked synchronously, in the same call stack as
762
+ [[StateService.transitionTo]]. The registered
763
+ <code>onBefore</code> hooks are invoked in priority
764
+ order.
765
+ </p>
766
+ <p>
767
+ Note: during the <code>onBefore</code> phase, additional
768
+ hooks can be added to the specific [[Transition]]
769
+ instance. These &quot;on-the-fly&quot; hooks only affect
770
+ the currently running transition..
771
+ </p>
772
+ <h3 id="return-value" class="tsd-anchor-link">
773
+ Return value<a
774
+ href="#return-value"
775
+ aria-label="Permalink"
776
+ class="tsd-anchor-icon"
777
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
778
+ <use
779
+ href="../assets/icons.svg#icon-anchor"
780
+ ></use></svg
781
+ ></a>
782
+ </h3>
783
+ <p>
784
+ The hook's return value can be used to pause, cancel, or
785
+ redirect the current Transition. See [[HookResult]] for
786
+ more information.
787
+ </p>
788
+ <p>
789
+ If any hook modifies the transition
790
+ <em>synchronously</em> (by throwing, returning
791
+ <code>false</code>, or returning a [[TargetState]]), the
792
+ remainder of the hooks are skipped. If a hook returns a
793
+ promise, the remainder of the
794
+ <code>onBefore</code> hooks are still invoked
795
+ synchronously. All promises are resolved, and processed
796
+ asynchronously before the <code>onStart</code> phase of
797
+ the Transition.
798
+ </p>
799
+ <h3 id="examples" class="tsd-anchor-link">
800
+ Examples<a
801
+ href="#examples"
802
+ aria-label="Permalink"
803
+ class="tsd-anchor-icon"
804
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
805
+ <use
806
+ href="../assets/icons.svg#icon-anchor"
807
+ ></use></svg
808
+ ></a>
809
+ </h3>
810
+ <h4 id="default-substate" class="tsd-anchor-link">
811
+ Default Substate<a
812
+ href="#default-substate"
813
+ aria-label="Permalink"
814
+ class="tsd-anchor-icon"
815
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
816
+ <use
817
+ href="../assets/icons.svg#icon-anchor"
818
+ ></use></svg
819
+ ></a>
820
+ </h4>
821
+ <p>
822
+ This example redirects any transition from 'home' to
823
+ 'home.dashboard'. This is commonly referred to as a
824
+ &quot;default substate&quot;.
825
+ </p>
826
+ </div>
827
+ <div class="tsd-parameters">
828
+ <h4 class="tsd-parameters-title">Parameters</h4>
829
+ <ul class="tsd-parameter-list">
830
+ <li>
831
+ <span
832
+ ><span class="tsd-kind-parameter"
833
+ >matchCriteria</span
834
+ >:
835
+ <a
836
+ href="router_transition_interface.HookMatchCriteria.html"
837
+ class="tsd-signature-type tsd-kind-interface"
838
+ >HookMatchCriteria</a
839
+ ></span
840
+ >
841
+ <div class="tsd-comment tsd-typography">
842
+ <p>
843
+ defines which Transitions the Hook should be
844
+ invoked for.
845
+ </p>
846
+ </div>
847
+ <div class="tsd-comment tsd-typography"></div>
848
+ </li>
849
+ <li>
850
+ <span
851
+ ><span class="tsd-kind-parameter">callback</span>:
852
+ <a
853
+ href="router_transition_interface.TransitionHookFn.html"
854
+ class="tsd-signature-type tsd-kind-interface"
855
+ >TransitionHookFn</a
856
+ ></span
857
+ >
858
+ <div class="tsd-comment tsd-typography">
859
+ <p>the hook function which will be invoked.</p>
860
+ </div>
861
+ <div class="tsd-comment tsd-typography"></div>
862
+ </li>
863
+ <li>
864
+ <span
865
+ ><code class="tsd-tag">Optional</code
866
+ ><span class="tsd-kind-parameter">options</span>:
867
+ <a
868
+ href="router_transition_interface.HookRegOptions.html"
869
+ class="tsd-signature-type tsd-kind-interface"
870
+ >HookRegOptions</a
871
+ ></span
872
+ >
873
+ </li>
874
+ </ul>
875
+ </div>
876
+ <h4 class="tsd-returns-title">
877
+ Returns <span class="tsd-signature-type">Function</span>
878
+ </h4>
879
+ <p>a function which deregisters the hook.</p>
880
+ <div class="tsd-comment tsd-typography">
881
+ <div class="tsd-tag-example">
882
+ <h4 class="tsd-anchor-link" id="example-1">
883
+ Example<a
884
+ href="#example-1"
885
+ aria-label="Permalink"
886
+ class="tsd-anchor-icon"
887
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
888
+ <use
889
+ href="../assets/icons.svg#icon-anchor"
890
+ ></use></svg
891
+ ></a>
892
+ </h4>
893
+ <pre><code class="js"><span class="hl-9">// ng2</span><br/><span class="hl-10">transitionService</span><span class="hl-1">.</span><span class="hl-0">onBefore</span><span class="hl-1">({ </span><span class="hl-10">to:</span><span class="hl-1"> </span><span class="hl-2">&#39;home&#39;</span><span class="hl-1"> }, (</span><span class="hl-10">trans</span><span class="hl-1">: </span><span class="hl-14">Transition</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><br/><span class="hl-1"> </span><span class="hl-10">trans</span><span class="hl-1">.</span><span class="hl-10">router</span><span class="hl-1">.</span><span class="hl-10">stateService</span><span class="hl-1">.</span><span class="hl-0">target</span><span class="hl-1">(</span><span class="hl-2">&quot;home.dashboard&quot;</span><span class="hl-1">));</span>
894
+ </code><button type="button">Copy</button></pre>
895
+
896
+ <h4
897
+ id="data-driven-default-substate"
898
+ class="tsd-anchor-link"
899
+ >
900
+ Data Driven Default Substate<a
901
+ href="#data-driven-default-substate"
902
+ aria-label="Permalink"
903
+ class="tsd-anchor-icon"
904
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
905
+ <use
906
+ href="../assets/icons.svg#icon-anchor"
907
+ ></use></svg
908
+ ></a>
909
+ </h4>
910
+ <p>
911
+ This example provides data-driven default substate
912
+ functionality. It matches on a transition to any state
913
+ which has
914
+ <code
915
+ >defaultSubstate: &quot;some.sub.state&quot;</code
916
+ >
917
+ defined. See: [[<a href="http://Transition.to"
918
+ >Transition.to</a
919
+ >]] which returns the &quot;to state&quot; definition.
920
+ </p>
921
+ </div>
922
+ <div class="tsd-tag-example">
923
+ <h4 class="tsd-anchor-link" id="example-2">
924
+ Example<a
925
+ href="#example-2"
926
+ aria-label="Permalink"
927
+ class="tsd-anchor-icon"
928
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
929
+ <use
930
+ href="../assets/icons.svg#icon-anchor"
931
+ ></use></svg
932
+ ></a>
933
+ </h4>
934
+ <pre><code class="js"><span class="hl-9">// ng1</span><br/><span class="hl-9">// state declaration</span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-15">name</span><span class="hl-1">: </span><span class="hl-2">&#39;home&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-15">template</span><span class="hl-1">: </span><span class="hl-2">&#39;&lt;div ui-view/&gt;&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-15">defaultSubstate</span><span class="hl-1">: </span><span class="hl-2">&#39;home.dashboard&#39;</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-11">var</span><span class="hl-1"> </span><span class="hl-10">criteria</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-0">to</span><span class="hl-10">:</span><span class="hl-1"> </span><span class="hl-11">function</span><span class="hl-1">(</span><span class="hl-10">state</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-8">return</span><span class="hl-1"> </span><span class="hl-10">state</span><span class="hl-1">.</span><span class="hl-10">defaultSubstate</span><span class="hl-1"> != </span><span class="hl-11">null</span><span class="hl-1">;</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-10">$transitions</span><span class="hl-1">.</span><span class="hl-0">onBefore</span><span class="hl-1">(</span><span class="hl-10">criteria</span><span class="hl-1">, </span><span class="hl-11">function</span><span class="hl-1">(</span><span class="hl-10">trans</span><span class="hl-1">: </span><span class="hl-14">Transition</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-11">var</span><span class="hl-1"> </span><span class="hl-10">substate</span><span class="hl-1"> = </span><span class="hl-10">trans</span><span class="hl-1">.</span><span class="hl-0">to</span><span class="hl-1">().</span><span class="hl-10">defaultSubstate</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">return</span><span class="hl-1"> </span><span class="hl-10">trans</span><span class="hl-1">.</span><span class="hl-10">router</span><span class="hl-1">.</span><span class="hl-10">stateService</span><span class="hl-1">.</span><span class="hl-0">target</span><span class="hl-1">(</span><span class="hl-10">substate</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
935
+ </code><button type="button">Copy</button></pre>
936
+
937
+ <h4 id="require-authentication" class="tsd-anchor-link">
938
+ Require authentication<a
939
+ href="#require-authentication"
940
+ aria-label="Permalink"
941
+ class="tsd-anchor-icon"
942
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
943
+ <use
944
+ href="../assets/icons.svg#icon-anchor"
945
+ ></use></svg
946
+ ></a>
947
+ </h4>
948
+ <p>
949
+ This example cancels a transition to a state which
950
+ requires authentication, if the user is not currently
951
+ authenticated.
952
+ </p>
953
+ <p>
954
+ This example assumes a state tree where all states
955
+ which require authentication are children of a parent
956
+ <code>'requireauth'</code> state. This example assumes
957
+ <code>MyAuthService</code> synchronously returns a
958
+ boolean from <code>isAuthenticated()</code>.
959
+ </p>
960
+ <h4 id="example-3" class="tsd-anchor-link">
961
+ Example:<a
962
+ href="#example-3"
963
+ aria-label="Permalink"
964
+ class="tsd-anchor-icon"
965
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
966
+ <use
967
+ href="../assets/icons.svg#icon-anchor"
968
+ ></use></svg
969
+ ></a>
970
+ </h4>
971
+ <pre><code class="js"><span class="hl-9">// ng1</span><br/><span class="hl-10">$transitions</span><span class="hl-1">.</span><span class="hl-0">onBefore</span><span class="hl-1">( { </span><span class="hl-10">to:</span><span class="hl-1"> </span><span class="hl-2">&#39;requireauth.**&#39;</span><span class="hl-1"> }, </span><span class="hl-11">function</span><span class="hl-1">(</span><span class="hl-10">trans</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-11">var</span><span class="hl-1"> </span><span class="hl-10">myAuthService</span><span class="hl-1"> = </span><span class="hl-10">trans</span><span class="hl-1">.</span><span class="hl-0">injector</span><span class="hl-1">().</span><span class="hl-0">get</span><span class="hl-1">(</span><span class="hl-2">&#39;MyAuthService&#39;</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-9">// If isAuthenticated returns false, the transition is cancelled.</span><br/><span class="hl-1"> </span><span class="hl-8">return</span><span class="hl-1"> </span><span class="hl-10">myAuthService</span><span class="hl-1">.</span><span class="hl-0">isAuthenticated</span><span class="hl-1">();</span><br/><span class="hl-1">});</span>
972
+ </code><button type="button">Copy</button></pre>
973
+ </div>
974
+ </div>
975
+ </div>
976
+ </li>
977
+ </ul>
978
+ </section>
979
+ <section class="tsd-panel tsd-member">
980
+ <h3 class="tsd-anchor-link" id="onenter">
981
+ <span>on<wbr />Enter</span
982
+ ><a
983
+ href="#onenter"
984
+ aria-label="Permalink"
985
+ class="tsd-anchor-icon"
986
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
987
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
988
+ ></a>
989
+ </h3>
990
+ <ul class="tsd-signatures">
991
+ <li class="">
992
+ <div class="tsd-signature tsd-anchor-link" id="onenter-1">
993
+ <span class="tsd-kind-call-signature">onEnter</span
994
+ ><span class="tsd-signature-symbol">(</span><br />    <span
995
+ class="tsd-kind-parameter"
996
+ >matchCriteria</span
997
+ ><span class="tsd-signature-symbol">:</span>
998
+ <a
999
+ href="router_transition_interface.HookMatchCriteria.html"
1000
+ class="tsd-signature-type tsd-kind-interface"
1001
+ >HookMatchCriteria</a
1002
+ ><span class="tsd-signature-symbol">,</span><br />    <span
1003
+ class="tsd-kind-parameter"
1004
+ >callback</span
1005
+ ><span class="tsd-signature-symbol">:</span>
1006
+ <a
1007
+ href="router_transition_interface.TransitionStateHookFn.html"
1008
+ class="tsd-signature-type tsd-kind-interface"
1009
+ >TransitionStateHookFn</a
1010
+ ><span class="tsd-signature-symbol">,</span><br />    <span
1011
+ class="tsd-kind-parameter"
1012
+ >options</span
1013
+ ><span class="tsd-signature-symbol">?:</span>
1014
+ <a
1015
+ href="router_transition_interface.HookRegOptions.html"
1016
+ class="tsd-signature-type tsd-kind-interface"
1017
+ >HookRegOptions</a
1018
+ ><span class="tsd-signature-symbol">,</span><br /><span
1019
+ class="tsd-signature-symbol"
1020
+ >)</span
1021
+ ><span class="tsd-signature-symbol">:</span>
1022
+ <span class="tsd-signature-type">Function</span
1023
+ ><a
1024
+ href="#onenter-1"
1025
+ aria-label="Permalink"
1026
+ class="tsd-anchor-icon"
1027
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1028
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1029
+ ></a>
1030
+ </div>
1031
+ <div class="tsd-description">
1032
+ <div class="tsd-comment tsd-typography">
1033
+ <p>
1034
+ Registers a [[TransitionStateHookFn]], called when a
1035
+ specific state is entered.
1036
+ </p>
1037
+ <p>
1038
+ Registers a lifecycle hook, which is invoked (during a
1039
+ transition) when a specific state is being entered.
1040
+ </p>
1041
+ <p>
1042
+ Since this hook is run only when the specific state is
1043
+ being <em>entered</em>, it can be useful for performing
1044
+ tasks when entering a submodule/feature area such as
1045
+ initializing a stateful service, or for guarding access
1046
+ to a submodule/feature area.
1047
+ </p>
1048
+ <p>
1049
+ See [[TransitionStateHookFn]] for the signature of the
1050
+ function.
1051
+ </p>
1052
+ <p>
1053
+ The [[HookMatchCriteria]] is used to determine which
1054
+ Transitions the hook should be invoked for.
1055
+ <code>onEnter</code> hooks generally specify
1056
+ <code>{ entering: 'somestate' }</code>. To match all
1057
+ Transitions, use an empty criteria object
1058
+ <code>{}</code>.
1059
+ </p>
1060
+ <h3 id="lifecycle-1" class="tsd-anchor-link">
1061
+ Lifecycle<a
1062
+ href="#lifecycle-1"
1063
+ aria-label="Permalink"
1064
+ class="tsd-anchor-icon"
1065
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1066
+ <use
1067
+ href="../assets/icons.svg#icon-anchor"
1068
+ ></use></svg
1069
+ ></a>
1070
+ </h3>
1071
+ <p>
1072
+ <code>onEnter</code> hooks are invoked when the
1073
+ Transition is entering a state. States are entered after
1074
+ the <code>onRetain</code> phase is complete. If more
1075
+ than one state is being entered, the parent state is
1076
+ entered first. The registered <code>onEnter</code> hooks
1077
+ for a state are invoked in priority order.
1078
+ </p>
1079
+ <p>
1080
+ Note: A built-in <code>onEnter</code> hook with high
1081
+ priority is used to fetch lazy resolve data for states
1082
+ being entered.
1083
+ </p>
1084
+ <h3 id="return-value-1" class="tsd-anchor-link">
1085
+ Return value<a
1086
+ href="#return-value-1"
1087
+ aria-label="Permalink"
1088
+ class="tsd-anchor-icon"
1089
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1090
+ <use
1091
+ href="../assets/icons.svg#icon-anchor"
1092
+ ></use></svg
1093
+ ></a>
1094
+ </h3>
1095
+ <p>
1096
+ The hook's return value can be used to pause, cancel, or
1097
+ redirect the current Transition. See [[HookResult]] for
1098
+ more information.
1099
+ </p>
1100
+ <h3
1101
+ id="inside-a-state-declaration"
1102
+ class="tsd-anchor-link"
1103
+ >
1104
+ Inside a state declaration<a
1105
+ href="#inside-a-state-declaration"
1106
+ aria-label="Permalink"
1107
+ class="tsd-anchor-icon"
1108
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1109
+ <use
1110
+ href="../assets/icons.svg#icon-anchor"
1111
+ ></use></svg
1112
+ ></a>
1113
+ </h3>
1114
+ <p>
1115
+ Instead of registering <code>onEnter</code> hooks using
1116
+ the [[TransitionService]], you may define an
1117
+ <code>onEnter</code> hook directly on a state
1118
+ declaration (see: [[StateDeclaration.onEnter]]).
1119
+ </p>
1120
+ <h3 id="examples-1" class="tsd-anchor-link">
1121
+ Examples<a
1122
+ href="#examples-1"
1123
+ aria-label="Permalink"
1124
+ class="tsd-anchor-icon"
1125
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1126
+ <use
1127
+ href="../assets/icons.svg#icon-anchor"
1128
+ ></use></svg
1129
+ ></a>
1130
+ </h3>
1131
+ <h4 id="audit-log" class="tsd-anchor-link">
1132
+ Audit Log<a
1133
+ href="#audit-log"
1134
+ aria-label="Permalink"
1135
+ class="tsd-anchor-icon"
1136
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1137
+ <use
1138
+ href="../assets/icons.svg#icon-anchor"
1139
+ ></use></svg
1140
+ ></a>
1141
+ </h4>
1142
+ <p>
1143
+ This example uses a service to log that a user has
1144
+ entered the admin section of an app. This assumes that
1145
+ there are substates of the &quot;admin&quot; state, such
1146
+ as &quot;admin.users&quot;, &quot;admin.pages&quot;,
1147
+ etc.
1148
+ </p>
1149
+ </div>
1150
+ <div class="tsd-parameters">
1151
+ <h4 class="tsd-parameters-title">Parameters</h4>
1152
+ <ul class="tsd-parameter-list">
1153
+ <li>
1154
+ <span
1155
+ ><span class="tsd-kind-parameter"
1156
+ >matchCriteria</span
1157
+ >:
1158
+ <a
1159
+ href="router_transition_interface.HookMatchCriteria.html"
1160
+ class="tsd-signature-type tsd-kind-interface"
1161
+ >HookMatchCriteria</a
1162
+ ></span
1163
+ >
1164
+ <div class="tsd-comment tsd-typography">
1165
+ <p>
1166
+ defines which Transitions the Hook should be
1167
+ invoked for.
1168
+ </p>
1169
+ </div>
1170
+ <div class="tsd-comment tsd-typography"></div>
1171
+ </li>
1172
+ <li>
1173
+ <span
1174
+ ><span class="tsd-kind-parameter">callback</span>:
1175
+ <a
1176
+ href="router_transition_interface.TransitionStateHookFn.html"
1177
+ class="tsd-signature-type tsd-kind-interface"
1178
+ >TransitionStateHookFn</a
1179
+ ></span
1180
+ >
1181
+ <div class="tsd-comment tsd-typography">
1182
+ <p>
1183
+ the hook function which will be injected and
1184
+ invoked.
1185
+ </p>
1186
+ </div>
1187
+ <div class="tsd-comment tsd-typography"></div>
1188
+ </li>
1189
+ <li>
1190
+ <span
1191
+ ><code class="tsd-tag">Optional</code
1192
+ ><span class="tsd-kind-parameter">options</span>:
1193
+ <a
1194
+ href="router_transition_interface.HookRegOptions.html"
1195
+ class="tsd-signature-type tsd-kind-interface"
1196
+ >HookRegOptions</a
1197
+ ></span
1198
+ >
1199
+ </li>
1200
+ </ul>
1201
+ </div>
1202
+ <h4 class="tsd-returns-title">
1203
+ Returns <span class="tsd-signature-type">Function</span>
1204
+ </h4>
1205
+ <p>a function which deregisters the hook.</p>
1206
+ <div class="tsd-comment tsd-typography">
1207
+ <div class="tsd-tag-example">
1208
+ <h4 class="tsd-anchor-link" id="example-4">
1209
+ Example<a
1210
+ href="#example-4"
1211
+ aria-label="Permalink"
1212
+ class="tsd-anchor-icon"
1213
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1214
+ <use
1215
+ href="../assets/icons.svg#icon-anchor"
1216
+ ></use></svg
1217
+ ></a>
1218
+ </h4>
1219
+ <pre><code><br/><span class="hl-10">$transitions</span><span class="hl-1">.</span><span class="hl-0">onEnter</span><span class="hl-1">({ </span><span class="hl-10">entering:</span><span class="hl-1"> </span><span class="hl-2">&#39;admin&#39;</span><span class="hl-1"> }, </span><span class="hl-11">function</span><span class="hl-1">(</span><span class="hl-10">transition</span><span class="hl-1">, </span><span class="hl-10">state</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-11">var</span><span class="hl-1"> </span><span class="hl-10">AuditService</span><span class="hl-1"> = </span><span class="hl-10">trans</span><span class="hl-1">.</span><span class="hl-0">injector</span><span class="hl-1">().</span><span class="hl-0">get</span><span class="hl-1">(</span><span class="hl-2">&#39;AuditService&#39;</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-10">AuditService</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">&quot;Entered &quot;</span><span class="hl-1"> + </span><span class="hl-10">state</span><span class="hl-1">.</span><span class="hl-10">name</span><span class="hl-1"> + </span><span class="hl-2">&quot; module while transitioning to &quot;</span><span class="hl-1"> + </span><span class="hl-10">transition</span><span class="hl-1">.</span><span class="hl-0">to</span><span class="hl-1">().</span><span class="hl-10">name</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
1220
+ </code><button>Copy</button></pre>
1221
+
1222
+ <h4
1223
+ id="audit-log-inside-a-state-declaration"
1224
+ class="tsd-anchor-link"
1225
+ >
1226
+ Audit Log (inside a state declaration)<a
1227
+ href="#audit-log-inside-a-state-declaration"
1228
+ aria-label="Permalink"
1229
+ class="tsd-anchor-icon"
1230
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1231
+ <use
1232
+ href="../assets/icons.svg#icon-anchor"
1233
+ ></use></svg
1234
+ ></a>
1235
+ </h4>
1236
+ <p>
1237
+ The <code>onEnter</code> inside this state declaration
1238
+ is syntactic sugar for the previous Audit Log example.
1239
+ </p>
1240
+ <pre><code><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-15">name</span><span class="hl-1">: </span><span class="hl-2">&#39;admin&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-15">component</span><span class="hl-1">: </span><span class="hl-2">&#39;admin&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-15">onEnter</span><span class="hl-1">: </span><span class="hl-11">function</span><span class="hl-1">(</span><span class="hl-10">$transition$</span><span class="hl-1">, </span><span class="hl-10">$state$</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-11">var</span><span class="hl-1"> </span><span class="hl-10">AuditService</span><span class="hl-1"> = </span><span class="hl-10">$transition$</span><span class="hl-1">.</span><span class="hl-0">injector</span><span class="hl-1">().</span><span class="hl-0">get</span><span class="hl-1">(</span><span class="hl-2">&#39;AuditService&#39;</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-10">AuditService</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">&quot;Entered &quot;</span><span class="hl-1"> + </span><span class="hl-10">state</span><span class="hl-1">.</span><span class="hl-10">name</span><span class="hl-1"> + </span><span class="hl-2">&quot; module while transitioning to &quot;</span><span class="hl-1"> + </span><span class="hl-10">transition</span><span class="hl-1">.</span><span class="hl-0">to</span><span class="hl-1">().</span><span class="hl-10">name</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
1241
+ </code><button>Copy</button></pre>
1242
+
1243
+ <p>
1244
+ Note: A state declaration's
1245
+ <code>onEnter</code> function is injected for Angular
1246
+ 1 only.
1247
+ </p>
1248
+ </div>
1249
+ </div>
1250
+ </div>
1251
+ </li>
1252
+ </ul>
1253
+ </section>
1254
+ <section class="tsd-panel tsd-member">
1255
+ <h3 class="tsd-anchor-link" id="onerror">
1256
+ <span>on<wbr />Error</span
1257
+ ><a
1258
+ href="#onerror"
1259
+ aria-label="Permalink"
1260
+ class="tsd-anchor-icon"
1261
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1262
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1263
+ ></a>
1264
+ </h3>
1265
+ <ul class="tsd-signatures">
1266
+ <li class="">
1267
+ <div class="tsd-signature tsd-anchor-link" id="onerror-1">
1268
+ <span class="tsd-kind-call-signature">onError</span
1269
+ ><span class="tsd-signature-symbol">(</span><br />    <span
1270
+ class="tsd-kind-parameter"
1271
+ >matchCriteria</span
1272
+ ><span class="tsd-signature-symbol">:</span>
1273
+ <a
1274
+ href="router_transition_interface.HookMatchCriteria.html"
1275
+ class="tsd-signature-type tsd-kind-interface"
1276
+ >HookMatchCriteria</a
1277
+ ><span class="tsd-signature-symbol">,</span><br />    <span
1278
+ class="tsd-kind-parameter"
1279
+ >callback</span
1280
+ ><span class="tsd-signature-symbol">:</span>
1281
+ <a
1282
+ href="router_transition_interface.TransitionHookFn.html"
1283
+ class="tsd-signature-type tsd-kind-interface"
1284
+ >TransitionHookFn</a
1285
+ ><span class="tsd-signature-symbol">,</span><br />    <span
1286
+ class="tsd-kind-parameter"
1287
+ >options</span
1288
+ ><span class="tsd-signature-symbol">?:</span>
1289
+ <a
1290
+ href="router_transition_interface.HookRegOptions.html"
1291
+ class="tsd-signature-type tsd-kind-interface"
1292
+ >HookRegOptions</a
1293
+ ><span class="tsd-signature-symbol">,</span><br /><span
1294
+ class="tsd-signature-symbol"
1295
+ >)</span
1296
+ ><span class="tsd-signature-symbol">:</span>
1297
+ <span class="tsd-signature-type">Function</span
1298
+ ><a
1299
+ href="#onerror-1"
1300
+ aria-label="Permalink"
1301
+ class="tsd-anchor-icon"
1302
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1303
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1304
+ ></a>
1305
+ </div>
1306
+ <div class="tsd-description">
1307
+ <div class="tsd-comment tsd-typography">
1308
+ <p>
1309
+ Registers a [[TransitionHookFn]], called after a
1310
+ transition has errored.
1311
+ </p>
1312
+ <p>
1313
+ Registers a transition lifecycle hook, which is invoked
1314
+ after a transition has been rejected for any reason.
1315
+ </p>
1316
+ <p>
1317
+ See [[TransitionHookFn]] for the signature of the
1318
+ function.
1319
+ </p>
1320
+ <p>
1321
+ The [[HookMatchCriteria]] is used to determine which
1322
+ Transitions the hook should be invoked for. To match all
1323
+ Transitions, use an empty criteria object
1324
+ <code>{}</code>.
1325
+ </p>
1326
+ <h3 id="lifecycle-2" class="tsd-anchor-link">
1327
+ Lifecycle<a
1328
+ href="#lifecycle-2"
1329
+ aria-label="Permalink"
1330
+ class="tsd-anchor-icon"
1331
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1332
+ <use
1333
+ href="../assets/icons.svg#icon-anchor"
1334
+ ></use></svg
1335
+ ></a>
1336
+ </h3>
1337
+ <p>
1338
+ The <code>onError</code> hooks are chained off the
1339
+ Transition's promise (see [[Transition.promise]]). If a
1340
+ Transition fails, its promise is rejected and the
1341
+ <code>onError</code> hooks are invoked. The
1342
+ <code>onError</code> hooks are invoked in priority
1343
+ order.
1344
+ </p>
1345
+ <p>
1346
+ Since these hooks are run after the transition is over,
1347
+ their return value is ignored.
1348
+ </p>
1349
+ <p>
1350
+ A transition &quot;errors&quot; if it was started, but
1351
+ failed to complete (for any reason). A
1352
+ <em>non-exhaustive list</em> of reasons a transition can
1353
+ error:
1354
+ </p>
1355
+ <ul>
1356
+ <li>
1357
+ A transition was cancelled because a new transition
1358
+ started while it was still running (<code
1359
+ >Transition superseded</code
1360
+ >)
1361
+ </li>
1362
+ <li>
1363
+ A transition was cancelled by a Transition Hook
1364
+ returning false
1365
+ </li>
1366
+ <li>
1367
+ A transition was redirected by a Transition Hook
1368
+ returning a [[TargetState]]
1369
+ </li>
1370
+ <li>
1371
+ A Transition Hook or resolve function threw an error
1372
+ </li>
1373
+ <li>A Transition Hook returned a rejected promise</li>
1374
+ <li>A resolve function returned a rejected promise</li>
1375
+ </ul>
1376
+ <p>
1377
+ To check the failure reason, inspect the return value of
1378
+ [[Transition.error]].
1379
+ </p>
1380
+ <p>
1381
+ Note: <code>onError</code> should be used for targeted
1382
+ error handling, or error recovery. For simple catch-all
1383
+ error reporting, use
1384
+ [[StateService.defaultErrorHandler]].
1385
+ </p>
1386
+ <h3 id="return-value-2" class="tsd-anchor-link">
1387
+ Return value<a
1388
+ href="#return-value-2"
1389
+ aria-label="Permalink"
1390
+ class="tsd-anchor-icon"
1391
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1392
+ <use
1393
+ href="../assets/icons.svg#icon-anchor"
1394
+ ></use></svg
1395
+ ></a>
1396
+ </h3>
1397
+ <p>
1398
+ Since the Transition is already completed, the hook's
1399
+ return value is ignored
1400
+ </p>
1401
+ </div>
1402
+ <div class="tsd-parameters">
1403
+ <h4 class="tsd-parameters-title">Parameters</h4>
1404
+ <ul class="tsd-parameter-list">
1405
+ <li>
1406
+ <span
1407
+ ><span class="tsd-kind-parameter"
1408
+ >matchCriteria</span
1409
+ >:
1410
+ <a
1411
+ href="router_transition_interface.HookMatchCriteria.html"
1412
+ class="tsd-signature-type tsd-kind-interface"
1413
+ >HookMatchCriteria</a
1414
+ ></span
1415
+ >
1416
+ <div class="tsd-comment tsd-typography">
1417
+ <p>
1418
+ defines which Transitions the Hook should be
1419
+ invoked for.
1420
+ </p>
1421
+ </div>
1422
+ <div class="tsd-comment tsd-typography"></div>
1423
+ </li>
1424
+ <li>
1425
+ <span
1426
+ ><span class="tsd-kind-parameter">callback</span>:
1427
+ <a
1428
+ href="router_transition_interface.TransitionHookFn.html"
1429
+ class="tsd-signature-type tsd-kind-interface"
1430
+ >TransitionHookFn</a
1431
+ ></span
1432
+ >
1433
+ <div class="tsd-comment tsd-typography">
1434
+ <p>
1435
+ the hook function which will be injected and
1436
+ invoked.
1437
+ </p>
1438
+ </div>
1439
+ <div class="tsd-comment tsd-typography"></div>
1440
+ </li>
1441
+ <li>
1442
+ <span
1443
+ ><code class="tsd-tag">Optional</code
1444
+ ><span class="tsd-kind-parameter">options</span>:
1445
+ <a
1446
+ href="router_transition_interface.HookRegOptions.html"
1447
+ class="tsd-signature-type tsd-kind-interface"
1448
+ >HookRegOptions</a
1449
+ ></span
1450
+ >
1451
+ </li>
1452
+ </ul>
1453
+ </div>
1454
+ <h4 class="tsd-returns-title">
1455
+ Returns <span class="tsd-signature-type">Function</span>
1456
+ </h4>
1457
+ <p>a function which deregisters the hook.</p>
1458
+ <div class="tsd-comment tsd-typography"></div>
1459
+ </div>
1460
+ </li>
1461
+ </ul>
1462
+ </section>
1463
+ <section class="tsd-panel tsd-member">
1464
+ <h3 class="tsd-anchor-link" id="onexit">
1465
+ <span>on<wbr />Exit</span
1466
+ ><a
1467
+ href="#onexit"
1468
+ aria-label="Permalink"
1469
+ class="tsd-anchor-icon"
1470
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1471
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1472
+ ></a>
1473
+ </h3>
1474
+ <ul class="tsd-signatures">
1475
+ <li class="">
1476
+ <div class="tsd-signature tsd-anchor-link" id="onexit-1">
1477
+ <span class="tsd-kind-call-signature">onExit</span
1478
+ ><span class="tsd-signature-symbol">(</span><br />    <span
1479
+ class="tsd-kind-parameter"
1480
+ >matchCriteria</span
1481
+ ><span class="tsd-signature-symbol">:</span>
1482
+ <a
1483
+ href="router_transition_interface.HookMatchCriteria.html"
1484
+ class="tsd-signature-type tsd-kind-interface"
1485
+ >HookMatchCriteria</a
1486
+ ><span class="tsd-signature-symbol">,</span><br />    <span
1487
+ class="tsd-kind-parameter"
1488
+ >callback</span
1489
+ ><span class="tsd-signature-symbol">:</span>
1490
+ <a
1491
+ href="router_transition_interface.TransitionStateHookFn.html"
1492
+ class="tsd-signature-type tsd-kind-interface"
1493
+ >TransitionStateHookFn</a
1494
+ ><span class="tsd-signature-symbol">,</span><br />    <span
1495
+ class="tsd-kind-parameter"
1496
+ >options</span
1497
+ ><span class="tsd-signature-symbol">?:</span>
1498
+ <a
1499
+ href="router_transition_interface.HookRegOptions.html"
1500
+ class="tsd-signature-type tsd-kind-interface"
1501
+ >HookRegOptions</a
1502
+ ><span class="tsd-signature-symbol">,</span><br /><span
1503
+ class="tsd-signature-symbol"
1504
+ >)</span
1505
+ ><span class="tsd-signature-symbol">:</span>
1506
+ <span class="tsd-signature-type">Function</span
1507
+ ><a
1508
+ href="#onexit-1"
1509
+ aria-label="Permalink"
1510
+ class="tsd-anchor-icon"
1511
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1512
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1513
+ ></a>
1514
+ </div>
1515
+ <div class="tsd-description">
1516
+ <div class="tsd-comment tsd-typography">
1517
+ <p>
1518
+ Registers a [[TransitionStateHookFn]], called when a
1519
+ specific state is exited.
1520
+ </p>
1521
+ <p>
1522
+ Registers a lifecycle hook, which is invoked (during a
1523
+ transition) when a specific state is being exited.
1524
+ </p>
1525
+ <p>
1526
+ Since this hook is run only when the specific state is
1527
+ being <em>exited</em>, it can be useful for performing
1528
+ tasks when leaving a submodule/feature area such as
1529
+ cleaning up a stateful service, or for preventing the
1530
+ user from leaving a state or submodule until some
1531
+ criteria is satisfied.
1532
+ </p>
1533
+ <p>
1534
+ See [[TransitionStateHookFn]] for the signature of the
1535
+ function.
1536
+ </p>
1537
+ <p>
1538
+ The [[HookMatchCriteria]] is used to determine which
1539
+ Transitions the hook should be invoked for.
1540
+ <code>onExit</code> hooks generally specify
1541
+ <code>{ exiting: 'somestate' }</code>. To match all
1542
+ Transitions, use an empty criteria object
1543
+ <code>{}</code>.
1544
+ </p>
1545
+ <h3 id="lifecycle-3" class="tsd-anchor-link">
1546
+ Lifecycle<a
1547
+ href="#lifecycle-3"
1548
+ aria-label="Permalink"
1549
+ class="tsd-anchor-icon"
1550
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1551
+ <use
1552
+ href="../assets/icons.svg#icon-anchor"
1553
+ ></use></svg
1554
+ ></a>
1555
+ </h3>
1556
+ <p>
1557
+ <code>onExit</code> hooks are invoked when the
1558
+ Transition is exiting a state. States are exited after
1559
+ any <code>onStart</code> phase is complete. If more than
1560
+ one state is being exited, the child states are exited
1561
+ first. The registered <code>onExit</code> hooks for a
1562
+ state are invoked in priority order.
1563
+ </p>
1564
+ <h3 id="return-value-3" class="tsd-anchor-link">
1565
+ Return value<a
1566
+ href="#return-value-3"
1567
+ aria-label="Permalink"
1568
+ class="tsd-anchor-icon"
1569
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1570
+ <use
1571
+ href="../assets/icons.svg#icon-anchor"
1572
+ ></use></svg
1573
+ ></a>
1574
+ </h3>
1575
+ <p>
1576
+ The hook's return value can be used to pause, cancel, or
1577
+ redirect the current Transition. See [[HookResult]] for
1578
+ more information.
1579
+ </p>
1580
+ <h3
1581
+ id="inside-a-state-declaration-1"
1582
+ class="tsd-anchor-link"
1583
+ >
1584
+ Inside a state declaration<a
1585
+ href="#inside-a-state-declaration-1"
1586
+ aria-label="Permalink"
1587
+ class="tsd-anchor-icon"
1588
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1589
+ <use
1590
+ href="../assets/icons.svg#icon-anchor"
1591
+ ></use></svg
1592
+ ></a>
1593
+ </h3>
1594
+ <p>
1595
+ Instead of registering <code>onExit</code> hooks using
1596
+ the [[TransitionService]], you may define an
1597
+ <code>onExit</code> hook directly on a state declaration
1598
+ (see: [[StateDeclaration.onExit]]).
1599
+ </p>
1600
+ <p>
1601
+ Note: A state declaration's <code>onExit</code> function
1602
+ is injected for Angular 1 only.
1603
+ </p>
1604
+ </div>
1605
+ <div class="tsd-parameters">
1606
+ <h4 class="tsd-parameters-title">Parameters</h4>
1607
+ <ul class="tsd-parameter-list">
1608
+ <li>
1609
+ <span
1610
+ ><span class="tsd-kind-parameter"
1611
+ >matchCriteria</span
1612
+ >:
1613
+ <a
1614
+ href="router_transition_interface.HookMatchCriteria.html"
1615
+ class="tsd-signature-type tsd-kind-interface"
1616
+ >HookMatchCriteria</a
1617
+ ></span
1618
+ >
1619
+ <div class="tsd-comment tsd-typography">
1620
+ <p>
1621
+ defines which Transitions the Hook should be
1622
+ invoked for.
1623
+ </p>
1624
+ </div>
1625
+ <div class="tsd-comment tsd-typography"></div>
1626
+ </li>
1627
+ <li>
1628
+ <span
1629
+ ><span class="tsd-kind-parameter">callback</span>:
1630
+ <a
1631
+ href="router_transition_interface.TransitionStateHookFn.html"
1632
+ class="tsd-signature-type tsd-kind-interface"
1633
+ >TransitionStateHookFn</a
1634
+ ></span
1635
+ >
1636
+ <div class="tsd-comment tsd-typography">
1637
+ <p>
1638
+ the hook function which will be injected and
1639
+ invoked.
1640
+ </p>
1641
+ </div>
1642
+ <div class="tsd-comment tsd-typography"></div>
1643
+ </li>
1644
+ <li>
1645
+ <span
1646
+ ><code class="tsd-tag">Optional</code
1647
+ ><span class="tsd-kind-parameter">options</span>:
1648
+ <a
1649
+ href="router_transition_interface.HookRegOptions.html"
1650
+ class="tsd-signature-type tsd-kind-interface"
1651
+ >HookRegOptions</a
1652
+ ></span
1653
+ >
1654
+ </li>
1655
+ </ul>
1656
+ </div>
1657
+ <h4 class="tsd-returns-title">
1658
+ Returns <span class="tsd-signature-type">Function</span>
1659
+ </h4>
1660
+ <p>a function which deregisters the hook.</p>
1661
+ <div class="tsd-comment tsd-typography"></div>
1662
+ </div>
1663
+ </li>
1664
+ </ul>
1665
+ </section>
1666
+ <section class="tsd-panel tsd-member">
1667
+ <h3 class="tsd-anchor-link" id="onfinish">
1668
+ <span>on<wbr />Finish</span
1669
+ ><a
1670
+ href="#onfinish"
1671
+ aria-label="Permalink"
1672
+ class="tsd-anchor-icon"
1673
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1674
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1675
+ ></a>
1676
+ </h3>
1677
+ <ul class="tsd-signatures">
1678
+ <li class="">
1679
+ <div class="tsd-signature tsd-anchor-link" id="onfinish-1">
1680
+ <span class="tsd-kind-call-signature">onFinish</span
1681
+ ><span class="tsd-signature-symbol">(</span><br />    <span
1682
+ class="tsd-kind-parameter"
1683
+ >matchCriteria</span
1684
+ ><span class="tsd-signature-symbol">:</span>
1685
+ <a
1686
+ href="router_transition_interface.HookMatchCriteria.html"
1687
+ class="tsd-signature-type tsd-kind-interface"
1688
+ >HookMatchCriteria</a
1689
+ ><span class="tsd-signature-symbol">,</span><br />    <span
1690
+ class="tsd-kind-parameter"
1691
+ >callback</span
1692
+ ><span class="tsd-signature-symbol">:</span>
1693
+ <a
1694
+ href="router_transition_interface.TransitionHookFn.html"
1695
+ class="tsd-signature-type tsd-kind-interface"
1696
+ >TransitionHookFn</a
1697
+ ><span class="tsd-signature-symbol">,</span><br />    <span
1698
+ class="tsd-kind-parameter"
1699
+ >options</span
1700
+ ><span class="tsd-signature-symbol">?:</span>
1701
+ <a
1702
+ href="router_transition_interface.HookRegOptions.html"
1703
+ class="tsd-signature-type tsd-kind-interface"
1704
+ >HookRegOptions</a
1705
+ ><span class="tsd-signature-symbol">,</span><br /><span
1706
+ class="tsd-signature-symbol"
1707
+ >)</span
1708
+ ><span class="tsd-signature-symbol">:</span>
1709
+ <span class="tsd-signature-type">Function</span
1710
+ ><a
1711
+ href="#onfinish-1"
1712
+ aria-label="Permalink"
1713
+ class="tsd-anchor-icon"
1714
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1715
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1716
+ ></a>
1717
+ </div>
1718
+ <div class="tsd-description">
1719
+ <div class="tsd-comment tsd-typography">
1720
+ <p>
1721
+ Registers a [[TransitionHookFn]], called
1722
+ <em>just before a transition finishes</em>.
1723
+ </p>
1724
+ <p>
1725
+ Registers a transition lifecycle hook, which is invoked
1726
+ just before a transition finishes. This hook is a last
1727
+ chance to cancel or redirect a transition.
1728
+ </p>
1729
+ <p>
1730
+ See [[TransitionHookFn]] for the signature of the
1731
+ function.
1732
+ </p>
1733
+ <p>
1734
+ The [[HookMatchCriteria]] is used to determine which
1735
+ Transitions the hook should be invoked for. To match all
1736
+ Transitions, use an empty criteria object
1737
+ <code>{}</code>.
1738
+ </p>
1739
+ <h3 id="lifecycle-4" class="tsd-anchor-link">
1740
+ Lifecycle<a
1741
+ href="#lifecycle-4"
1742
+ aria-label="Permalink"
1743
+ class="tsd-anchor-icon"
1744
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1745
+ <use
1746
+ href="../assets/icons.svg#icon-anchor"
1747
+ ></use></svg
1748
+ ></a>
1749
+ </h3>
1750
+ <p>
1751
+ <code>onFinish</code> hooks are invoked after the
1752
+ <code>onEnter</code> phase is complete. These hooks are
1753
+ invoked just before the transition is
1754
+ &quot;committed&quot;. Each hook is invoked in priority
1755
+ order.
1756
+ </p>
1757
+ <h3 id="return-value-4" class="tsd-anchor-link">
1758
+ Return value<a
1759
+ href="#return-value-4"
1760
+ aria-label="Permalink"
1761
+ class="tsd-anchor-icon"
1762
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1763
+ <use
1764
+ href="../assets/icons.svg#icon-anchor"
1765
+ ></use></svg
1766
+ ></a>
1767
+ </h3>
1768
+ <p>
1769
+ The hook's return value can be used to pause, cancel, or
1770
+ redirect the current Transition. See [[HookResult]] for
1771
+ more information.
1772
+ </p>
1773
+ </div>
1774
+ <div class="tsd-parameters">
1775
+ <h4 class="tsd-parameters-title">Parameters</h4>
1776
+ <ul class="tsd-parameter-list">
1777
+ <li>
1778
+ <span
1779
+ ><span class="tsd-kind-parameter"
1780
+ >matchCriteria</span
1781
+ >:
1782
+ <a
1783
+ href="router_transition_interface.HookMatchCriteria.html"
1784
+ class="tsd-signature-type tsd-kind-interface"
1785
+ >HookMatchCriteria</a
1786
+ ></span
1787
+ >
1788
+ <div class="tsd-comment tsd-typography">
1789
+ <p>
1790
+ defines which Transitions the Hook should be
1791
+ invoked for.
1792
+ </p>
1793
+ </div>
1794
+ <div class="tsd-comment tsd-typography"></div>
1795
+ </li>
1796
+ <li>
1797
+ <span
1798
+ ><span class="tsd-kind-parameter">callback</span>:
1799
+ <a
1800
+ href="router_transition_interface.TransitionHookFn.html"
1801
+ class="tsd-signature-type tsd-kind-interface"
1802
+ >TransitionHookFn</a
1803
+ ></span
1804
+ >
1805
+ <div class="tsd-comment tsd-typography">
1806
+ <p>
1807
+ the hook function which will be injected and
1808
+ invoked.
1809
+ </p>
1810
+ </div>
1811
+ <div class="tsd-comment tsd-typography"></div>
1812
+ </li>
1813
+ <li>
1814
+ <span
1815
+ ><code class="tsd-tag">Optional</code
1816
+ ><span class="tsd-kind-parameter">options</span>:
1817
+ <a
1818
+ href="router_transition_interface.HookRegOptions.html"
1819
+ class="tsd-signature-type tsd-kind-interface"
1820
+ >HookRegOptions</a
1821
+ ></span
1822
+ >
1823
+ </li>
1824
+ </ul>
1825
+ </div>
1826
+ <h4 class="tsd-returns-title">
1827
+ Returns <span class="tsd-signature-type">Function</span>
1828
+ </h4>
1829
+ <p>a function which deregisters the hook.</p>
1830
+ <div class="tsd-comment tsd-typography"></div>
1831
+ </div>
1832
+ </li>
1833
+ </ul>
1834
+ </section>
1835
+ <section class="tsd-panel tsd-member">
1836
+ <h3 class="tsd-anchor-link" id="onretain">
1837
+ <span>on<wbr />Retain</span
1838
+ ><a
1839
+ href="#onretain"
1840
+ aria-label="Permalink"
1841
+ class="tsd-anchor-icon"
1842
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1843
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1844
+ ></a>
1845
+ </h3>
1846
+ <ul class="tsd-signatures">
1847
+ <li class="">
1848
+ <div class="tsd-signature tsd-anchor-link" id="onretain-1">
1849
+ <span class="tsd-kind-call-signature">onRetain</span
1850
+ ><span class="tsd-signature-symbol">(</span><br />    <span
1851
+ class="tsd-kind-parameter"
1852
+ >matchCriteria</span
1853
+ ><span class="tsd-signature-symbol">:</span>
1854
+ <a
1855
+ href="router_transition_interface.HookMatchCriteria.html"
1856
+ class="tsd-signature-type tsd-kind-interface"
1857
+ >HookMatchCriteria</a
1858
+ ><span class="tsd-signature-symbol">,</span><br />    <span
1859
+ class="tsd-kind-parameter"
1860
+ >callback</span
1861
+ ><span class="tsd-signature-symbol">:</span>
1862
+ <a
1863
+ href="router_transition_interface.TransitionStateHookFn.html"
1864
+ class="tsd-signature-type tsd-kind-interface"
1865
+ >TransitionStateHookFn</a
1866
+ ><span class="tsd-signature-symbol">,</span><br />    <span
1867
+ class="tsd-kind-parameter"
1868
+ >options</span
1869
+ ><span class="tsd-signature-symbol">?:</span>
1870
+ <a
1871
+ href="router_transition_interface.HookRegOptions.html"
1872
+ class="tsd-signature-type tsd-kind-interface"
1873
+ >HookRegOptions</a
1874
+ ><span class="tsd-signature-symbol">,</span><br /><span
1875
+ class="tsd-signature-symbol"
1876
+ >)</span
1877
+ ><span class="tsd-signature-symbol">:</span>
1878
+ <span class="tsd-signature-type">Function</span
1879
+ ><a
1880
+ href="#onretain-1"
1881
+ aria-label="Permalink"
1882
+ class="tsd-anchor-icon"
1883
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1884
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
1885
+ ></a>
1886
+ </div>
1887
+ <div class="tsd-description">
1888
+ <div class="tsd-comment tsd-typography">
1889
+ <p>
1890
+ Registers a [[TransitionStateHookFn]], called when a
1891
+ specific state is retained/kept.
1892
+ </p>
1893
+ <p>
1894
+ Registers a lifecycle hook, which is invoked (during a
1895
+ transition) for a specific state that was previously
1896
+ active will remain active (is not being entered nor
1897
+ exited).
1898
+ </p>
1899
+ <p>
1900
+ This hook is invoked when a state is
1901
+ &quot;retained&quot; or &quot;kept&quot;. It means the
1902
+ transition is coming <em>from</em> a substate of the
1903
+ retained state <em>to</em> a substate of the retained
1904
+ state. This hook can be used to perform actions when the
1905
+ user moves from one substate to another, such as between
1906
+ steps in a wizard.
1907
+ </p>
1908
+ <p>
1909
+ The [[HookMatchCriteria]] is used to determine which
1910
+ Transitions the hook should be invoked for.
1911
+ <code>onRetain</code> hooks generally specify
1912
+ <code>{ retained: 'somestate' }</code>. To match all
1913
+ Transitions, use an empty criteria object
1914
+ <code>{}</code>.
1915
+ </p>
1916
+ <h3 id="lifecycle-5" class="tsd-anchor-link">
1917
+ Lifecycle<a
1918
+ href="#lifecycle-5"
1919
+ aria-label="Permalink"
1920
+ class="tsd-anchor-icon"
1921
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1922
+ <use
1923
+ href="../assets/icons.svg#icon-anchor"
1924
+ ></use></svg
1925
+ ></a>
1926
+ </h3>
1927
+ <p>
1928
+ <code>onRetain</code> hooks are invoked after any
1929
+ <code>onExit</code> hooks have been fired. If more than
1930
+ one state is retained, the child states'
1931
+ <code>onRetain</code> hooks are invoked first. The
1932
+ registered <code>onRetain</code> hooks for a state are
1933
+ invoked in priority order.
1934
+ </p>
1935
+ <h3 id="return-value-5" class="tsd-anchor-link">
1936
+ Return value<a
1937
+ href="#return-value-5"
1938
+ aria-label="Permalink"
1939
+ class="tsd-anchor-icon"
1940
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1941
+ <use
1942
+ href="../assets/icons.svg#icon-anchor"
1943
+ ></use></svg
1944
+ ></a>
1945
+ </h3>
1946
+ <p>
1947
+ The hook's return value can be used to pause, cancel, or
1948
+ redirect the current Transition. See [[HookResult]] for
1949
+ more information.
1950
+ </p>
1951
+ <h3
1952
+ id="inside-a-state-declaration-2"
1953
+ class="tsd-anchor-link"
1954
+ >
1955
+ Inside a state declaration<a
1956
+ href="#inside-a-state-declaration-2"
1957
+ aria-label="Permalink"
1958
+ class="tsd-anchor-icon"
1959
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
1960
+ <use
1961
+ href="../assets/icons.svg#icon-anchor"
1962
+ ></use></svg
1963
+ ></a>
1964
+ </h3>
1965
+ <p>
1966
+ Instead of registering <code>onRetain</code> hooks using
1967
+ the [[TransitionService]], you may define an
1968
+ <code>onRetain</code> hook directly on a state
1969
+ declaration (see: [[StateDeclaration.onRetain]]).
1970
+ </p>
1971
+ <p>
1972
+ Note: A state declaration's
1973
+ <code>onRetain</code> function is injected for Angular 1
1974
+ only.
1975
+ </p>
1976
+ </div>
1977
+ <div class="tsd-parameters">
1978
+ <h4 class="tsd-parameters-title">Parameters</h4>
1979
+ <ul class="tsd-parameter-list">
1980
+ <li>
1981
+ <span
1982
+ ><span class="tsd-kind-parameter"
1983
+ >matchCriteria</span
1984
+ >:
1985
+ <a
1986
+ href="router_transition_interface.HookMatchCriteria.html"
1987
+ class="tsd-signature-type tsd-kind-interface"
1988
+ >HookMatchCriteria</a
1989
+ ></span
1990
+ >
1991
+ <div class="tsd-comment tsd-typography">
1992
+ <p>
1993
+ defines which Transitions the Hook should be
1994
+ invoked for.
1995
+ </p>
1996
+ </div>
1997
+ <div class="tsd-comment tsd-typography"></div>
1998
+ </li>
1999
+ <li>
2000
+ <span
2001
+ ><span class="tsd-kind-parameter">callback</span>:
2002
+ <a
2003
+ href="router_transition_interface.TransitionStateHookFn.html"
2004
+ class="tsd-signature-type tsd-kind-interface"
2005
+ >TransitionStateHookFn</a
2006
+ ></span
2007
+ >
2008
+ <div class="tsd-comment tsd-typography">
2009
+ <p>
2010
+ the hook function which will be injected and
2011
+ invoked.
2012
+ </p>
2013
+ </div>
2014
+ <div class="tsd-comment tsd-typography"></div>
2015
+ </li>
2016
+ <li>
2017
+ <span
2018
+ ><code class="tsd-tag">Optional</code
2019
+ ><span class="tsd-kind-parameter">options</span>:
2020
+ <a
2021
+ href="router_transition_interface.HookRegOptions.html"
2022
+ class="tsd-signature-type tsd-kind-interface"
2023
+ >HookRegOptions</a
2024
+ ></span
2025
+ >
2026
+ </li>
2027
+ </ul>
2028
+ </div>
2029
+ <h4 class="tsd-returns-title">
2030
+ Returns <span class="tsd-signature-type">Function</span>
2031
+ </h4>
2032
+ <p>a function which deregisters the hook.</p>
2033
+ <div class="tsd-comment tsd-typography"></div>
2034
+ </div>
2035
+ </li>
2036
+ </ul>
2037
+ </section>
2038
+ <section class="tsd-panel tsd-member">
2039
+ <h3 class="tsd-anchor-link" id="onstart">
2040
+ <span>on<wbr />Start</span
2041
+ ><a
2042
+ href="#onstart"
2043
+ aria-label="Permalink"
2044
+ class="tsd-anchor-icon"
2045
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
2046
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
2047
+ ></a>
2048
+ </h3>
2049
+ <ul class="tsd-signatures">
2050
+ <li class="">
2051
+ <div class="tsd-signature tsd-anchor-link" id="onstart-1">
2052
+ <span class="tsd-kind-call-signature">onStart</span
2053
+ ><span class="tsd-signature-symbol">(</span><br />    <span
2054
+ class="tsd-kind-parameter"
2055
+ >matchCriteria</span
2056
+ ><span class="tsd-signature-symbol">:</span>
2057
+ <a
2058
+ href="router_transition_interface.HookMatchCriteria.html"
2059
+ class="tsd-signature-type tsd-kind-interface"
2060
+ >HookMatchCriteria</a
2061
+ ><span class="tsd-signature-symbol">,</span><br />    <span
2062
+ class="tsd-kind-parameter"
2063
+ >callback</span
2064
+ ><span class="tsd-signature-symbol">:</span>
2065
+ <a
2066
+ href="router_transition_interface.TransitionHookFn.html"
2067
+ class="tsd-signature-type tsd-kind-interface"
2068
+ >TransitionHookFn</a
2069
+ ><span class="tsd-signature-symbol">,</span><br />    <span
2070
+ class="tsd-kind-parameter"
2071
+ >options</span
2072
+ ><span class="tsd-signature-symbol">?:</span>
2073
+ <a
2074
+ href="router_transition_interface.HookRegOptions.html"
2075
+ class="tsd-signature-type tsd-kind-interface"
2076
+ >HookRegOptions</a
2077
+ ><span class="tsd-signature-symbol">,</span><br /><span
2078
+ class="tsd-signature-symbol"
2079
+ >)</span
2080
+ ><span class="tsd-signature-symbol">:</span>
2081
+ <span class="tsd-signature-type">Function</span
2082
+ ><a
2083
+ href="#onstart-1"
2084
+ aria-label="Permalink"
2085
+ class="tsd-anchor-icon"
2086
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
2087
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
2088
+ ></a>
2089
+ </div>
2090
+ <div class="tsd-description">
2091
+ <div class="tsd-comment tsd-typography">
2092
+ <p>
2093
+ Registers a [[TransitionHookFn]], called when a
2094
+ transition starts.
2095
+ </p>
2096
+ <p>
2097
+ Registers a transition lifecycle hook, which is invoked
2098
+ as a transition starts running. This hook can be useful
2099
+ to perform some asynchronous action before completing a
2100
+ transition.
2101
+ </p>
2102
+ <p>
2103
+ See [[TransitionHookFn]] for the signature of the
2104
+ function.
2105
+ </p>
2106
+ <p>
2107
+ The [[HookMatchCriteria]] is used to determine which
2108
+ Transitions the hook should be invoked for. To match all
2109
+ Transitions, use an empty criteria object
2110
+ <code>{}</code>.
2111
+ </p>
2112
+ <h3 id="lifecycle-6" class="tsd-anchor-link">
2113
+ Lifecycle<a
2114
+ href="#lifecycle-6"
2115
+ aria-label="Permalink"
2116
+ class="tsd-anchor-icon"
2117
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
2118
+ <use
2119
+ href="../assets/icons.svg#icon-anchor"
2120
+ ></use></svg
2121
+ ></a>
2122
+ </h3>
2123
+ <p>
2124
+ <code>onStart</code> hooks are invoked asynchronously
2125
+ when the Transition starts running. This happens after
2126
+ the <code>onBefore</code> phase is complete. At this
2127
+ point, the Transition has not yet exited nor entered any
2128
+ states. The registered <code>onStart</code> hooks are
2129
+ invoked in priority order.
2130
+ </p>
2131
+ <p>
2132
+ Note: A built-in <code>onStart</code> hook with high
2133
+ priority is used to fetch any eager resolve data.
2134
+ </p>
2135
+ <h3 id="return-value-6" class="tsd-anchor-link">
2136
+ Return value<a
2137
+ href="#return-value-6"
2138
+ aria-label="Permalink"
2139
+ class="tsd-anchor-icon"
2140
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
2141
+ <use
2142
+ href="../assets/icons.svg#icon-anchor"
2143
+ ></use></svg
2144
+ ></a>
2145
+ </h3>
2146
+ <p>
2147
+ The hook's return value can be used to pause, cancel, or
2148
+ redirect the current Transition. See [[HookResult]] for
2149
+ more information.
2150
+ </p>
2151
+ <h3 id="example-5" class="tsd-anchor-link">
2152
+ Example<a
2153
+ href="#example-5"
2154
+ aria-label="Permalink"
2155
+ class="tsd-anchor-icon"
2156
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
2157
+ <use
2158
+ href="../assets/icons.svg#icon-anchor"
2159
+ ></use></svg
2160
+ ></a>
2161
+ </h3>
2162
+ <h4 id="login-during-transition" class="tsd-anchor-link">
2163
+ Login during transition<a
2164
+ href="#login-during-transition"
2165
+ aria-label="Permalink"
2166
+ class="tsd-anchor-icon"
2167
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
2168
+ <use
2169
+ href="../assets/icons.svg#icon-anchor"
2170
+ ></use></svg
2171
+ ></a>
2172
+ </h4>
2173
+ <p>
2174
+ This example intercepts any transition to a state which
2175
+ requires authentication, when the user is not currently
2176
+ authenticated. It allows the user to authenticate
2177
+ asynchronously, then resumes the transition. If the user
2178
+ did not authenticate successfully, it redirects to the
2179
+ &quot;guest&quot; state, which does not require
2180
+ authentication.
2181
+ </p>
2182
+ <p>This example assumes:</p>
2183
+ <ul>
2184
+ <li>
2185
+ a state tree where all states which require
2186
+ authentication are children of a parent
2187
+ <code>'auth'</code> state.
2188
+ </li>
2189
+ <li>
2190
+ <code>MyAuthService.isAuthenticated()</code>
2191
+ synchronously returns a boolean.
2192
+ </li>
2193
+ <li>
2194
+ <code>MyAuthService.authenticate()</code> presents a
2195
+ login dialog, and returns a promise which is resolved
2196
+ or rejected, whether or not the login attempt was
2197
+ successful.
2198
+ </li>
2199
+ </ul>
2200
+ <h4 id="example-6" class="tsd-anchor-link">
2201
+ Example:<a
2202
+ href="#example-6"
2203
+ aria-label="Permalink"
2204
+ class="tsd-anchor-icon"
2205
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
2206
+ <use
2207
+ href="../assets/icons.svg#icon-anchor"
2208
+ ></use></svg
2209
+ ></a>
2210
+ </h4>
2211
+ <pre><code class="js"><span class="hl-9">// ng1</span><br/><span class="hl-10">$transitions</span><span class="hl-1">.</span><span class="hl-0">onStart</span><span class="hl-1">( { </span><span class="hl-10">to:</span><span class="hl-1"> </span><span class="hl-2">&#39;auth.**&#39;</span><span class="hl-1"> }, </span><span class="hl-11">function</span><span class="hl-1">(</span><span class="hl-10">trans</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-11">var</span><span class="hl-1"> </span><span class="hl-10">$state</span><span class="hl-1"> = </span><span class="hl-10">trans</span><span class="hl-1">.</span><span class="hl-10">router</span><span class="hl-1">.</span><span class="hl-10">stateService</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-11">var</span><span class="hl-1"> </span><span class="hl-10">MyAuthService</span><span class="hl-1"> = </span><span class="hl-10">trans</span><span class="hl-1">.</span><span class="hl-0">injector</span><span class="hl-1">().</span><span class="hl-0">get</span><span class="hl-1">(</span><span class="hl-2">&#39;MyAuthService&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-9">// If the user is not authenticated</span><br/><span class="hl-1"> </span><span class="hl-8">if</span><span class="hl-1"> (!</span><span class="hl-10">MyAuthService</span><span class="hl-1">.</span><span class="hl-0">isAuthenticated</span><span class="hl-1">()) {</span><br/><br/><span class="hl-1"> </span><span class="hl-9">// Then return a promise for a successful login.</span><br/><span class="hl-1"> </span><span class="hl-9">// The transition will wait for this promise to settle</span><br/><br/><span class="hl-1"> </span><span class="hl-8">return</span><span class="hl-1"> </span><span class="hl-10">MyAuthService</span><span class="hl-1">.</span><span class="hl-0">authenticate</span><span class="hl-1">().</span><span class="hl-0">catch</span><span class="hl-1">(</span><span class="hl-11">function</span><span class="hl-1">() {</span><br/><br/><span class="hl-1"> </span><span class="hl-9">// If the authenticate() method failed for whatever reason,</span><br/><span class="hl-1"> </span><span class="hl-9">// redirect to a &#39;guest&#39; state which doesn&#39;t require auth.</span><br/><span class="hl-1"> </span><span class="hl-8">return</span><span class="hl-1"> </span><span class="hl-10">$state</span><span class="hl-1">.</span><span class="hl-0">target</span><span class="hl-1">(</span><span class="hl-2">&quot;guest&quot;</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span>
2212
+ </code><button type="button">Copy</button></pre>
2213
+ </div>
2214
+ <div class="tsd-parameters">
2215
+ <h4 class="tsd-parameters-title">Parameters</h4>
2216
+ <ul class="tsd-parameter-list">
2217
+ <li>
2218
+ <span
2219
+ ><span class="tsd-kind-parameter"
2220
+ >matchCriteria</span
2221
+ >:
2222
+ <a
2223
+ href="router_transition_interface.HookMatchCriteria.html"
2224
+ class="tsd-signature-type tsd-kind-interface"
2225
+ >HookMatchCriteria</a
2226
+ ></span
2227
+ >
2228
+ <div class="tsd-comment tsd-typography">
2229
+ <p>
2230
+ defines which Transitions the Hook should be
2231
+ invoked for.
2232
+ </p>
2233
+ </div>
2234
+ <div class="tsd-comment tsd-typography"></div>
2235
+ </li>
2236
+ <li>
2237
+ <span
2238
+ ><span class="tsd-kind-parameter">callback</span>:
2239
+ <a
2240
+ href="router_transition_interface.TransitionHookFn.html"
2241
+ class="tsd-signature-type tsd-kind-interface"
2242
+ >TransitionHookFn</a
2243
+ ></span
2244
+ >
2245
+ <div class="tsd-comment tsd-typography">
2246
+ <p>
2247
+ the hook function which will be injected and
2248
+ invoked.
2249
+ </p>
2250
+ </div>
2251
+ <div class="tsd-comment tsd-typography"></div>
2252
+ </li>
2253
+ <li>
2254
+ <span
2255
+ ><code class="tsd-tag">Optional</code
2256
+ ><span class="tsd-kind-parameter">options</span>:
2257
+ <a
2258
+ href="router_transition_interface.HookRegOptions.html"
2259
+ class="tsd-signature-type tsd-kind-interface"
2260
+ >HookRegOptions</a
2261
+ ></span
2262
+ >
2263
+ </li>
2264
+ </ul>
2265
+ </div>
2266
+ <h4 class="tsd-returns-title">
2267
+ Returns <span class="tsd-signature-type">Function</span>
2268
+ </h4>
2269
+ <p>a function which deregisters the hook.</p>
2270
+ <div class="tsd-comment tsd-typography"></div>
2271
+ </div>
2272
+ </li>
2273
+ </ul>
2274
+ </section>
2275
+ <section class="tsd-panel tsd-member">
2276
+ <h3 class="tsd-anchor-link" id="onsuccess">
2277
+ <span>on<wbr />Success</span
2278
+ ><a
2279
+ href="#onsuccess"
2280
+ aria-label="Permalink"
2281
+ class="tsd-anchor-icon"
2282
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
2283
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
2284
+ ></a>
2285
+ </h3>
2286
+ <ul class="tsd-signatures">
2287
+ <li class="">
2288
+ <div class="tsd-signature tsd-anchor-link" id="onsuccess-1">
2289
+ <span class="tsd-kind-call-signature">onSuccess</span
2290
+ ><span class="tsd-signature-symbol">(</span><br />    <span
2291
+ class="tsd-kind-parameter"
2292
+ >matchCriteria</span
2293
+ ><span class="tsd-signature-symbol">:</span>
2294
+ <a
2295
+ href="router_transition_interface.HookMatchCriteria.html"
2296
+ class="tsd-signature-type tsd-kind-interface"
2297
+ >HookMatchCriteria</a
2298
+ ><span class="tsd-signature-symbol">,</span><br />    <span
2299
+ class="tsd-kind-parameter"
2300
+ >callback</span
2301
+ ><span class="tsd-signature-symbol">:</span>
2302
+ <a
2303
+ href="router_transition_interface.TransitionHookFn.html"
2304
+ class="tsd-signature-type tsd-kind-interface"
2305
+ >TransitionHookFn</a
2306
+ ><span class="tsd-signature-symbol">,</span><br />    <span
2307
+ class="tsd-kind-parameter"
2308
+ >options</span
2309
+ ><span class="tsd-signature-symbol">?:</span>
2310
+ <a
2311
+ href="router_transition_interface.HookRegOptions.html"
2312
+ class="tsd-signature-type tsd-kind-interface"
2313
+ >HookRegOptions</a
2314
+ ><span class="tsd-signature-symbol">,</span><br /><span
2315
+ class="tsd-signature-symbol"
2316
+ >)</span
2317
+ ><span class="tsd-signature-symbol">:</span>
2318
+ <span class="tsd-signature-type">Function</span
2319
+ ><a
2320
+ href="#onsuccess-1"
2321
+ aria-label="Permalink"
2322
+ class="tsd-anchor-icon"
2323
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
2324
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
2325
+ ></a>
2326
+ </div>
2327
+ <div class="tsd-description">
2328
+ <div class="tsd-comment tsd-typography">
2329
+ <p>
2330
+ Registers a [[TransitionHookFn]], called after a
2331
+ successful transition completed.
2332
+ </p>
2333
+ <p>
2334
+ Registers a transition lifecycle hook, which is invoked
2335
+ after a transition successfully completes.
2336
+ </p>
2337
+ <p>
2338
+ See [[TransitionHookFn]] for the signature of the
2339
+ function.
2340
+ </p>
2341
+ <p>
2342
+ The [[HookMatchCriteria]] is used to determine which
2343
+ Transitions the hook should be invoked for. To match all
2344
+ Transitions, use an empty criteria object
2345
+ <code>{}</code>.
2346
+ </p>
2347
+ <h3 id="lifecycle-7" class="tsd-anchor-link">
2348
+ Lifecycle<a
2349
+ href="#lifecycle-7"
2350
+ aria-label="Permalink"
2351
+ class="tsd-anchor-icon"
2352
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
2353
+ <use
2354
+ href="../assets/icons.svg#icon-anchor"
2355
+ ></use></svg
2356
+ ></a>
2357
+ </h3>
2358
+ <p>
2359
+ <code>onSuccess</code> hooks are chained off the
2360
+ Transition's promise (see [[Transition.promise]]). If
2361
+ the Transition is successful and its promise is
2362
+ resolved, then the <code>onSuccess</code> hooks are
2363
+ invoked. Since these hooks are run after the transition
2364
+ is over, their return value is ignored. The
2365
+ <code>onSuccess</code> hooks are invoked in priority
2366
+ order.
2367
+ </p>
2368
+ <h3 id="return-value-7" class="tsd-anchor-link">
2369
+ Return value<a
2370
+ href="#return-value-7"
2371
+ aria-label="Permalink"
2372
+ class="tsd-anchor-icon"
2373
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
2374
+ <use
2375
+ href="../assets/icons.svg#icon-anchor"
2376
+ ></use></svg
2377
+ ></a>
2378
+ </h3>
2379
+ <p>
2380
+ Since the Transition is already completed, the hook's
2381
+ return value is ignored
2382
+ </p>
2383
+ </div>
2384
+ <div class="tsd-parameters">
2385
+ <h4 class="tsd-parameters-title">Parameters</h4>
2386
+ <ul class="tsd-parameter-list">
2387
+ <li>
2388
+ <span
2389
+ ><span class="tsd-kind-parameter"
2390
+ >matchCriteria</span
2391
+ >:
2392
+ <a
2393
+ href="router_transition_interface.HookMatchCriteria.html"
2394
+ class="tsd-signature-type tsd-kind-interface"
2395
+ >HookMatchCriteria</a
2396
+ ></span
2397
+ >
2398
+ <div class="tsd-comment tsd-typography">
2399
+ <p>
2400
+ defines which Transitions the Hook should be
2401
+ invoked for.
2402
+ </p>
2403
+ </div>
2404
+ <div class="tsd-comment tsd-typography"></div>
2405
+ </li>
2406
+ <li>
2407
+ <span
2408
+ ><span class="tsd-kind-parameter">callback</span>:
2409
+ <a
2410
+ href="router_transition_interface.TransitionHookFn.html"
2411
+ class="tsd-signature-type tsd-kind-interface"
2412
+ >TransitionHookFn</a
2413
+ ></span
2414
+ >
2415
+ <div class="tsd-comment tsd-typography">
2416
+ <p>
2417
+ the hook function which will be injected and
2418
+ invoked.
2419
+ </p>
2420
+ </div>
2421
+ <div class="tsd-comment tsd-typography"></div>
2422
+ </li>
2423
+ <li>
2424
+ <span
2425
+ ><code class="tsd-tag">Optional</code
2426
+ ><span class="tsd-kind-parameter">options</span>:
2427
+ <a
2428
+ href="router_transition_interface.HookRegOptions.html"
2429
+ class="tsd-signature-type tsd-kind-interface"
2430
+ >HookRegOptions</a
2431
+ ></span
2432
+ >
2433
+ </li>
2434
+ </ul>
2435
+ </div>
2436
+ <h4 class="tsd-returns-title">
2437
+ Returns <span class="tsd-signature-type">Function</span>
2438
+ </h4>
2439
+ <p>a function which deregisters the hook.</p>
2440
+ <div class="tsd-comment tsd-typography"></div>
2441
+ </div>
2442
+ </li>
2443
+ </ul>
2444
+ </section>
2445
+ </section>
2446
+ </details>
2447
+ </div>
2448
+ <div class="col-sidebar">
2449
+ <div class="page-menu">
2450
+ <div class="tsd-navigation settings">
2451
+ <details class="tsd-accordion">
2452
+ <summary class="tsd-accordion-summary">
2453
+ <svg
2454
+ width="20"
2455
+ height="20"
2456
+ viewBox="0 0 24 24"
2457
+ fill="none"
2458
+ aria-hidden="true"
2459
+ >
2460
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
2461
+ </svg>
2462
+ <h3>Settings</h3>
2463
+ </summary>
2464
+ <div class="tsd-accordion-details">
2465
+ <div class="tsd-filter-visibility">
2466
+ <span class="settings-label">Member Visibility</span>
2467
+ <ul id="tsd-filter-options">
2468
+ <li class="tsd-filter-item">
2469
+ <label class="tsd-filter-input"
2470
+ ><input
2471
+ type="checkbox"
2472
+ id="tsd-filter-protected"
2473
+ name="protected"
2474
+ /><svg
2475
+ width="32"
2476
+ height="32"
2477
+ viewBox="0 0 32 32"
2478
+ aria-hidden="true"
2479
+ >
2480
+ <rect
2481
+ class="tsd-checkbox-background"
2482
+ width="30"
2483
+ height="30"
2484
+ x="1"
2485
+ y="1"
2486
+ rx="6"
2487
+ fill="none"
2488
+ ></rect>
2489
+ <path
2490
+ class="tsd-checkbox-checkmark"
2491
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
2492
+ stroke="none"
2493
+ stroke-width="3.5"
2494
+ stroke-linejoin="round"
2495
+ fill="none"
2496
+ ></path></svg
2497
+ ><span>Protected</span></label
2498
+ >
2499
+ </li>
2500
+ <li class="tsd-filter-item">
2501
+ <label class="tsd-filter-input"
2502
+ ><input
2503
+ type="checkbox"
2504
+ id="tsd-filter-inherited"
2505
+ name="inherited"
2506
+ checked
2507
+ /><svg
2508
+ width="32"
2509
+ height="32"
2510
+ viewBox="0 0 32 32"
2511
+ aria-hidden="true"
2512
+ >
2513
+ <rect
2514
+ class="tsd-checkbox-background"
2515
+ width="30"
2516
+ height="30"
2517
+ x="1"
2518
+ y="1"
2519
+ rx="6"
2520
+ fill="none"
2521
+ ></rect>
2522
+ <path
2523
+ class="tsd-checkbox-checkmark"
2524
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
2525
+ stroke="none"
2526
+ stroke-width="3.5"
2527
+ stroke-linejoin="round"
2528
+ fill="none"
2529
+ ></path></svg
2530
+ ><span>Inherited</span></label
2531
+ >
2532
+ </li>
2533
+ <li class="tsd-filter-item">
2534
+ <label class="tsd-filter-input"
2535
+ ><input
2536
+ type="checkbox"
2537
+ id="tsd-filter-external"
2538
+ name="external"
2539
+ /><svg
2540
+ width="32"
2541
+ height="32"
2542
+ viewBox="0 0 32 32"
2543
+ aria-hidden="true"
2544
+ >
2545
+ <rect
2546
+ class="tsd-checkbox-background"
2547
+ width="30"
2548
+ height="30"
2549
+ x="1"
2550
+ y="1"
2551
+ rx="6"
2552
+ fill="none"
2553
+ ></rect>
2554
+ <path
2555
+ class="tsd-checkbox-checkmark"
2556
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
2557
+ stroke="none"
2558
+ stroke-width="3.5"
2559
+ stroke-linejoin="round"
2560
+ fill="none"
2561
+ ></path></svg
2562
+ ><span>External</span></label
2563
+ >
2564
+ </li>
2565
+ </ul>
2566
+ </div>
2567
+ <div class="tsd-theme-toggle">
2568
+ <label class="settings-label" for="tsd-theme">Theme</label
2569
+ ><select id="tsd-theme">
2570
+ <option value="os">OS</option>
2571
+ <option value="light">Light</option>
2572
+ <option value="dark">Dark</option>
2573
+ </select>
2574
+ </div>
2575
+ </div>
2576
+ </details>
2577
+ </div>
2578
+ <details open class="tsd-accordion tsd-page-navigation">
2579
+ <summary class="tsd-accordion-summary">
2580
+ <svg
2581
+ width="20"
2582
+ height="20"
2583
+ viewBox="0 0 24 24"
2584
+ fill="none"
2585
+ aria-hidden="true"
2586
+ >
2587
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
2588
+ </svg>
2589
+ <h3>On This Page</h3>
2590
+ </summary>
2591
+ <div class="tsd-accordion-details">
2592
+ <details open class="tsd-accordion tsd-page-navigation-section">
2593
+ <summary
2594
+ class="tsd-accordion-summary"
2595
+ data-key="section-Properties"
2596
+ >
2597
+ <svg
2598
+ width="20"
2599
+ height="20"
2600
+ viewBox="0 0 24 24"
2601
+ fill="none"
2602
+ aria-hidden="true"
2603
+ >
2604
+ <use href="../assets/icons.svg#icon-chevronDown"></use></svg
2605
+ >Properties
2606
+ </summary>
2607
+ <div>
2608
+ <a href="#_registeredhooks"
2609
+ ><svg
2610
+ class="tsd-kind-icon"
2611
+ viewBox="0 0 24 24"
2612
+ aria-label="Property"
2613
+ >
2614
+ <use href="../assets/icons.svg#icon-1024"></use></svg
2615
+ ><span>_<wbr />registered<wbr />Hooks</span></a
2616
+ >
2617
+ </div>
2618
+ </details>
2619
+ <details open class="tsd-accordion tsd-page-navigation-section">
2620
+ <summary
2621
+ class="tsd-accordion-summary"
2622
+ data-key="section-Methods"
2623
+ >
2624
+ <svg
2625
+ width="20"
2626
+ height="20"
2627
+ viewBox="0 0 24 24"
2628
+ fill="none"
2629
+ aria-hidden="true"
2630
+ >
2631
+ <use href="../assets/icons.svg#icon-chevronDown"></use></svg
2632
+ >Methods
2633
+ </summary>
2634
+ <div>
2635
+ <a href="#gethooks"
2636
+ ><svg
2637
+ class="tsd-kind-icon"
2638
+ viewBox="0 0 24 24"
2639
+ aria-label="Method"
2640
+ >
2641
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2642
+ ><span>get<wbr />Hooks</span></a
2643
+ >
2644
+ <ul>
2645
+ <li>
2646
+ <ul>
2647
+ <li>
2648
+ <ul>
2649
+ <li>
2650
+ <ul>
2651
+ <li>
2652
+ <a href="#example"><span>Example:</span></a>
2653
+ </li>
2654
+ </ul>
2655
+ </li>
2656
+ </ul>
2657
+ </li>
2658
+ </ul>
2659
+ </li>
2660
+ </ul>
2661
+ <a href="#onbefore"
2662
+ ><svg
2663
+ class="tsd-kind-icon"
2664
+ viewBox="0 0 24 24"
2665
+ aria-label="Method"
2666
+ >
2667
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2668
+ ><span>on<wbr />Before</span></a
2669
+ >
2670
+ <ul>
2671
+ <li>
2672
+ <ul>
2673
+ <li>
2674
+ <ul>
2675
+ <li>
2676
+ <a href="#lifecycle"><span>Lifecycle</span></a>
2677
+ </li>
2678
+ <li>
2679
+ <a href="#return-value"
2680
+ ><span>Return value</span></a
2681
+ >
2682
+ </li>
2683
+ <li>
2684
+ <a href="#examples"><span>Examples</span></a>
2685
+ </li>
2686
+ <li>
2687
+ <ul>
2688
+ <li>
2689
+ <a href="#default-substate"
2690
+ ><span>Default <wbr />Substate</span></a
2691
+ >
2692
+ </li>
2693
+ <li>
2694
+ <a href="#data-driven-default-substate"
2695
+ ><span
2696
+ >Data <wbr />Driven <wbr />Default
2697
+ <wbr />Substate</span
2698
+ ></a
2699
+ >
2700
+ </li>
2701
+ <li>
2702
+ <a href="#require-authentication"
2703
+ ><span>Require authentication</span></a
2704
+ >
2705
+ </li>
2706
+ <li>
2707
+ <a href="#example-3"><span>Example:</span></a>
2708
+ </li>
2709
+ </ul>
2710
+ </li>
2711
+ </ul>
2712
+ </li>
2713
+ </ul>
2714
+ </li>
2715
+ </ul>
2716
+ <a href="#onenter"
2717
+ ><svg
2718
+ class="tsd-kind-icon"
2719
+ viewBox="0 0 24 24"
2720
+ aria-label="Method"
2721
+ >
2722
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2723
+ ><span>on<wbr />Enter</span></a
2724
+ >
2725
+ <ul>
2726
+ <li>
2727
+ <ul>
2728
+ <li>
2729
+ <ul>
2730
+ <li>
2731
+ <a href="#lifecycle-1"><span>Lifecycle</span></a>
2732
+ </li>
2733
+ <li>
2734
+ <a href="#return-value-1"
2735
+ ><span>Return value</span></a
2736
+ >
2737
+ </li>
2738
+ <li>
2739
+ <a href="#inside-a-state-declaration"
2740
+ ><span>Inside a state declaration</span></a
2741
+ >
2742
+ </li>
2743
+ <li>
2744
+ <a href="#examples-1"><span>Examples</span></a>
2745
+ </li>
2746
+ <li>
2747
+ <ul>
2748
+ <li>
2749
+ <a href="#audit-log"
2750
+ ><span>Audit <wbr />Log</span></a
2751
+ >
2752
+ </li>
2753
+ <li>
2754
+ <a
2755
+ href="#audit-log-inside-a-state-declaration"
2756
+ ><span
2757
+ >Audit <wbr />Log (inside a state
2758
+ declaration)</span
2759
+ ></a
2760
+ >
2761
+ </li>
2762
+ </ul>
2763
+ </li>
2764
+ </ul>
2765
+ </li>
2766
+ </ul>
2767
+ </li>
2768
+ </ul>
2769
+ <a href="#onerror"
2770
+ ><svg
2771
+ class="tsd-kind-icon"
2772
+ viewBox="0 0 24 24"
2773
+ aria-label="Method"
2774
+ >
2775
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2776
+ ><span>on<wbr />Error</span></a
2777
+ >
2778
+ <ul>
2779
+ <li>
2780
+ <ul>
2781
+ <li>
2782
+ <ul>
2783
+ <li>
2784
+ <a href="#lifecycle-2"><span>Lifecycle</span></a>
2785
+ </li>
2786
+ <li>
2787
+ <a href="#return-value-2"
2788
+ ><span>Return value</span></a
2789
+ >
2790
+ </li>
2791
+ </ul>
2792
+ </li>
2793
+ </ul>
2794
+ </li>
2795
+ </ul>
2796
+ <a href="#onexit"
2797
+ ><svg
2798
+ class="tsd-kind-icon"
2799
+ viewBox="0 0 24 24"
2800
+ aria-label="Method"
2801
+ >
2802
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2803
+ ><span>on<wbr />Exit</span></a
2804
+ >
2805
+ <ul>
2806
+ <li>
2807
+ <ul>
2808
+ <li>
2809
+ <ul>
2810
+ <li>
2811
+ <a href="#lifecycle-3"><span>Lifecycle</span></a>
2812
+ </li>
2813
+ <li>
2814
+ <a href="#return-value-3"
2815
+ ><span>Return value</span></a
2816
+ >
2817
+ </li>
2818
+ <li>
2819
+ <a href="#inside-a-state-declaration-1"
2820
+ ><span>Inside a state declaration</span></a
2821
+ >
2822
+ </li>
2823
+ </ul>
2824
+ </li>
2825
+ </ul>
2826
+ </li>
2827
+ </ul>
2828
+ <a href="#onfinish"
2829
+ ><svg
2830
+ class="tsd-kind-icon"
2831
+ viewBox="0 0 24 24"
2832
+ aria-label="Method"
2833
+ >
2834
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2835
+ ><span>on<wbr />Finish</span></a
2836
+ >
2837
+ <ul>
2838
+ <li>
2839
+ <ul>
2840
+ <li>
2841
+ <ul>
2842
+ <li>
2843
+ <a href="#lifecycle-4"><span>Lifecycle</span></a>
2844
+ </li>
2845
+ <li>
2846
+ <a href="#return-value-4"
2847
+ ><span>Return value</span></a
2848
+ >
2849
+ </li>
2850
+ </ul>
2851
+ </li>
2852
+ </ul>
2853
+ </li>
2854
+ </ul>
2855
+ <a href="#onretain"
2856
+ ><svg
2857
+ class="tsd-kind-icon"
2858
+ viewBox="0 0 24 24"
2859
+ aria-label="Method"
2860
+ >
2861
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2862
+ ><span>on<wbr />Retain</span></a
2863
+ >
2864
+ <ul>
2865
+ <li>
2866
+ <ul>
2867
+ <li>
2868
+ <ul>
2869
+ <li>
2870
+ <a href="#lifecycle-5"><span>Lifecycle</span></a>
2871
+ </li>
2872
+ <li>
2873
+ <a href="#return-value-5"
2874
+ ><span>Return value</span></a
2875
+ >
2876
+ </li>
2877
+ <li>
2878
+ <a href="#inside-a-state-declaration-2"
2879
+ ><span>Inside a state declaration</span></a
2880
+ >
2881
+ </li>
2882
+ </ul>
2883
+ </li>
2884
+ </ul>
2885
+ </li>
2886
+ </ul>
2887
+ <a href="#onstart"
2888
+ ><svg
2889
+ class="tsd-kind-icon"
2890
+ viewBox="0 0 24 24"
2891
+ aria-label="Method"
2892
+ >
2893
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2894
+ ><span>on<wbr />Start</span></a
2895
+ >
2896
+ <ul>
2897
+ <li>
2898
+ <ul>
2899
+ <li>
2900
+ <ul>
2901
+ <li>
2902
+ <a href="#lifecycle-6"><span>Lifecycle</span></a>
2903
+ </li>
2904
+ <li>
2905
+ <a href="#return-value-6"
2906
+ ><span>Return value</span></a
2907
+ >
2908
+ </li>
2909
+ <li>
2910
+ <a href="#example-5"><span>Example</span></a>
2911
+ </li>
2912
+ <li>
2913
+ <ul>
2914
+ <li>
2915
+ <a href="#login-during-transition"
2916
+ ><span>Login during transition</span></a
2917
+ >
2918
+ </li>
2919
+ <li>
2920
+ <a href="#example-6"><span>Example:</span></a>
2921
+ </li>
2922
+ </ul>
2923
+ </li>
2924
+ </ul>
2925
+ </li>
2926
+ </ul>
2927
+ </li>
2928
+ </ul>
2929
+ <a href="#onsuccess"
2930
+ ><svg
2931
+ class="tsd-kind-icon"
2932
+ viewBox="0 0 24 24"
2933
+ aria-label="Method"
2934
+ >
2935
+ <use href="../assets/icons.svg#icon-2048"></use></svg
2936
+ ><span>on<wbr />Success</span></a
2937
+ >
2938
+ <ul>
2939
+ <li>
2940
+ <a href="#lifecycle-7"><span>Lifecycle</span></a>
2941
+ </li>
2942
+ <li>
2943
+ <a href="#return-value-7"><span>Return value</span></a>
2944
+ </li>
2945
+ </ul>
2946
+ </div>
2947
+ </details>
2948
+ </div>
2949
+ </details>
2950
+ </div>
2951
+ <div class="site-menu">
2952
+ <nav class="tsd-navigation">
2953
+ <a href="../modules.html">AngularTS</a>
2954
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
2955
+ <li>Loading...</li>
2956
+ </ul>
2957
+ </nav>
2958
+ </div>
2959
+ </div>
2960
+ </div>
2961
+ <footer>
2962
+ <p class="tsd-generator">
2963
+ Generated using
2964
+ <a href="https://typedoc.org/" target="_blank">TypeDoc</a>
2965
+ </p>
2966
+ </footer>
2967
+ <div class="overlay"></div>
2968
+ </body>
2969
+ </html>