@angular-wave/angular.ts 0.7.0-beta.0 → 0.7.0-beta.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 (881) hide show
  1. package/.husky/pre-commit +2 -0
  2. package/@types/animations/animate-children-directive.d.ts +4 -2
  3. package/@types/animations/animate-swap.d.ts +2 -2
  4. package/@types/animations/animate.d.ts +1 -1
  5. package/@types/animations/interface.d.ts +17 -0
  6. package/@types/animations/raf-scheduler.d.ts +29 -16
  7. package/@types/core/compile/attributes.d.ts +1 -1
  8. package/@types/core/compile/compile.d.ts +22 -15
  9. package/@types/core/controller/controller.d.ts +1 -1
  10. package/@types/core/di/internal-injector.d.ts +10 -6
  11. package/@types/core/di/ng-module.d.ts +3 -3
  12. package/@types/core/error-handler.d.ts +7 -0
  13. package/@types/core/exception-handler.d.ts +5 -10
  14. package/@types/core/filter/filter.d.ts +20 -4
  15. package/@types/core/interpolate/interpolate.d.ts +3 -3
  16. package/@types/core/location/location.d.ts +1 -1
  17. package/@types/core/parse/interface.d.ts +79 -0
  18. package/@types/core/parse/interpreter.d.ts +19 -8
  19. package/@types/core/parse/parse.d.ts +2 -94
  20. package/@types/core/parse/parser/parser.d.ts +2 -2
  21. package/@types/core/sanitize/interface.d.ts +10 -0
  22. package/@types/core/sanitize/sanitize-uri.d.ts +31 -44
  23. package/@types/core/sce/sce.d.ts +109 -32
  24. package/@types/core/scope/scope.d.ts +3 -3
  25. package/@types/directive/bind/bind.d.ts +6 -6
  26. package/@types/directive/channel/channel.d.ts +2 -2
  27. package/@types/directive/class/class.d.ts +3 -3
  28. package/@types/directive/cloak/cloak.d.ts +2 -2
  29. package/@types/directive/controller/controller.d.ts +2 -2
  30. package/@types/directive/events/events.d.ts +4 -4
  31. package/@types/directive/form/form.d.ts +1 -1
  32. package/@types/directive/if/if.d.ts +2 -2
  33. package/@types/directive/include/include.d.ts +2 -2
  34. package/@types/directive/init/init.d.ts +2 -2
  35. package/@types/directive/input/input.d.ts +4 -4
  36. package/@types/directive/model/model.d.ts +10 -10
  37. package/@types/directive/model-options/model-options.d.ts +1 -1
  38. package/@types/directive/non-bindable/non-bindable.d.ts +2 -2
  39. package/@types/directive/observe/observe.d.ts +2 -2
  40. package/@types/directive/options/options.d.ts +1 -1
  41. package/@types/directive/repeat/repeat.d.ts +2 -2
  42. package/@types/directive/script/script.d.ts +2 -2
  43. package/@types/directive/select/select.d.ts +2 -2
  44. package/@types/directive/setter/setter.d.ts +6 -3
  45. package/@types/directive/show-hide/show-hide.d.ts +4 -4
  46. package/@types/directive/style/style.d.ts +2 -2
  47. package/@types/directive/switch/switch.d.ts +6 -6
  48. package/@types/directive/transclude/transclude.d.ts +3 -1
  49. package/@types/directive/validators/validators.d.ts +14 -14
  50. package/@types/filters/filter.d.ts +2 -7
  51. package/@types/filters/filters.d.ts +2 -2
  52. package/@types/filters/limit-to.d.ts +2 -6
  53. package/@types/filters/order-by.d.ts +4 -3
  54. package/@types/interface.d.ts +302 -0
  55. package/@types/loader.d.ts +15 -18
  56. package/@types/public.d.ts +6 -7
  57. package/@types/router/common/glob.d.ts +25 -8
  58. package/@types/router/common/queue.d.ts +62 -13
  59. package/@types/router/common/trace.d.ts +8 -14
  60. package/@types/router/directives/state-directives.d.ts +11 -10
  61. package/@types/router/directives/view-directive.d.ts +3 -3
  62. package/@types/router/globals.d.ts +25 -7
  63. package/@types/router/params/interface.d.ts +606 -0
  64. package/@types/router/resolve/interface.d.ts +200 -0
  65. package/@types/router/state/interface.d.ts +983 -0
  66. package/@types/router/state/state-object.d.ts +13 -3
  67. package/@types/router/state/state-registry.d.ts +18 -4
  68. package/@types/router/state/state-service.d.ts +18 -10
  69. package/@types/router/state/views.d.ts +14 -8
  70. package/@types/router/state-filters.d.ts +8 -4
  71. package/@types/router/template-factory.d.ts +4 -4
  72. package/@types/router/transition/interface.d.ts +876 -11
  73. package/@types/router/transition/transition-service.d.ts +3 -3
  74. package/@types/router/transition/transition.d.ts +25 -15
  75. package/@types/router/view/interface.d.ts +44 -0
  76. package/@types/router/view/view.d.ts +17 -5
  77. package/@types/shared/interface.d.ts +6 -0
  78. package/@types/shared/utils.d.ts +18 -33
  79. package/CHANGELOG.md +38 -38
  80. package/CODE_OF_CONDUCT.md +1 -1
  81. package/CONTRIBUTING.md +9 -9
  82. package/DEVELOPERS.md +30 -30
  83. package/Makefile +1 -1
  84. package/README.md +20 -20
  85. package/RELEASE.md +3 -3
  86. package/SECURITY.md +1 -1
  87. package/TRIAGING.md +3 -3
  88. package/dist/angular-ts.esm.js +3853 -3514
  89. package/dist/angular-ts.umd.js +3854 -3514
  90. package/dist/angular-ts.umd.min.js +1 -1
  91. package/index.html +2 -11
  92. package/package.json +3 -3
  93. package/src/angular.spec.js +1 -99
  94. package/src/animations/animate-children-directive.js +2 -2
  95. package/src/animations/animate-css.md +1 -1
  96. package/src/animations/animate-queue.js +1 -1
  97. package/src/animations/animate-swap.js +20 -17
  98. package/src/animations/animate.js +1 -1
  99. package/src/animations/animate.md +8 -8
  100. package/src/animations/animation.js +1 -0
  101. package/src/animations/interface.ts +19 -0
  102. package/src/animations/raf-scheduler.js +70 -54
  103. package/src/animations/raf-scheduler.spec.js +6 -0
  104. package/src/core/compile/attributes.js +13 -15
  105. package/src/core/compile/compile.js +2737 -2631
  106. package/src/core/compile/compile.md +13 -13
  107. package/src/core/compile/compile.spec.js +8 -108
  108. package/src/core/controller/controller.js +1 -1
  109. package/src/core/di/injector.js +34 -6
  110. package/src/core/di/injector.md +6 -6
  111. package/src/core/di/internal-injector.js +19 -21
  112. package/src/core/di/ng-module.js +4 -3
  113. package/src/core/error-handler.ts +7 -0
  114. package/src/core/exception-handler.js +4 -9
  115. package/src/core/filter/filter.js +12 -3
  116. package/src/core/filter/filter.md +5 -5
  117. package/src/core/interpolate/interpolate.js +6 -6
  118. package/src/core/interpolate/interpolate.spec.js +1 -1
  119. package/src/core/location/location.js +3 -3
  120. package/src/core/parse/ast/ast.js +2 -2
  121. package/src/core/parse/interface.ts +84 -0
  122. package/src/core/parse/interpreter.js +33 -28
  123. package/src/core/parse/parse.js +8 -55
  124. package/src/core/parse/parse.md +6 -6
  125. package/src/core/parse/parser/parser.js +1 -1
  126. package/src/core/sanitize/interface.ts +10 -0
  127. package/src/core/sanitize/sanitize-uri.js +46 -56
  128. package/src/core/sanitize/sanitize-uri.spec.js +1 -1
  129. package/src/core/sce/sce.js +378 -301
  130. package/src/core/sce/sce.md +13 -13
  131. package/src/core/scope/scope.js +8 -6
  132. package/src/directive/aria/aria.js +9 -11
  133. package/src/directive/attrs/attrs.md +7 -7
  134. package/src/directive/bind/bind.js +5 -5
  135. package/src/directive/bind/bind.md +3 -3
  136. package/src/directive/channel/channel.js +1 -1
  137. package/src/directive/class/class.js +1 -1
  138. package/src/directive/cloak/cloak.js +1 -1
  139. package/src/directive/cloak/cloak.md +1 -1
  140. package/src/directive/controller/controller.js +1 -1
  141. package/src/directive/controller/controller.md +2 -2
  142. package/src/directive/events/events.js +3 -3
  143. package/src/directive/events/events.md +2 -2
  144. package/src/directive/form/form.js +5 -5
  145. package/src/directive/if/if.js +1 -1
  146. package/src/directive/include/include.js +1 -1
  147. package/src/directive/include/include.md +2 -2
  148. package/src/directive/init/init.js +1 -1
  149. package/src/directive/input/input.js +7 -7
  150. package/src/directive/input/input.md +54 -54
  151. package/src/directive/messages/messages.js +2 -2
  152. package/src/directive/messages/messages.md +2 -2
  153. package/src/directive/model/model.js +3 -3
  154. package/src/directive/model-options/model-options.js +3 -3
  155. package/src/directive/model-options/model-options.md +1 -1
  156. package/src/directive/non-bindable/non-bindable.js +1 -1
  157. package/src/directive/non-bindable/non-bindable.md +1 -1
  158. package/src/directive/observe/observe.js +1 -1
  159. package/src/directive/options/options.js +3 -5
  160. package/src/directive/options/options.md +1 -1
  161. package/src/directive/ref/ref.js +9 -4
  162. package/src/directive/repeat/repeat.js +7 -8
  163. package/src/directive/repeat/repeat.md +3 -3
  164. package/src/directive/script/script.js +3 -3
  165. package/src/directive/select/select.js +2 -2
  166. package/src/directive/select/select.md +3 -3
  167. package/src/directive/setter/setter.js +8 -6
  168. package/src/directive/show-hide/show-hide.js +2 -2
  169. package/src/directive/show-hide/show-hide.md +4 -4
  170. package/src/directive/style/style.js +2 -2
  171. package/src/directive/switch/switch.js +6 -6
  172. package/src/directive/transclude/transclude.js +2 -2
  173. package/src/directive/validators/validators.js +37 -36
  174. package/src/filters/filter.js +1 -1
  175. package/src/filters/filters.js +1 -1
  176. package/src/filters/limit-to.js +1 -1
  177. package/src/filters/order-by.js +3 -0
  178. package/src/filters/order-by.md +1 -1
  179. package/src/interface.ts +329 -0
  180. package/src/loader.js +20 -19
  181. package/src/loader.md +7 -7
  182. package/src/public.js +5 -7
  183. package/src/router/common/{glob.html → common.html} +1 -0
  184. package/src/router/common/{glob.test.js → common.test.js} +1 -1
  185. package/src/router/common/glob.js +29 -7
  186. package/src/router/common/glob.spec.js +31 -1
  187. package/src/router/common/queue.js +69 -14
  188. package/src/router/common/queue.spec.js +80 -0
  189. package/src/router/common/trace.js +21 -15
  190. package/src/router/directives/component-example.html +37 -0
  191. package/src/router/directives/state-directives.js +13 -12
  192. package/src/router/directives/state-directives.spec.js +51 -46
  193. package/src/router/directives/view-directive.js +6 -6
  194. package/src/router/directives/view-directive.spec.js +1 -1
  195. package/src/router/globals.js +24 -5
  196. package/src/router/hooks/update-globals.js +2 -0
  197. package/src/router/params/interface.ts +626 -0
  198. package/src/router/params/param-types.js +2 -2
  199. package/src/router/resolve/interface.ts +208 -0
  200. package/src/router/resolve/resolvable.js +2 -2
  201. package/src/router/state/interface.ts +1007 -0
  202. package/src/router/state/state-builder.js +2 -2
  203. package/src/router/state/state-object.js +19 -5
  204. package/src/router/state/state-queue-manager.js +3 -5
  205. package/src/router/state/state-registry.js +14 -3
  206. package/src/router/state/state-service.js +14 -8
  207. package/src/router/state/views.js +9 -4
  208. package/src/router/state-filters.js +6 -0
  209. package/src/router/template-factory.js +2 -2
  210. package/src/router/transition/interface.ts +922 -0
  211. package/src/router/transition/transition-service.js +1 -1
  212. package/src/router/transition/transition.js +17 -7
  213. package/src/router/url/url-matcher.js +2 -2
  214. package/src/router/view/interface.ts +51 -0
  215. package/src/router/view/view.js +17 -10
  216. package/src/router/view/view.spec.js +2 -2
  217. package/src/services/http/http.md +8 -8
  218. package/src/services/log.md +1 -1
  219. package/src/services/template-request.js +1 -1
  220. package/src/shared/dom.js +2 -2
  221. package/src/shared/interface.ts +6 -0
  222. package/src/shared/utils.js +22 -37
  223. package/tsconfig.json +2 -1
  224. package/tsconfig.types.json +1 -0
  225. package/typedoc/assets/hierarchy.js +1 -1
  226. package/typedoc/assets/navigation.js +1 -1
  227. package/typedoc/assets/search.js +1 -1
  228. package/typedoc/classes/animations_animate-cache.AnimateCacheProvider.html +6 -6
  229. package/typedoc/classes/animations_animate-css-driver.AnimateCssDriverProvider.html +10 -10
  230. package/typedoc/classes/animations_animate-css.AnimateCssProvider.html +10 -10
  231. package/typedoc/classes/animations_animate-js-driver.AnimateJsDriverProvider.html +10 -10
  232. package/typedoc/classes/animations_animate-js.AnimateJsProvider.html +10 -10
  233. package/typedoc/classes/animations_animate-queue.AnimateQueueProvider.html +12 -12
  234. package/typedoc/classes/animations_animate-runner.AnimateAsyncRunFactoryProvider.html +6 -6
  235. package/typedoc/classes/animations_animate-runner.AnimateRunner.html +48 -48
  236. package/typedoc/classes/animations_animate-runner.AnimateRunnerFactoryProvider.html +6 -6
  237. package/typedoc/classes/animations_animate.AnimateProvider.html +18 -18
  238. package/typedoc/classes/animations_animation.AnimationProvider.html +12 -12
  239. package/typedoc/classes/animations_raf-scheduler.RafSchedulerProvider.html +323 -52
  240. package/typedoc/classes/core_cache_cache-factory.TemplateCacheProvider.html +4 -4
  241. package/typedoc/classes/core_compile_attributes.Attributes.html +43 -43
  242. package/typedoc/classes/core_compile_compile.CompileProvider.html +51 -43
  243. package/typedoc/classes/core_controller_controller.ControllerProvider.html +13 -13
  244. package/typedoc/classes/core_di_internal-injector.InjectorService.html +34 -32
  245. package/typedoc/classes/core_di_internal-injector.ProviderInjector.html +25 -25
  246. package/typedoc/classes/core_di_ng-module.NgModule.html +50 -50
  247. package/typedoc/classes/core_exception-handler.ExceptionHandlerProvider.html +17 -17
  248. package/typedoc/classes/core_filter_filter.FilterProvider.html +156 -21
  249. package/typedoc/classes/core_interpolate_interpolate.InterpolateProvider.html +22 -22
  250. package/typedoc/classes/core_location_location.Location.html +76 -76
  251. package/typedoc/classes/core_location_location.LocationHashbangUrl.html +78 -78
  252. package/typedoc/classes/core_location_location.LocationHtml5Url.html +78 -78
  253. package/typedoc/classes/core_location_location.LocationProvider.html +20 -20
  254. package/typedoc/classes/core_parse_ast_ast.AST.html +64 -64
  255. package/typedoc/classes/core_parse_interpreter.ASTInterpreter.html +112 -78
  256. package/typedoc/classes/core_parse_lexer_lexer.Lexer.html +42 -42
  257. package/typedoc/classes/core_parse_parse.ParseProvider.html +13 -14
  258. package/typedoc/classes/core_parse_parser_parser.Parser.html +14 -14
  259. package/typedoc/classes/core_pubsub_pubsub.PubSub.html +26 -26
  260. package/typedoc/classes/core_sanitize_sanitize-uri.SanitizeUriProvider.html +205 -319
  261. package/typedoc/classes/core_sce_sce.SceDelegateProvider.html +18 -85
  262. package/typedoc/classes/core_sce_sce.SceProvider.html +8 -8
  263. package/typedoc/classes/core_scope_scope.RootScopeProvider.html +10 -10
  264. package/typedoc/classes/core_scope_scope.Scope.html +110 -193
  265. package/typedoc/classes/core_task-tracker-factory.TaskTracker.html +14 -14
  266. package/typedoc/classes/core_task-tracker-factory.TaskTrackerFactoryProvider.html +4 -4
  267. package/typedoc/classes/directive_aria_aria.AriaProvider.html +8 -8
  268. package/typedoc/classes/directive_form_form.FormController.html +85 -85
  269. package/typedoc/classes/directive_model_model.NgModelController.html +213 -213
  270. package/typedoc/classes/loader.Angular.html +58 -62
  271. package/typedoc/classes/router_common_glob.Glob.html +208 -101
  272. package/typedoc/classes/router_common_queue.Queue.html +279 -68
  273. package/typedoc/classes/router_common_trace.Trace.html +44 -44
  274. package/typedoc/classes/router_globals.RouterGlobals.html +937 -0
  275. package/typedoc/classes/router_params_param-factory.ParamFactory.html +12 -12
  276. package/typedoc/classes/router_params_param-type.ParamType.html +26 -26
  277. package/typedoc/classes/router_params_param-types.ParamTypes.html +16 -16
  278. package/typedoc/classes/router_params_param.Param.html +46 -46
  279. package/typedoc/classes/router_params_state-params.StateParams.html +6 -6
  280. package/typedoc/classes/router_path_path-node.PathNode.html +34 -34
  281. package/typedoc/classes/router_path_path-utils.PathUtils.html +22 -22
  282. package/typedoc/classes/router_resolve_resolvable.Resolvable.html +54 -54
  283. package/typedoc/classes/router_resolve_resolve-context.ResolveContext.html +26 -26
  284. package/typedoc/classes/router_state-provider.StateProvider.html +14 -14
  285. package/typedoc/classes/router_state_state-builder.StateBuilder.html +18 -18
  286. package/typedoc/classes/router_state_state-matcher.StateMatcher.html +12 -12
  287. package/typedoc/classes/router_state_state-object.StateObject.html +202 -45
  288. package/typedoc/classes/router_state_state-queue-manager.StateQueueManager.html +22 -22
  289. package/typedoc/classes/router_state_state-registry.StateRegistryProvider.html +76 -133
  290. package/typedoc/classes/router_state_state-service.StateProvider.html +120 -72
  291. package/typedoc/classes/router_state_target-state.TargetState.html +46 -46
  292. package/typedoc/classes/{router_state_views.Ng1ViewConfig.html → router_state_views.ViewConfig.html} +83 -51
  293. package/typedoc/classes/router_template-factory.TemplateFactoryProvider.html +36 -62
  294. package/typedoc/classes/router_transition_hook-builder.HookBuilder.html +21 -14
  295. package/typedoc/classes/router_transition_hook-registry.RegisteredHook.html +36 -36
  296. package/typedoc/classes/router_transition_reject-factory.Rejection.html +32 -32
  297. package/typedoc/classes/router_transition_transition-event-type.TransitionEventType.html +20 -20
  298. package/typedoc/classes/router_transition_transition-hook.TransitionHook.html +54 -54
  299. package/typedoc/classes/router_transition_transition-service.TransitionProvider.html +48 -48
  300. package/typedoc/classes/router_transition_transition.Transition.html +597 -145
  301. package/typedoc/classes/router_url_url-config.UrlConfigProvider.html +28 -28
  302. package/typedoc/classes/router_url_url-matcher.UrlMatcher.html +50 -50
  303. package/typedoc/classes/router_url_url-rule.BaseUrlRule.html +16 -16
  304. package/typedoc/classes/router_url_url-rule.UrlRuleFactory.html +22 -22
  305. package/typedoc/classes/router_url_url-rules.UrlRules.html +42 -42
  306. package/typedoc/classes/router_url_url-service.UrlService.html +68 -68
  307. package/typedoc/classes/router_view-scroll.ViewScrollProvider.html +12 -12
  308. package/typedoc/classes/router_view_view.ViewService.html +228 -212
  309. package/typedoc/classes/services_anchor-scroll.AnchorScrollProvider.html +12 -12
  310. package/typedoc/classes/services_browser.Browser.html +54 -54
  311. package/typedoc/classes/services_browser.BrowserProvider.html +4 -4
  312. package/typedoc/classes/services_http-backend_http-backend.HttpBackendProvider.html +6 -6
  313. package/typedoc/classes/services_http_http.HttpParamSerializerProvider.html +6 -6
  314. package/typedoc/classes/services_http_http.HttpProvider.html +14 -14
  315. package/typedoc/classes/services_log.LogProvider.html +16 -16
  316. package/typedoc/classes/services_template-request.TemplateRequestProvider.html +12 -12
  317. package/typedoc/classes/shared_noderef.NodeRef.html +60 -60
  318. package/typedoc/enums/core_parse_ast-type.ASTType.html +38 -38
  319. package/typedoc/enums/router_common_trace.Category.html +568 -0
  320. package/typedoc/enums/router_transition_interface.TransitionHookPhase.html +18 -33
  321. package/typedoc/{interfaces/types.ServiceProviderClass.html → enums/router_transition_interface.TransitionHookScope.html} +75 -44
  322. package/typedoc/enums/router_transition_reject-factory.RejectType.html +14 -14
  323. package/typedoc/functions/animations_animate-cache.animateCache.html +14 -14
  324. package/typedoc/functions/animations_animate-children-directive.__AnimateChildrenDirective.html +6 -6
  325. package/typedoc/functions/animations_animate-swap.ngAnimateSwapDirective.html +6 -6
  326. package/typedoc/functions/animations_shared.applyAnimationClassesFactory.html +2 -2
  327. package/typedoc/functions/animations_shared.applyAnimationFromStyles.html +2 -2
  328. package/typedoc/functions/animations_shared.applyAnimationStyles.html +2 -2
  329. package/typedoc/functions/animations_shared.applyAnimationToStyles.html +2 -2
  330. package/typedoc/functions/animations_shared.applyGeneratedPreparationClasses.html +2 -2
  331. package/typedoc/functions/animations_shared.applyInlineStyle.html +2 -2
  332. package/typedoc/functions/animations_shared.assertArg.html +2 -2
  333. package/typedoc/functions/animations_shared.blockKeyframeAnimations.html +2 -2
  334. package/typedoc/functions/animations_shared.clearGeneratedClasses.html +2 -2
  335. package/typedoc/functions/animations_shared.concatWithSpace.html +2 -2
  336. package/typedoc/functions/animations_shared.extractElementNode.html +2 -2
  337. package/typedoc/functions/animations_shared.mergeAnimationDetails.html +2 -2
  338. package/typedoc/functions/animations_shared.mergeClasses.html +2 -2
  339. package/typedoc/functions/animations_shared.packageStyles.html +2 -2
  340. package/typedoc/functions/animations_shared.pendClasses.html +2 -2
  341. package/typedoc/functions/animations_shared.prepareAnimationOptions.html +2 -2
  342. package/typedoc/functions/animations_shared.removeFromArray.html +2 -2
  343. package/typedoc/functions/animations_shared.resolveElementClasses.html +2 -2
  344. package/typedoc/functions/animations_shared.stripCommentsFromElement.html +2 -2
  345. package/typedoc/functions/core_controller_controller.identifierForController.html +2 -2
  346. package/typedoc/functions/core_di_injector.annotate.html +2 -2
  347. package/typedoc/functions/core_di_injector.createInjector.html +2 -2
  348. package/typedoc/functions/core_location_location.serverBase.html +2 -2
  349. package/typedoc/functions/core_location_location.stripBaseUrl.html +2 -2
  350. package/typedoc/functions/core_location_location.stripFile.html +2 -2
  351. package/typedoc/functions/core_location_location.stripHash.html +2 -2
  352. package/typedoc/functions/core_parse_interpreter.isAssignable.html +2 -2
  353. package/typedoc/functions/core_parse_parse.constantWatchDelegate.html +2 -2
  354. package/typedoc/functions/core_sce_sce.adjustMatcher.html +2 -2
  355. package/typedoc/functions/core_sce_sce.escapeForRegexp.html +2 -2
  356. package/typedoc/functions/core_scope_scope.createScope.html +2 -2
  357. package/typedoc/functions/core_scope_scope.nextId.html +2 -2
  358. package/typedoc/functions/core_url-utils_url-utils.getBaseUrl.html +2 -2
  359. package/typedoc/functions/core_url-utils_url-utils.urlIsAllowedOriginFactory.html +2 -2
  360. package/typedoc/functions/core_url-utils_url-utils.urlIsSameOrigin.html +2 -2
  361. package/typedoc/functions/core_url-utils_url-utils.urlIsSameOriginAsBaseUrl.html +2 -2
  362. package/typedoc/functions/core_url-utils_url-utils.urlResolve.html +2 -2
  363. package/typedoc/functions/core_url-utils_url-utils.urlsAreSameOrigin.html +2 -2
  364. package/typedoc/functions/directive_aria_aria.ngCheckedAriaDirective.html +4 -4
  365. package/typedoc/functions/directive_aria_aria.ngClickAriaDirective.html +4 -4
  366. package/typedoc/functions/directive_aria_aria.ngDblclickAriaDirective.html +4 -4
  367. package/typedoc/functions/directive_aria_aria.ngDisabledAriaDirective.html +4 -4
  368. package/typedoc/functions/directive_aria_aria.ngHideAriaDirective.html +4 -4
  369. package/typedoc/functions/directive_aria_aria.ngMessagesAriaDirective.html +2 -2
  370. package/typedoc/functions/directive_aria_aria.ngModelAriaDirective.html +4 -4
  371. package/typedoc/functions/directive_aria_aria.ngReadonlyAriaDirective.html +4 -4
  372. package/typedoc/functions/directive_aria_aria.ngRequiredAriaDirective.html +4 -4
  373. package/typedoc/functions/directive_aria_aria.ngShowAriaDirective.html +4 -4
  374. package/typedoc/functions/directive_aria_aria.ngValueAriaDirective.html +4 -4
  375. package/typedoc/functions/directive_bind_bind.ngBindDirective.html +4 -4
  376. package/typedoc/functions/directive_bind_bind.ngBindHtmlDirective.html +6 -6
  377. package/typedoc/functions/directive_bind_bind.ngBindTemplateDirective.html +4 -4
  378. package/typedoc/functions/directive_channel_channel.ngChannelDirective.html +4 -4
  379. package/typedoc/functions/directive_cloak_cloak.ngCloakDirective.html +4 -4
  380. package/typedoc/functions/directive_controller_controller.ngControllerDirective.html +4 -4
  381. package/typedoc/functions/directive_events_events.createEventDirective.html +8 -8
  382. package/typedoc/functions/directive_form_form.setupValidity.html +2 -2
  383. package/typedoc/functions/directive_if_if.ngIfDirective.html +6 -6
  384. package/typedoc/functions/directive_include_include.ngIncludeDirective.html +4 -4
  385. package/typedoc/functions/directive_include_include.ngIncludeFillContentDirective.html +6 -6
  386. package/typedoc/functions/directive_init_init.ngInitDirective.html +4 -4
  387. package/typedoc/functions/directive_input_input.badInputChecker.html +2 -2
  388. package/typedoc/functions/directive_input_input.countDecimals.html +2 -2
  389. package/typedoc/functions/directive_input_input.createDateInputType.html +2 -2
  390. package/typedoc/functions/directive_input_input.createDateParser.html +2 -2
  391. package/typedoc/functions/directive_input_input.hiddenInputBrowserCacheDirective.html +4 -4
  392. package/typedoc/functions/directive_input_input.inputDirective.html +4 -4
  393. package/typedoc/functions/directive_input_input.isNumberInteger.html +2 -2
  394. package/typedoc/functions/directive_input_input.isValidForStep.html +2 -2
  395. package/typedoc/functions/directive_input_input.ngValueDirective.html +4 -4
  396. package/typedoc/functions/directive_input_input.numberFormatterParser.html +2 -2
  397. package/typedoc/functions/directive_input_input.numberInputType.html +2 -2
  398. package/typedoc/functions/directive_input_input.rangeInputType.html +2 -2
  399. package/typedoc/functions/directive_input_input.weekParser.html +2 -2
  400. package/typedoc/functions/directive_messages_messages.ngMessagesDirective.html +4 -4
  401. package/typedoc/functions/directive_messages_messages.ngMessagesIncludeDirective.html +4 -4
  402. package/typedoc/functions/directive_model-options_model-options.ngModelOptionsDirective.html +4 -4
  403. package/typedoc/functions/directive_model_model.ngModelDirective.html +2 -2
  404. package/typedoc/functions/directive_non-bindable_non-bindable.ngNonBindableDirective.html +4 -4
  405. package/typedoc/functions/directive_observe_observe.ngObserveDirective.html +4 -4
  406. package/typedoc/functions/directive_ref_ref.ngRefDirective.html +4 -4
  407. package/typedoc/functions/directive_repeat_repeat.ngRepeatDirective.html +6 -6
  408. package/typedoc/functions/directive_script_script.scriptDirective.html +6 -6
  409. package/typedoc/functions/directive_select_select.optionDirective.html +4 -4
  410. package/typedoc/functions/directive_select_select.selectDirective.html +4 -4
  411. package/typedoc/functions/directive_setter_setter.ngSetterDirective.html +34 -8
  412. package/typedoc/functions/directive_show-hide_show-hide.ngHideDirective.html +6 -6
  413. package/typedoc/functions/directive_show-hide_show-hide.ngShowDirective.html +6 -6
  414. package/typedoc/functions/directive_style_style.ngStyleDirective.html +4 -4
  415. package/typedoc/functions/directive_switch_switch.ngSwitchDefaultDirective.html +4 -4
  416. package/typedoc/functions/directive_switch_switch.ngSwitchDirective.html +6 -6
  417. package/typedoc/functions/directive_switch_switch.ngSwitchWhenDirective.html +4 -4
  418. package/typedoc/functions/filters_filter.filterFilter.html +11 -76
  419. package/typedoc/functions/filters_filters.formatNumber.html +2 -2
  420. package/typedoc/functions/filters_filters.jsonFilter.html +12 -24
  421. package/typedoc/functions/filters_limit-to.limitToFilter.html +11 -90
  422. package/typedoc/functions/filters_order-by.orderByFilter.html +18 -55
  423. package/typedoc/functions/public.publishExternalAPI.html +8 -8
  424. package/typedoc/functions/router_common_glob.hasGlobs.html +306 -0
  425. package/typedoc/functions/router_directives_state-directives._StateRefActiveDirective.html +15 -8
  426. package/typedoc/functions/router_directives_state-directives._StateRefDirective.html +4 -4
  427. package/typedoc/functions/router_directives_state-directives._StateRefDynamicDirective.html +17 -77
  428. package/typedoc/functions/router_directives_view-directive._ViewDirectiveFill.html +4 -4
  429. package/typedoc/functions/router_hooks_core-resolvables.registerAddCoreResolvables.html +2 -2
  430. package/typedoc/functions/router_hooks_core-resolvables.treeChangesCleanup.html +2 -2
  431. package/typedoc/functions/router_hooks_ignored-transition.registerIgnoredTransitionHook.html +2 -2
  432. package/typedoc/functions/router_hooks_invalid-transition.registerInvalidTransitionHook.html +2 -2
  433. package/typedoc/functions/router_hooks_lazy-load.lazyLoadState.html +2 -2
  434. package/typedoc/functions/router_hooks_lazy-load.registerLazyLoadHook.html +2 -2
  435. package/typedoc/functions/router_hooks_on-enter-exit-retain.registerOnEnterHook.html +2 -2
  436. package/typedoc/functions/router_hooks_on-enter-exit-retain.registerOnExitHook.html +2 -2
  437. package/typedoc/functions/router_hooks_on-enter-exit-retain.registerOnRetainHook.html +2 -2
  438. package/typedoc/functions/router_hooks_redirect-to.registerRedirectToHook.html +2 -2
  439. package/typedoc/functions/router_hooks_resolve.registerEagerResolvePath.html +2 -2
  440. package/typedoc/functions/router_hooks_resolve.registerLazyResolveState.html +2 -2
  441. package/typedoc/functions/router_hooks_resolve.registerResolveRemaining.html +2 -2
  442. package/typedoc/functions/router_hooks_update-globals.registerUpdateGlobalState.html +2 -2
  443. package/typedoc/functions/router_hooks_url.registerUpdateUrl.html +2 -2
  444. package/typedoc/functions/router_hooks_views.registerActivateViews.html +2 -2
  445. package/typedoc/functions/router_hooks_views.registerLoadEnteringViews.html +2 -2
  446. package/typedoc/functions/router_path_path-utils.makeTargetState.html +2 -2
  447. package/typedoc/functions/router_state-filters._IncludedByStateFilter.html +18 -40
  448. package/typedoc/functions/router_state-filters._IsStateFilter.html +15 -34
  449. package/typedoc/functions/router_state_state-builder.resolvablesBuilder.html +2 -2
  450. package/typedoc/functions/router_state_state-registry.getLocals.html +2 -2
  451. package/typedoc/functions/{router_state_views.getNg1ViewConfigFactory.html → router_state_views.getViewConfigFactory.html} +13 -15
  452. package/typedoc/functions/router_state_views.ng1ViewsBuilder.html +2 -2
  453. package/typedoc/functions/router_transition_hook-registry.makeEvent.html +2 -2
  454. package/typedoc/functions/router_transition_hook-registry.matchState.html +2 -2
  455. package/typedoc/functions/services_browser.trimEmptyHash.html +2 -2
  456. package/typedoc/functions/services_cookie-reader.getCookies.html +2 -2
  457. package/typedoc/functions/services_http-backend_http-backend.createHttpBackend.html +2 -2
  458. package/typedoc/functions/services_http_http.defaultHttpResponseTransform.html +2 -2
  459. package/typedoc/functions/shared_common._removeFrom.html +2 -2
  460. package/typedoc/functions/shared_common.allTrueR.html +2 -2
  461. package/typedoc/functions/shared_common.ancestors.html +2 -2
  462. package/typedoc/functions/shared_common.anyTrueR.html +2 -2
  463. package/typedoc/functions/shared_common.applyPairs.html +2 -2
  464. package/typedoc/functions/shared_common.arrayTuples.html +2 -2
  465. package/typedoc/functions/shared_common.assertFn.html +2 -2
  466. package/typedoc/functions/shared_common.copy.html +2 -2
  467. package/typedoc/functions/shared_common.createProxyFunctions.html +2 -2
  468. package/typedoc/functions/shared_common.defaults.html +2 -2
  469. package/typedoc/functions/shared_common.deregAll.html +2 -2
  470. package/typedoc/functions/shared_common.equals.html +2 -2
  471. package/typedoc/functions/shared_common.filter.html +2 -2
  472. package/typedoc/functions/shared_common.find.html +2 -2
  473. package/typedoc/functions/shared_common.flatten.html +2 -2
  474. package/typedoc/functions/shared_common.flattenR.html +2 -2
  475. package/typedoc/functions/shared_common.inherit.html +2 -2
  476. package/typedoc/functions/shared_common.map.html +2 -2
  477. package/typedoc/functions/shared_common.omit.html +2 -2
  478. package/typedoc/functions/shared_common.pairs.html +2 -2
  479. package/typedoc/functions/shared_common.pick.html +2 -2
  480. package/typedoc/functions/shared_common.pushR.html +2 -2
  481. package/typedoc/functions/shared_common.silenceUncaughtInPromise.html +2 -2
  482. package/typedoc/functions/shared_common.silentRejection.html +2 -2
  483. package/typedoc/functions/shared_common.tail.html +2 -2
  484. package/typedoc/functions/shared_common.uniqR.html +2 -2
  485. package/typedoc/functions/shared_common.unnest.html +2 -2
  486. package/typedoc/functions/shared_common.unnestR.html +2 -2
  487. package/typedoc/functions/shared_dom.appendNodesToElement.html +2 -2
  488. package/typedoc/functions/shared_dom.buildFragment.html +2 -2
  489. package/typedoc/functions/shared_dom.cleanElementData.html +2 -2
  490. package/typedoc/functions/shared_dom.createElementFromHTML.html +2 -2
  491. package/typedoc/functions/shared_dom.createNodelistFromHTML.html +2 -2
  492. package/typedoc/functions/shared_dom.dealoc.html +2 -2
  493. package/typedoc/functions/shared_dom.deleteCacheData.html +2 -2
  494. package/typedoc/functions/shared_dom.domInsert.html +2 -2
  495. package/typedoc/functions/shared_dom.emptyElement.html +2 -2
  496. package/typedoc/functions/shared_dom.getBlockNodes.html +2 -2
  497. package/typedoc/functions/shared_dom.getBooleanAttrName.html +2 -2
  498. package/typedoc/functions/shared_dom.getCacheData.html +2 -2
  499. package/typedoc/functions/shared_dom.getController.html +2 -2
  500. package/typedoc/functions/shared_dom.getExpando.html +2 -2
  501. package/typedoc/functions/shared_dom.getInheritedData.html +2 -2
  502. package/typedoc/functions/shared_dom.getInjector.html +2 -2
  503. package/typedoc/functions/shared_dom.getIsolateScope.html +2 -2
  504. package/typedoc/functions/shared_dom.getOrSetCacheData.html +2 -2
  505. package/typedoc/functions/shared_dom.getScope.html +2 -2
  506. package/typedoc/functions/shared_dom.isRoot.html +2 -2
  507. package/typedoc/functions/shared_dom.isTextNode.html +2 -2
  508. package/typedoc/functions/shared_dom.kebabToCamel.html +2 -2
  509. package/typedoc/functions/shared_dom.parseHtml.html +2 -2
  510. package/typedoc/functions/shared_dom.removeElement.html +2 -2
  511. package/typedoc/functions/shared_dom.removeElementData.html +2 -2
  512. package/typedoc/functions/shared_dom.setCacheData.html +2 -2
  513. package/typedoc/functions/shared_dom.setInheritedData.html +2 -2
  514. package/typedoc/functions/shared_dom.setIsolateScope.html +2 -2
  515. package/typedoc/functions/shared_dom.setScope.html +2 -2
  516. package/typedoc/functions/shared_dom.snakeToCamel.html +2 -2
  517. package/typedoc/functions/shared_dom.startingTag.html +2 -2
  518. package/typedoc/functions/shared_hof.all.html +2 -2
  519. package/typedoc/functions/shared_hof.compose.html +2 -2
  520. package/typedoc/functions/shared_hof.curry.html +2 -2
  521. package/typedoc/functions/shared_hof.is.html +2 -2
  522. package/typedoc/functions/shared_hof.or.html +2 -2
  523. package/typedoc/functions/shared_hof.parse.html +2 -2
  524. package/typedoc/functions/shared_hof.pattern.html +2 -2
  525. package/typedoc/functions/shared_hof.pipe.html +2 -2
  526. package/typedoc/functions/shared_hof.val.html +2 -2
  527. package/typedoc/functions/shared_predicates.isInjectable.html +2 -2
  528. package/typedoc/functions/shared_predicates.isPromise.html +2 -2
  529. package/typedoc/functions/shared_strings.beforeAfterSubstr.html +2 -2
  530. package/typedoc/functions/shared_strings.fnToString.html +2 -2
  531. package/typedoc/functions/shared_strings.functionToString.html +2 -2
  532. package/typedoc/functions/shared_strings.joinNeighborsR.html +2 -2
  533. package/typedoc/functions/shared_strings.kebobString.html +2 -2
  534. package/typedoc/functions/shared_strings.maxLength.html +2 -2
  535. package/typedoc/functions/shared_strings.padString.html +2 -2
  536. package/typedoc/functions/shared_strings.splitOnDelim.html +2 -2
  537. package/typedoc/functions/shared_strings.stringify.html +2 -2
  538. package/typedoc/functions/shared_strings.stripLastPathElement.html +2 -2
  539. package/typedoc/functions/shared_strings.trimHashVal.html +2 -2
  540. package/typedoc/functions/shared_test-utils.bootstrap.html +2 -2
  541. package/typedoc/functions/shared_test-utils.browserTrigger.html +2 -2
  542. package/typedoc/functions/shared_test-utils.wait.html +2 -2
  543. package/typedoc/functions/shared_utils.addDateMinutes.html +2 -2
  544. package/typedoc/functions/shared_utils.arrayRemove.html +2 -2
  545. package/typedoc/functions/shared_utils.assert.html +2 -2
  546. package/typedoc/functions/shared_utils.assertArg.html +2 -2
  547. package/typedoc/functions/shared_utils.assertArgFn.html +2 -2
  548. package/typedoc/functions/shared_utils.assertNotHasOwnProperty.html +2 -2
  549. package/typedoc/functions/shared_utils.baseExtend.html +2 -2
  550. package/typedoc/functions/shared_utils.bind.html +2 -2
  551. package/typedoc/functions/shared_utils.concat.html +2 -2
  552. package/typedoc/functions/shared_utils.convertTimezoneToLocal.html +2 -2
  553. package/typedoc/functions/shared_utils.csp.html +2 -2
  554. package/typedoc/functions/shared_utils.directiveNormalize.html +2 -2
  555. package/typedoc/functions/shared_utils.encodeUriQuery.html +2 -2
  556. package/typedoc/functions/shared_utils.encodeUriSegment.html +2 -2
  557. package/typedoc/functions/shared_utils.equals.html +2 -2
  558. package/typedoc/functions/shared_utils.errorHandlingConfig.html +2 -2
  559. package/typedoc/functions/shared_utils.extend.html +3 -3
  560. package/typedoc/functions/shared_utils.fromJson.html +2 -2
  561. package/typedoc/functions/shared_utils.getNgAttribute.html +2 -2
  562. package/typedoc/functions/shared_utils.getNodeName.html +2 -2
  563. package/typedoc/functions/shared_utils.hasAnimate.html +2 -2
  564. package/typedoc/functions/shared_utils.hasCustomToString.html +2 -2
  565. package/typedoc/functions/{shared_utils.merge.html → shared_utils.hasOwn.html} +44 -91
  566. package/typedoc/functions/shared_utils.hashKey.html +2 -2
  567. package/typedoc/functions/shared_utils.includes.html +2 -2
  568. package/typedoc/functions/shared_utils.inherit.html +2 -2
  569. package/typedoc/functions/shared_utils.isArrayBuffer.html +2 -2
  570. package/typedoc/functions/shared_utils.isArrayLike.html +2 -2
  571. package/typedoc/functions/shared_utils.isBlankObject.html +2 -2
  572. package/typedoc/functions/shared_utils.isBlob.html +2 -2
  573. package/typedoc/functions/shared_utils.isBoolean.html +2 -2
  574. package/typedoc/functions/shared_utils.isDate.html +2 -2
  575. package/typedoc/functions/shared_utils.isDefined.html +2 -2
  576. package/typedoc/functions/shared_utils.isElement.html +2 -2
  577. package/typedoc/functions/shared_utils.isError.html +2 -2
  578. package/typedoc/functions/shared_utils.isFile.html +2 -2
  579. package/typedoc/functions/shared_utils.isFormData.html +2 -2
  580. package/typedoc/functions/shared_utils.isFunction.html +2 -2
  581. package/typedoc/functions/shared_utils.isNull.html +2 -2
  582. package/typedoc/functions/shared_utils.isNullOrUndefined.html +2 -2
  583. package/typedoc/functions/shared_utils.isNumber.html +2 -2
  584. package/typedoc/functions/shared_utils.isNumberNaN.html +2 -2
  585. package/typedoc/functions/shared_utils.isObject.html +2 -2
  586. package/typedoc/functions/shared_utils.isObjectEmpty.html +2 -2
  587. package/typedoc/functions/shared_utils.isPromiseLike.html +2 -2
  588. package/typedoc/functions/shared_utils.isProxy.html +2 -2
  589. package/typedoc/functions/shared_utils.isRegExp.html +2 -2
  590. package/typedoc/functions/shared_utils.isScope.html +2 -2
  591. package/typedoc/functions/shared_utils.isString.html +2 -2
  592. package/typedoc/functions/shared_utils.isTypedArray.html +2 -2
  593. package/typedoc/functions/shared_utils.isUndefined.html +2 -2
  594. package/typedoc/functions/shared_utils.isValidObjectMaxDepth.html +2 -2
  595. package/typedoc/functions/shared_utils.isWindow.html +2 -2
  596. package/typedoc/functions/shared_utils.lowercase.html +2 -2
  597. package/typedoc/functions/shared_utils.mergeClasses.html +2 -2
  598. package/typedoc/functions/shared_utils.minErr.html +3 -3
  599. package/typedoc/functions/shared_utils.nextUid.html +2 -2
  600. package/typedoc/functions/shared_utils.parseKeyValue.html +2 -2
  601. package/typedoc/functions/shared_utils.replaceInline.html +2 -2
  602. package/typedoc/functions/shared_utils.setHashKey.html +2 -2
  603. package/typedoc/functions/shared_utils.shallowCopy.html +2 -2
  604. package/typedoc/functions/shared_utils.simpleCompare.html +2 -2
  605. package/typedoc/functions/shared_utils.sliceArgs.html +2 -2
  606. package/typedoc/functions/shared_utils.snakeCase.html +2 -2
  607. package/typedoc/functions/shared_utils.stringify.html +2 -2
  608. package/typedoc/functions/shared_utils.timezoneToOffset.html +2 -2
  609. package/typedoc/functions/shared_utils.toDebugString.html +2 -2
  610. package/typedoc/functions/shared_utils.toInt.html +2 -2
  611. package/typedoc/functions/shared_utils.toJson.html +3 -3
  612. package/typedoc/functions/shared_utils.toKeyValue.html +2 -2
  613. package/typedoc/functions/shared_utils.trim.html +2 -2
  614. package/typedoc/functions/shared_utils.tryDecodeURIComponent.html +2 -2
  615. package/typedoc/functions/shared_utils.uppercase.html +2 -2
  616. package/typedoc/hierarchy.html +3 -3
  617. package/typedoc/index.html +24 -24
  618. package/typedoc/interfaces/animations_animate.AnimationOptions.html +10 -10
  619. package/typedoc/interfaces/{types.OnChangesObject.html → animations_raf-scheduler.ServiceProvider.html} +38 -35
  620. package/typedoc/interfaces/core_cache_cache.ExpandoStore.html +8 -8
  621. package/typedoc/interfaces/core_compile_compile.LinkFnMapping.html +24 -24
  622. package/typedoc/interfaces/core_compile_compile.NodeLinkFnCtx.html +676 -0
  623. package/typedoc/interfaces/core_compile_compile.SimpleChange.html +6 -6
  624. package/typedoc/interfaces/core_location_location.DefaultPorts.html +8 -8
  625. package/typedoc/interfaces/core_location_location.Html5Mode.html +8 -8
  626. package/typedoc/interfaces/core_parse_ast_ast.Token.html +14 -14
  627. package/typedoc/interfaces/{core_parse_parse.CompiledExpressionHandlerMap.html → core_parse_interface.CompiledExpressionHandlerMap.html} +30 -14
  628. package/typedoc/interfaces/{core_parse_parse.CompiledExpressionProps.html → core_parse_interface.CompiledExpressionProps.html} +204 -50
  629. package/typedoc/interfaces/core_parse_lexer_lexer.LexerOptions.html +6 -6
  630. package/typedoc/interfaces/core_parse_parser_parser.ParsedAST.html +4 -4
  631. package/typedoc/interfaces/core_sanitize_interface.SanitizerFn.html +319 -0
  632. package/typedoc/interfaces/core_scope_scope.AsyncQueueTask.html +8 -8
  633. package/typedoc/interfaces/core_scope_scope.Listener.html +20 -20
  634. package/typedoc/interfaces/directive_model-options_model-options.ModelOptionsConfig.html +12 -12
  635. package/typedoc/interfaces/{types.ChangesObject.html → interface.ChangesObject.html} +35 -71
  636. package/typedoc/interfaces/interface.ComponentOptions.html +803 -0
  637. package/typedoc/interfaces/{types.Controller.html → interface.Controller.html} +27 -58
  638. package/typedoc/interfaces/{types.Directive.html → interface.Directive.html} +200 -163
  639. package/typedoc/interfaces/{types.DirectivePrePost.html → interface.DirectivePrePost.html} +20 -19
  640. package/typedoc/interfaces/interface.NgModelController.html +1530 -0
  641. package/typedoc/interfaces/{types.NgModelOptions.html → interface.NgModelOptions.html} +44 -26
  642. package/typedoc/interfaces/interface.Provider.html +1136 -0
  643. package/typedoc/interfaces/interface.TranscludeFunctionObject.html +770 -0
  644. package/typedoc/interfaces/loader.AngularBootstrapConfig.html +4 -4
  645. package/typedoc/interfaces/router_params_interface.ParamDeclaration.html +1324 -0
  646. package/typedoc/interfaces/router_params_interface.ParamTypeDefinition.html +1375 -0
  647. package/typedoc/{types/animations_raf-scheduler.RafSchedulerFunction.html → interfaces/router_params_interface.RawParams.html} +56 -13
  648. package/typedoc/interfaces/router_params_interface.Replace.html +465 -0
  649. package/typedoc/interfaces/router_resolve_interface.CustomAsyncPolicy.html +305 -0
  650. package/typedoc/interfaces/router_resolve_interface.ProviderLike.html +660 -0
  651. package/typedoc/interfaces/router_resolve_interface.ResolvableLiteral.html +670 -0
  652. package/typedoc/interfaces/router_resolve_interface.ResolvePolicy.html +674 -0
  653. package/typedoc/interfaces/router_state_interface.HrefOptions.html +588 -0
  654. package/typedoc/interfaces/{types.Annotated.html → router_state_interface.LazyLoadResult.html} +45 -24
  655. package/typedoc/interfaces/router_state_interface.StateDeclaration.html +2662 -0
  656. package/typedoc/interfaces/router_state_interface.TargetStateDef.html +515 -0
  657. package/typedoc/interfaces/router_state_interface.TransitionPromise.html +1241 -0
  658. package/typedoc/interfaces/router_state_interface.ViewDeclaration.html +1678 -0
  659. package/typedoc/interfaces/router_template-factory.BindingTuple.html +6 -6
  660. package/typedoc/interfaces/router_transition_interface.HookMatchCriteria.html +788 -0
  661. package/typedoc/interfaces/router_transition_interface.HookRegOptions.html +529 -0
  662. package/typedoc/interfaces/router_transition_interface.IHookRegistry.html +3093 -0
  663. package/typedoc/interfaces/router_transition_interface.IMatchingNodes.html +663 -0
  664. package/typedoc/interfaces/{animations_raf-scheduler.RafSchedulerObject.html → router_transition_interface.PathType.html} +76 -28
  665. package/typedoc/interfaces/{types.TranscludeFunctionObject.html → router_transition_interface.PathTypes.html} +199 -164
  666. package/typedoc/{types/core_parse_parse.CompiledExpressionFunction.html → interfaces/router_transition_interface.RegisteredHooks.html} +28 -14
  667. package/typedoc/interfaces/router_transition_interface.TransitionCreateHookFn.html +330 -0
  668. package/typedoc/interfaces/router_transition_interface.TransitionHookFn.html +366 -0
  669. package/typedoc/interfaces/router_transition_interface.TransitionHookOptions.html +718 -0
  670. package/typedoc/interfaces/router_transition_interface.TransitionOptions.html +1231 -0
  671. package/typedoc/interfaces/router_transition_interface.TransitionStateHookFn.html +388 -0
  672. package/typedoc/interfaces/router_transition_interface.TreeChanges.html +849 -0
  673. package/typedoc/interfaces/router_view_interface.ActiveUIView.html +700 -0
  674. package/typedoc/{classes/router_globals.UIRouterGlobals.html → interfaces/router_view_interface.ViewConfig.html} +235 -226
  675. package/typedoc/interfaces/router_view_interface.ViewContext.html +455 -0
  676. package/typedoc/interfaces/services_anchor-scroll.AnchorScrollObject.html +4 -4
  677. package/typedoc/interfaces/services_log.LogService.html +14 -14
  678. package/typedoc/{types/types.Injectable.html → interfaces/shared_interface.TypedMap.html} +24 -22
  679. package/typedoc/interfaces/shared_utils.ErrorHandlingConfig.html +6 -6
  680. package/typedoc/media/CONTRIBUTING.md +9 -9
  681. package/typedoc/media/DEVELOPERS.md +30 -30
  682. package/typedoc/modules/animations_interface.html +325 -0
  683. package/typedoc/modules/animations_raf-scheduler.html +15 -45
  684. package/typedoc/modules/core_compile_compile.html +27 -0
  685. package/typedoc/modules/core_error-handler.html +325 -0
  686. package/typedoc/modules/core_exception-handler.html +48 -12
  687. package/typedoc/modules/core_parse_ast_ast.html +0 -62
  688. package/typedoc/modules/core_parse_interface.html +473 -0
  689. package/typedoc/modules/core_parse_parse.html +0 -213
  690. package/typedoc/modules/core_sanitize_interface.html +323 -0
  691. package/typedoc/modules/core_sanitize_sanitize-uri.html +64 -0
  692. package/typedoc/modules/core_sce_sce.html +1 -1
  693. package/typedoc/modules/{types.html → interface.html} +106 -414
  694. package/typedoc/modules/router_common_glob.html +62 -181
  695. package/typedoc/modules/router_common_trace.html +65 -27
  696. package/typedoc/modules/router_globals.html +70 -6
  697. package/typedoc/modules/router_params_interface.html +405 -0
  698. package/typedoc/modules/router_resolve_interface.html +524 -0
  699. package/typedoc/modules/router_state_interface.html +609 -0
  700. package/typedoc/modules/router_state_state-object.html +64 -0
  701. package/typedoc/modules/router_state_state-registry.html +64 -0
  702. package/typedoc/modules/router_state_views.html +12 -14
  703. package/typedoc/modules/router_transition_interface.html +553 -14
  704. package/typedoc/modules/router_transition_transition.html +64 -0
  705. package/typedoc/modules/router_view_interface.html +376 -0
  706. package/typedoc/modules/shared_interface.html +439 -0
  707. package/typedoc/modules/shared_utils.html +26 -26
  708. package/typedoc/modules.html +267 -23
  709. package/typedoc/types/animations_animate.AnimationMethod.html +2 -2
  710. package/typedoc/types/animations_interface.RafScheduler.html +638 -0
  711. package/typedoc/types/core_cache_cache-factory.TemplateCache.html +2 -2
  712. package/typedoc/types/core_compile_compile.ApplyDirectivesToNodeFn.html +2 -2
  713. package/typedoc/types/core_compile_compile.BoundTranscludeFn.html +2 -2
  714. package/typedoc/types/core_compile_compile.CompileFn.html +2 -2
  715. package/typedoc/types/core_compile_compile.CompileNodesFn.html +2 -2
  716. package/typedoc/types/core_compile_compile.CompositeLinkFn.html +2 -2
  717. package/typedoc/types/core_compile_compile.NodeLinkFn.html +4 -34
  718. package/typedoc/types/core_compile_compile.PublicLinkFn.html +11 -2
  719. package/typedoc/types/core_compile_compile.TranscludeFn.html +2 -2
  720. package/typedoc/types/{core_exception-handler.ErrorHandler.html → core_error-handler.ErrorHandler.html} +8 -5
  721. package/typedoc/types/core_exception-handler.LogService.html +2 -2
  722. package/typedoc/types/core_parse_ast_ast-node.ASTNode.html +52 -52
  723. package/typedoc/types/{core_parse_parse.CompiledExpression.html → core_parse_interface.CompiledExpression.html} +13 -5
  724. package/typedoc/types/core_parse_interface.CompiledExpressionFunction.html +360 -0
  725. package/typedoc/types/core_parse_interface.ParseService.html +487 -0
  726. package/typedoc/types/core_parse_interpreter.DecoratedASTNode.html +2 -2
  727. package/typedoc/types/core_scope_scope.ListenerFunction.html +2 -2
  728. package/typedoc/types/core_url-utils_url-utils.HttpProtocol.html +2 -2
  729. package/typedoc/types/interface.AnnotatedFactory.html +288 -0
  730. package/typedoc/types/{types.CloneAttachFunction.html → interface.CloneAttachFunction.html} +6 -11
  731. package/typedoc/types/interface.ControllerConstructor.html +329 -0
  732. package/typedoc/types/interface.DirectiveCompileFn.html +420 -0
  733. package/typedoc/types/{types.DirectiveController.html → interface.DirectiveController.html} +9 -6
  734. package/typedoc/types/{types.DirectiveFactory.html → interface.DirectiveFactory.html} +12 -9
  735. package/typedoc/types/{types.DirectiveLinkFn.html → interface.DirectiveLinkFn.html} +60 -52
  736. package/typedoc/types/{types.Expression.html → interface.Expression.html} +14 -3
  737. package/typedoc/types/interface.FilterFactory.html +324 -0
  738. package/typedoc/types/interface.FilterFn.html +328 -0
  739. package/typedoc/types/{types.TAttributes.html → interface.Injectable.html} +15 -10
  740. package/typedoc/types/interface.InjectableFactory.html +323 -0
  741. package/typedoc/types/{types.Attributes.html → interface.OnChangesObject.html} +15 -9
  742. package/typedoc/types/{types.TController.html → interface.TController.html} +8 -5
  743. package/typedoc/types/{types.AnnotatedFunction.html → router_resolve_interface.PolicyAsync.html} +17 -15
  744. package/typedoc/types/{types.ServiceProvider.html → router_resolve_interface.PolicyWhen.html} +13 -10
  745. package/typedoc/{variables/router_transition_interface.TransitionHookScope.html → types/router_state_interface.RedirectToResult.html} +40 -38
  746. package/typedoc/types/router_state_interface.ResolveTypes.html +281 -0
  747. package/typedoc/types/{animations_raf-scheduler.RafScheduler.html → router_state_interface.StateOrName.html} +16 -15
  748. package/typedoc/types/router_state_interface._StateDeclaration.html +288 -0
  749. package/typedoc/types/router_transition_interface.HookFn.html +281 -0
  750. package/typedoc/{variables/router_common_trace.Category.html → types/router_transition_interface.HookMatchCriterion.html} +23 -19
  751. package/typedoc/types/router_transition_interface.HookResult.html +324 -0
  752. package/typedoc/types/{types.DirectiveCompileFn.html → router_transition_interface.IHookRegistration.html} +53 -53
  753. package/typedoc/{variables/core_parse_ast_ast.literals.html → types/router_transition_interface.IStateMatch.html} +27 -13
  754. package/typedoc/types/services_anchor-scroll.AnchorScrollFunction.html +2 -2
  755. package/typedoc/types/services_anchor-scroll.AnchorScrollService.html +2 -2
  756. package/typedoc/types/services_browser.UrlChangeListener.html +2 -2
  757. package/typedoc/types/services_log.LogCall.html +2 -2
  758. package/typedoc/types/shared_interface.Mapper.html +351 -0
  759. package/typedoc/types/shared_interface.Predicate.html +319 -0
  760. package/typedoc/types/shared_interface.PredicateBinary.html +344 -0
  761. package/typedoc/variables/animations_shared.ACTIVE_CLASS_SUFFIX.html +2 -2
  762. package/typedoc/variables/animations_shared.ADD_CLASS_SUFFIX.html +2 -2
  763. package/typedoc/variables/animations_shared.ANIMATIONEND_EVENT.html +2 -2
  764. package/typedoc/variables/animations_shared.ANIMATION_DELAY_PROP.html +2 -2
  765. package/typedoc/variables/animations_shared.ANIMATION_DURATION_PROP.html +2 -2
  766. package/typedoc/variables/animations_shared.ANIMATION_ITERATION_COUNT_KEY.html +2 -2
  767. package/typedoc/variables/animations_shared.ANIMATION_PLAYSTATE_KEY.html +2 -2
  768. package/typedoc/variables/animations_shared.ANIMATION_PROP.html +2 -2
  769. package/typedoc/variables/animations_shared.CSS_PREFIX.html +2 -2
  770. package/typedoc/variables/animations_shared.DELAY_KEY.html +2 -2
  771. package/typedoc/variables/animations_shared.DURATION_KEY.html +2 -2
  772. package/typedoc/variables/animations_shared.EVENT_CLASS_PREFIX.html +2 -2
  773. package/typedoc/variables/animations_shared.NG_ANIMATE_CHILDREN_DATA.html +2 -2
  774. package/typedoc/variables/animations_shared.NG_ANIMATE_CLASSNAME.html +2 -2
  775. package/typedoc/variables/animations_shared.PREPARE_CLASS_SUFFIX.html +2 -2
  776. package/typedoc/variables/animations_shared.PROPERTY_KEY.html +2 -2
  777. package/typedoc/variables/animations_shared.REMOVE_CLASS_SUFFIX.html +2 -2
  778. package/typedoc/variables/animations_shared.SAFE_FAST_FORWARD_DURATION_VALUE.html +2 -2
  779. package/typedoc/variables/animations_shared.TIMING_KEY.html +2 -2
  780. package/typedoc/variables/animations_shared.TRANSITIONEND_EVENT.html +2 -2
  781. package/typedoc/variables/animations_shared.TRANSITION_DELAY_PROP.html +2 -2
  782. package/typedoc/variables/animations_shared.TRANSITION_DURATION_PROP.html +2 -2
  783. package/typedoc/variables/animations_shared.TRANSITION_PROP.html +2 -2
  784. package/typedoc/variables/animations_shared.ngMinErr.html +2 -2
  785. package/typedoc/variables/core_cache_cache.Cache.html +2 -2
  786. package/typedoc/variables/core_cache_cache.EXPANDO.html +2 -2
  787. package/typedoc/variables/core_cache_cache.ISOLATE_SCOPE_KEY.html +2 -2
  788. package/typedoc/variables/core_cache_cache.SCOPE_KEY.html +2 -2
  789. package/typedoc/variables/core_compile_compile.DirectiveSuffix.html +2 -2
  790. package/typedoc/variables/core_di_injector.path.html +2 -2
  791. package/typedoc/variables/core_di_ng-module.ANIMATION_LITERAL.html +2 -2
  792. package/typedoc/variables/core_di_ng-module.COMPILE_LITERAL.html +2 -2
  793. package/typedoc/variables/core_di_ng-module.CONTROLLER_LITERAL.html +2 -2
  794. package/typedoc/variables/core_di_ng-module.FILTER_LITERAL.html +2 -2
  795. package/typedoc/variables/core_di_ng-module.INJECTOR_LITERAL.html +2 -2
  796. package/typedoc/variables/core_di_ng-module.PROVIDE_LITERAL.html +2 -2
  797. package/typedoc/variables/core_parse_interpreter.PURITY_ABSOLUTE.html +2 -2
  798. package/typedoc/variables/core_parse_interpreter.PURITY_RELATIVE.html +2 -2
  799. package/typedoc/variables/core_pubsub_pubsub.EventBus.html +2 -2
  800. package/typedoc/variables/core_sce_sce.SCE_CONTEXTS.html +2 -2
  801. package/typedoc/variables/core_scope_scope.NONSCOPE.html +2 -2
  802. package/typedoc/variables/core_scope_scope.__applyAsyncQueue.html +2 -2
  803. package/typedoc/variables/core_scope_scope._postUpdateQueue.html +2 -2
  804. package/typedoc/variables/directive_attrs_attrs.REGEX_STRING_REGEXP.html +2 -2
  805. package/typedoc/variables/directive_attrs_attrs.ngAttributeAliasDirectives.html +2 -2
  806. package/typedoc/variables/directive_class_class.ngClassDirective.html +5 -5
  807. package/typedoc/variables/directive_class_class.ngClassEvenDirective.html +5 -5
  808. package/typedoc/variables/directive_class_class.ngClassOddDirective.html +5 -5
  809. package/typedoc/variables/directive_events_events.ngEventDirectives.html +2 -2
  810. package/typedoc/variables/directive_form_form.PENDING_CLASS.html +2 -2
  811. package/typedoc/variables/directive_form_form.formDirective.html +2 -2
  812. package/typedoc/variables/directive_form_form.ngFormDirective.html +2 -2
  813. package/typedoc/variables/directive_form_form.nullFormCtrl.html +2 -2
  814. package/typedoc/variables/directive_input_input.EMAIL_REGEXP.html +2 -2
  815. package/typedoc/variables/directive_input_input.ISO_DATE_REGEXP.html +2 -2
  816. package/typedoc/variables/directive_input_input.URL_REGEXP.html +2 -2
  817. package/typedoc/variables/directive_input_input.VALIDITY_STATE_PROPERTY.html +2 -2
  818. package/typedoc/variables/directive_messages_messages.ngMessageDefaultDirective.html +2 -2
  819. package/typedoc/variables/directive_messages_messages.ngMessageDirective.html +2 -2
  820. package/typedoc/variables/directive_messages_messages.ngMessageExpDirective.html +2 -2
  821. package/typedoc/variables/directive_model-options_model-options.defaultModelOptions.html +2 -2
  822. package/typedoc/variables/directive_model_model.ngModelMinErr.html +2 -2
  823. package/typedoc/variables/directive_options_options.ngOptionsDirective.html +6 -6
  824. package/typedoc/variables/directive_transclude_transclude.ngTranscludeDirective.html +6 -6
  825. package/typedoc/variables/directive_validators_validators.maxlengthDirective.html +12 -12
  826. package/typedoc/variables/directive_validators_validators.minlengthDirective.html +4 -4
  827. package/typedoc/variables/directive_validators_validators.patternDirective.html +12 -12
  828. package/typedoc/variables/directive_validators_validators.requiredDirective.html +12 -12
  829. package/typedoc/variables/index.angular.html +2 -2
  830. package/typedoc/variables/public.VERSION.html +3 -7
  831. package/typedoc/variables/router_common_trace.trace.html +2 -2
  832. package/typedoc/variables/router_directives_view-directive.ngView.html +7 -7
  833. package/typedoc/variables/router_hooks_resolve.RESOLVE_HOOK_PRIORITY.html +2 -2
  834. package/typedoc/variables/router_params_param.DefType.html +2 -2
  835. package/typedoc/variables/router_resolve_resolvable.defaultResolvePolicy.html +2 -2
  836. package/typedoc/variables/router_resolve_resolve-context.resolvePolicies.html +2 -2
  837. package/typedoc/variables/router_transition_transition-service.defaultTransOpts.html +2 -2
  838. package/typedoc/variables/services_log.LogService.html +4 -4
  839. package/typedoc/variables/shared_common.assertMap.html +2 -2
  840. package/typedoc/variables/shared_common.assertPredicate.html +2 -2
  841. package/typedoc/variables/shared_common.pushTo.html +2 -2
  842. package/typedoc/variables/shared_common.removeFrom.html +2 -2
  843. package/typedoc/variables/shared_constants.ALIASED_ATTR.html +2 -2
  844. package/typedoc/variables/shared_constants.DIRTY_CLASS.html +2 -2
  845. package/typedoc/variables/shared_constants.EMPTY_CLASS.html +2 -2
  846. package/typedoc/variables/shared_constants.INVALID_CLASS.html +2 -2
  847. package/typedoc/variables/shared_constants.NOT_EMPTY_CLASS.html +2 -2
  848. package/typedoc/variables/shared_constants.PREFIX_REGEXP.html +2 -2
  849. package/typedoc/variables/shared_constants.PRISTINE_CLASS.html +2 -2
  850. package/typedoc/variables/shared_constants.SPECIAL_CHARS_REGEXP.html +2 -2
  851. package/typedoc/variables/shared_constants.TOUCHED_CLASS.html +2 -2
  852. package/typedoc/variables/shared_constants.UNTOUCHED_CLASS.html +2 -2
  853. package/typedoc/variables/shared_constants.VALID_CLASS.html +2 -2
  854. package/typedoc/variables/shared_dom.BOOLEAN_ATTR.html +2 -2
  855. package/typedoc/variables/shared_hof.propEq.html +2 -2
  856. package/typedoc/variables/shared_strings.hostRegex.html +2 -2
  857. package/typedoc/variables/shared_strings.splitEqual.html +2 -2
  858. package/typedoc/variables/shared_strings.splitHash.html +2 -2
  859. package/typedoc/variables/shared_strings.splitQuery.html +2 -2
  860. package/typedoc/variables/shared_utils.isProxySymbol.html +2 -2
  861. package/typedoc/variables/shared_utils.ngAttrPrefixes.html +2 -2
  862. package/@types/directive/change/change.d.ts +0 -4
  863. package/@types/types.d.ts +0 -595
  864. package/src/types.js +0 -427
  865. package/typedoc/interfaces/types.FormController.html +0 -1541
  866. package/typedoc/interfaces/types.Module.html +0 -1566
  867. package/typedoc/interfaces/types.NgModelController.html +0 -2088
  868. package/typedoc/types/core_parse_parse.ParseService.html +0 -266
  869. package/typedoc/types/types.AsyncModelValidators.html +0 -266
  870. package/typedoc/types/types.BootstrapConfig.html +0 -262
  871. package/typedoc/types/types.ComponentOptions.html +0 -262
  872. package/typedoc/types/types.ControllerConstructor.html +0 -262
  873. package/typedoc/types/types.FilterFactory.html +0 -262
  874. package/typedoc/types/types.FilterFunction.html +0 -262
  875. package/typedoc/types/types.ModelValidators.html +0 -266
  876. package/typedoc/types/types.ServiceProviderFactory.html +0 -262
  877. package/typedoc/types/types.TElement.html +0 -262
  878. package/typedoc/types/types.TScope.html +0 -266
  879. package/typedoc/types/types.TranscludeFunction.html +0 -262
  880. package/typedoc/types/types.transcludeWithScope.html +0 -262
  881. package/typedoc/types/types.transcludeWithoutScope.html +0 -262
package/typedoc/interfaces/router_params_interface.ParamTypeDefinition.html ADDED
@@ -0,0 +1,1375 @@
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>ParamTypeDefinition | @angular-wave/angular.ts</title>
7
+ <meta
8
+ name="description"
9
+ content="Documentation for @angular-wave/angular.ts"
10
+ />
11
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
12
+ <link rel="stylesheet" href="../assets/style.css" />
13
+ <link rel="stylesheet" href="../assets/highlight.css" />
14
+ <script defer src="../assets/main.js"></script>
15
+ <script async src="../assets/icons.js" id="tsd-icons-script"></script>
16
+ <script async src="../assets/search.js" id="tsd-search-script"></script>
17
+ <script async src="../assets/navigation.js" id="tsd-nav-script"></script>
18
+ <script
19
+ async
20
+ src="../assets/hierarchy.js"
21
+ id="tsd-hierarchy-script"
22
+ ></script>
23
+ </head>
24
+ <body>
25
+ <script>
26
+ document.documentElement.dataset.theme =
27
+ localStorage.getItem("tsd-theme") || "os";
28
+ document.body.style.display = "none";
29
+ setTimeout(
30
+ () =>
31
+ window.app
32
+ ? app.showPage()
33
+ : document.body.style.removeProperty("display"),
34
+ 500,
35
+ );
36
+ </script>
37
+ <header class="tsd-page-toolbar">
38
+ <div class="tsd-toolbar-contents container">
39
+ <a href="../index.html" class="title">@angular-wave/angular.ts</a>
40
+ <div id="tsd-toolbar-links"></div>
41
+ <button id="tsd-search-trigger" class="tsd-widget" aria-label="Search">
42
+ <svg
43
+ width="16"
44
+ height="16"
45
+ viewBox="0 0 16 16"
46
+ fill="none"
47
+ aria-hidden="true"
48
+ >
49
+ <use href="../assets/icons.svg#icon-search"></use>
50
+ </svg>
51
+ </button>
52
+ <dialog id="tsd-search" aria-label="Search">
53
+ <input
54
+ role="combobox"
55
+ id="tsd-search-input"
56
+ aria-controls="tsd-search-results"
57
+ aria-autocomplete="list"
58
+ aria-expanded="true"
59
+ autocapitalize="off"
60
+ autocomplete="off"
61
+ placeholder="Search the docs"
62
+ maxlength="100"
63
+ />
64
+ <ul role="listbox" id="tsd-search-results"></ul>
65
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
66
+ <div>Preparing search index...</div>
67
+ </div>
68
+ </dialog>
69
+ <a
70
+ href="#"
71
+ class="tsd-widget menu"
72
+ id="tsd-toolbar-menu-trigger"
73
+ data-toggle="menu"
74
+ aria-label="Menu"
75
+ ><svg
76
+ width="16"
77
+ height="16"
78
+ viewBox="0 0 16 16"
79
+ fill="none"
80
+ aria-hidden="true"
81
+ >
82
+ <use href="../assets/icons.svg#icon-menu"></use></svg
83
+ ></a>
84
+ </div>
85
+ </header>
86
+ <div class="container container-main">
87
+ <div class="col-content">
88
+ <div class="tsd-page-title">
89
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
90
+ <li>
91
+ <a href="../modules/router_params_interface.html"
92
+ >router/params/interface</a
93
+ >
94
+ </li>
95
+ <li><a href="" aria-current="page">ParamTypeDefinition</a></li>
96
+ </ul>
97
+ <h1>Interface ParamTypeDefinition</h1>
98
+ </div>
99
+ <section class="tsd-panel tsd-comment">
100
+ <div class="tsd-comment tsd-typography">
101
+ <p>Describes a custom [[ParamType]]</p>
102
+ <p>See: [[UrlMatcherFactory.type]]</p>
103
+ <p>
104
+ A developer can create a custom parameter type definition to
105
+ customize the encoding and decoding of parameter values. The
106
+ definition should implement all the methods of this interface.
107
+ </p>
108
+ <p>
109
+ Parameter values are parsed from the URL as strings. However, it
110
+ is often useful to parse the string into some other form, such as:
111
+ </p>
112
+ <ul>
113
+ <li>integer</li>
114
+ <li>date</li>
115
+ <li>array of &lt;integer/date/string&gt;</li>
116
+ <li>custom object</li>
117
+ <li>some internal string representation</li>
118
+ </ul>
119
+ <p>
120
+ Typed parameter definitions control how parameter values are
121
+ encoded (to the URL) and decoded (from the URL). UI-Router always
122
+ provides the decoded parameter values to the user (from methods
123
+ such as [[Transition.params]])).
124
+ </p>
125
+ <p>
126
+ For example, if a state has a url of
127
+ <code>/foo/{fooId:int}</code> (the <code>fooId</code> parameter is
128
+ of the <code>int</code> ParamType) and if the browser is at
129
+ <code>/foo/123</code>, then the 123 is parsed as an integer:
130
+ </p>
131
+ <pre><code class="js"><span class="hl-11">var</span><span class="hl-1"> </span><span class="hl-10">fooId</span><span class="hl-1"> = </span><span class="hl-10">transition</span><span class="hl-1">.</span><span class="hl-0">params</span><span class="hl-1">().</span><span class="hl-10">fooId</span><span class="hl-1">;</span><br/><span class="hl-10">fooId</span><span class="hl-1"> === </span><span class="hl-2">&quot;123&quot;</span><span class="hl-1"> </span><span class="hl-9">// false</span><br/><span class="hl-10">fooId</span><span class="hl-1"> === </span><span class="hl-16">123</span><span class="hl-1"> </span><span class="hl-9">// true</span>
132
+ </code><button type="button">Copy</button></pre>
133
+
134
+ <h4 id="examples" class="tsd-anchor-link">
135
+ Examples<a
136
+ href="#examples"
137
+ aria-label="Permalink"
138
+ class="tsd-anchor-icon"
139
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
140
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
141
+ ></a>
142
+ </h4>
143
+ <p>
144
+ This example encodes an array of integers as a dash-delimited
145
+ string to be used in the URL.
146
+ </p>
147
+ <p>
148
+ If we call
149
+ <code>$state.go('foo', { fooIds: [20, 30, 40] });</code>, the URL
150
+ changes to <code>/foo/20-30-40</code>. If we navigate to
151
+ <code>/foo/1-2-3</code>, the <code>foo</code> state's onEnter logs
152
+ <code>[1, 2, 3]</code>.
153
+ </p>
154
+ </div>
155
+ <div class="tsd-comment tsd-typography">
156
+ <div class="tsd-tag-example">
157
+ <h4 class="tsd-anchor-link" id="example">
158
+ Example<a
159
+ href="#example"
160
+ aria-label="Permalink"
161
+ class="tsd-anchor-icon"
162
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
163
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
164
+ ></a>
165
+ </h4>
166
+ <pre><code><br/><span class="hl-10">$urlMatcherFactoryProvider</span><span class="hl-1">.</span><span class="hl-0">type</span><span class="hl-1">(</span><span class="hl-2">&#39;intarray&#39;</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-9">// Take an array of ints [1,2,3] and return a string &quot;1-2-3&quot;</span><br/><span class="hl-1"> </span><span class="hl-0">encode</span><span class="hl-10">:</span><span class="hl-1"> (</span><span class="hl-10">array</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-10">array</span><span class="hl-1">.</span><span class="hl-0">join</span><span class="hl-1">(</span><span class="hl-2">&quot;-&quot;</span><span class="hl-1">),</span><br/><br/><span class="hl-1"> </span><span class="hl-9">// Take an string &quot;1-2-3&quot; and return an array of ints [1,2,3]</span><br/><span class="hl-1"> </span><span class="hl-0">decode</span><span class="hl-10">:</span><span class="hl-1"> (</span><span class="hl-10">str</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-10">str</span><span class="hl-1">.</span><span class="hl-0">split</span><span class="hl-1">(</span><span class="hl-2">&quot;-&quot;</span><span class="hl-1">).</span><span class="hl-0">map</span><span class="hl-1">(</span><span class="hl-10">x</span><span class="hl-1"> </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-0">parseInt</span><span class="hl-1">(</span><span class="hl-10">x</span><span class="hl-1">, </span><span class="hl-16">10</span><span class="hl-1">)),</span><br/><br/><span class="hl-1"> </span><span class="hl-9">// Match the encoded string in the URL</span><br/><span class="hl-1"> </span><span class="hl-10">pattern:</span><span class="hl-1"> </span><span class="hl-11">new</span><span class="hl-1"> </span><span class="hl-0">RegExp</span><span class="hl-1">(</span><span class="hl-2">&quot;[0-9]+(?:-[0-9]+)*&quot;</span><span class="hl-1">)</span><br/><br/><span class="hl-1"> </span><span class="hl-9">// Ensure that the (decoded) object is an array, and that all its elements are numbers</span><br/><span class="hl-1"> </span><span class="hl-10">is</span><span class="hl-1">: (</span><span class="hl-10">obj</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-10">Array</span><span class="hl-1">.</span><span class="hl-0">isArray</span><span class="hl-1">(</span><span class="hl-10">obj</span><span class="hl-1">) &amp;&amp;</span><br/><span class="hl-1"> </span><span class="hl-10">obj</span><span class="hl-1">.</span><span class="hl-0">reduce</span><span class="hl-1">((</span><span class="hl-10">acc</span><span class="hl-1">, </span><span class="hl-10">item</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-10">acc</span><span class="hl-1"> &amp;&amp; </span><span class="hl-11">typeof</span><span class="hl-1"> </span><span class="hl-10">item</span><span class="hl-1"> === </span><span class="hl-2">&#39;number&#39;</span><span class="hl-1">, </span><span class="hl-11">true</span><span class="hl-1">),</span><br/><br/><span class="hl-1"> </span><span class="hl-9">// Compare two arrays of integers</span><br/><span class="hl-1"> </span><span class="hl-0">equals</span><span class="hl-10">:</span><span class="hl-1"> (</span><span class="hl-10">array1</span><span class="hl-1">, </span><span class="hl-10">array2</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-10">array1</span><span class="hl-1">.</span><span class="hl-10">length</span><span class="hl-1"> === </span><span class="hl-10">array2</span><span class="hl-1">.</span><span class="hl-10">length</span><span class="hl-1"> &amp;&amp;</span><br/><span class="hl-1"> </span><span class="hl-10">array1</span><span class="hl-1">.</span><span class="hl-0">reduce</span><span class="hl-1">((</span><span class="hl-10">acc</span><span class="hl-1">, </span><span class="hl-10">item</span><span class="hl-1">, </span><span class="hl-10">idx</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-10">acc</span><span class="hl-1"> &amp;&amp; </span><span class="hl-10">item</span><span class="hl-1"> === </span><span class="hl-10">array2</span><span class="hl-1">[</span><span class="hl-10">idx</span><span class="hl-1">], </span><span class="hl-11">true</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-10">$stateProvider</span><span class="hl-1">.</span><span class="hl-0">state</span><span class="hl-1">(</span><span class="hl-2">&#39;foo&#39;</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-10">url:</span><span class="hl-1"> </span><span class="hl-2">&quot;/foo/{fooIds:intarray}&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">onEnter</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">$transition$</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-10">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-10">$transition$</span><span class="hl-1">.</span><span class="hl-10">fooIds</span><span class="hl-1">); </span><span class="hl-9">// Logs &quot;[1, 2, 3]&quot;</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span>
167
+ </code><button>Copy</button></pre>
168
+
169
+ <p>
170
+ This example decodes an integer from the URL. It uses the
171
+ integer as an index to look up an item from a static list. That
172
+ item from the list is the decoded parameter value.
173
+ </p>
174
+ </div>
175
+ <div class="tsd-tag-example">
176
+ <h4 class="tsd-anchor-link" id="example-1">
177
+ Example<a
178
+ href="#example-1"
179
+ aria-label="Permalink"
180
+ class="tsd-anchor-icon"
181
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
182
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
183
+ ></a>
184
+ </h4>
185
+ <pre><code><br/><span class="hl-11">var</span><span class="hl-1"> </span><span class="hl-10">list</span><span class="hl-1"> = [</span><span class="hl-2">&#39;John&#39;</span><span class="hl-1">, </span><span class="hl-2">&#39;Paul&#39;</span><span class="hl-1">, </span><span class="hl-2">&#39;George&#39;</span><span class="hl-1">, </span><span class="hl-2">&#39;Ringo&#39;</span><span class="hl-1">];</span><br/><br/><span class="hl-10">$urlMatcherFactoryProvider</span><span class="hl-1">.</span><span class="hl-0">type</span><span class="hl-1">(</span><span class="hl-2">&#39;listItem&#39;</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-0">encode</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">item</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-9">// Represent the list item in the URL using its corresponding index</span><br/><span class="hl-1"> </span><span class="hl-8">return</span><span class="hl-1"> </span><span class="hl-10">list</span><span class="hl-1">.</span><span class="hl-0">indexOf</span><span class="hl-1">(</span><span class="hl-10">item</span><span class="hl-1">);</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-0">decode</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">item</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-9">// Look up the list item by index</span><br/><span class="hl-1"> </span><span class="hl-8">return</span><span class="hl-1"> </span><span class="hl-10">list</span><span class="hl-1">[</span><span class="hl-0">parseInt</span><span class="hl-1">(</span><span class="hl-10">item</span><span class="hl-1">, </span><span class="hl-16">10</span><span class="hl-1">)];</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-0">is</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">item</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-9">// Ensure the item is valid by checking to see that it appears</span><br/><span class="hl-1"> </span><span class="hl-9">// in the list</span><br/><span class="hl-1"> </span><span class="hl-8">return</span><span class="hl-1"> </span><span class="hl-10">list</span><span class="hl-1">.</span><span class="hl-0">indexOf</span><span class="hl-1">(</span><span class="hl-10">item</span><span class="hl-1">) &gt; -</span><span class="hl-16">1</span><span class="hl-1">;</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-10">$stateProvider</span><span class="hl-1">.</span><span class="hl-0">state</span><span class="hl-1">(</span><span class="hl-2">&#39;list&#39;</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-10">url:</span><span class="hl-1"> </span><span class="hl-2">&quot;/list/{item:listItem}&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">controller</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">$scope</span><span class="hl-1">, </span><span class="hl-10">$stateParams</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-10">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-10">$stateParams</span><span class="hl-1">.</span><span class="hl-10">item</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-9">// ...</span><br/><br/><span class="hl-9">// Changes URL to &#39;/list/3&#39;, logs &quot;Ringo&quot; to the console</span><br/><span class="hl-10">$state</span><span class="hl-1">.</span><span class="hl-0">go</span><span class="hl-1">(</span><span class="hl-2">&#39;list&#39;</span><span class="hl-1">, { </span><span class="hl-10">item:</span><span class="hl-1"> </span><span class="hl-2">&quot;Ringo&quot;</span><span class="hl-1"> });</span>
186
+ </code><button>Copy</button></pre>
187
+
188
+ <p>See: [[UrlConfig.type]]</p>
189
+ </div>
190
+ </div>
191
+ </section>
192
+ <div class="tsd-signature">
193
+ <span class="tsd-signature-keyword">interface</span>
194
+ <span class="tsd-kind-interface">ParamTypeDefinition</span>
195
+ <span class="tsd-signature-symbol">{</span><br />    <a
196
+ class="tsd-kind-property"
197
+ href="#dynamic"
198
+ >dynamic</a
199
+ ><span class="tsd-signature-symbol">?:</span>
200
+ <span class="tsd-signature-type">boolean</span
201
+ ><span class="tsd-signature-symbol">;</span><br />    <a
202
+ class="tsd-kind-property"
203
+ href="#inherit"
204
+ >inherit</a
205
+ ><span class="tsd-signature-symbol">?:</span>
206
+ <span class="tsd-signature-type">boolean</span
207
+ ><span class="tsd-signature-symbol">;</span><br />    <a
208
+ class="tsd-kind-property"
209
+ href="#pattern"
210
+ >pattern</a
211
+ ><span class="tsd-signature-symbol">?:</span>
212
+ <span class="tsd-signature-type">RegExp</span
213
+ ><span class="tsd-signature-symbol">;</span><br />    <a
214
+ class="tsd-kind-property"
215
+ href="#raw"
216
+ >raw</a
217
+ ><span class="tsd-signature-symbol">?:</span>
218
+ <span class="tsd-signature-type">boolean</span
219
+ ><span class="tsd-signature-symbol">;</span><br />    <a
220
+ class="tsd-kind-call-signature"
221
+ href="#decode-1"
222
+ >decode</a
223
+ ><span class="tsd-signature-symbol">(</span
224
+ ><span class="tsd-kind-parameter">val</span
225
+ ><span class="tsd-signature-symbol">:</span>
226
+ <span class="tsd-signature-type">string</span
227
+ ><span class="tsd-signature-symbol">,</span>
228
+ <span class="tsd-kind-parameter">key</span
229
+ ><span class="tsd-signature-symbol">?:</span>
230
+ <span class="tsd-signature-type">string</span
231
+ ><span class="tsd-signature-symbol">)</span
232
+ ><span class="tsd-signature-symbol">:</span>
233
+ <span class="tsd-signature-type">any</span
234
+ ><span class="tsd-signature-symbol">;</span><br />    <a
235
+ class="tsd-kind-call-signature"
236
+ href="#encode-1"
237
+ >encode</a
238
+ ><span class="tsd-signature-symbol">(</span
239
+ ><span class="tsd-kind-parameter">val</span
240
+ ><span class="tsd-signature-symbol">:</span>
241
+ <span class="tsd-signature-type">any</span
242
+ ><span class="tsd-signature-symbol">,</span>
243
+ <span class="tsd-kind-parameter">key</span
244
+ ><span class="tsd-signature-symbol">?:</span>
245
+ <span class="tsd-signature-type">string</span
246
+ ><span class="tsd-signature-symbol">)</span
247
+ ><span class="tsd-signature-symbol">:</span>
248
+ <span class="tsd-signature-type">string</span>
249
+ <span class="tsd-signature-symbol">|</span>
250
+ <span class="tsd-signature-type">string</span
251
+ ><span class="tsd-signature-symbol">[]</span
252
+ ><span class="tsd-signature-symbol">;</span><br />    <a
253
+ class="tsd-kind-call-signature"
254
+ href="#equals-1"
255
+ >equals</a
256
+ ><span class="tsd-signature-symbol">(</span
257
+ ><span class="tsd-kind-parameter">a</span
258
+ ><span class="tsd-signature-symbol">:</span>
259
+ <span class="tsd-signature-type">any</span
260
+ ><span class="tsd-signature-symbol">,</span>
261
+ <span class="tsd-kind-parameter">b</span
262
+ ><span class="tsd-signature-symbol">:</span>
263
+ <span class="tsd-signature-type">any</span
264
+ ><span class="tsd-signature-symbol">)</span
265
+ ><span class="tsd-signature-symbol">:</span>
266
+ <span class="tsd-signature-type">boolean</span
267
+ ><span class="tsd-signature-symbol">;</span><br />    <a
268
+ class="tsd-kind-call-signature"
269
+ href="#is-1"
270
+ >is</a
271
+ ><span class="tsd-signature-symbol">(</span
272
+ ><span class="tsd-kind-parameter">val</span
273
+ ><span class="tsd-signature-symbol">:</span>
274
+ <span class="tsd-signature-type">any</span
275
+ ><span class="tsd-signature-symbol">,</span>
276
+ <span class="tsd-kind-parameter">key</span
277
+ ><span class="tsd-signature-symbol">?:</span>
278
+ <span class="tsd-signature-type">string</span
279
+ ><span class="tsd-signature-symbol">)</span
280
+ ><span class="tsd-signature-symbol">:</span>
281
+ <span class="tsd-signature-type">boolean</span
282
+ ><span class="tsd-signature-symbol">;</span><br /><span
283
+ class="tsd-signature-symbol"
284
+ >}</span
285
+ >
286
+ </div>
287
+ <aside class="tsd-sources">
288
+ <ul>
289
+ <li>
290
+ Defined in
291
+ <a
292
+ href="https://github.com/Angular-Wave/angular.ts/blob/e14e445af22a0918c5aea3160db49b26512bc6c0/src/router/params/interface.ts#L479"
293
+ >src/router/params/interface.ts:479</a
294
+ >
295
+ </li>
296
+ </ul>
297
+ </aside>
298
+ <section class="tsd-panel-group tsd-index-group">
299
+ <section class="tsd-panel tsd-index-panel">
300
+ <details class="tsd-index-content tsd-accordion" open>
301
+ <summary class="tsd-accordion-summary tsd-index-summary">
302
+ <svg
303
+ width="20"
304
+ height="20"
305
+ viewBox="0 0 24 24"
306
+ fill="none"
307
+ aria-hidden="true"
308
+ >
309
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
310
+ </svg>
311
+ <h5 class="tsd-index-heading uppercase">Index</h5>
312
+ </summary>
313
+ <div class="tsd-accordion-details">
314
+ <section class="tsd-index-section">
315
+ <h3 class="tsd-index-heading">Properties</h3>
316
+ <div class="tsd-index-list">
317
+ <a href="#dynamic" class="tsd-index-link"
318
+ ><svg
319
+ class="tsd-kind-icon"
320
+ viewBox="0 0 24 24"
321
+ aria-label="Property"
322
+ >
323
+ <use href="../assets/icons.svg#icon-1024"></use></svg
324
+ ><span>dynamic?</span></a
325
+ >
326
+ <a href="#inherit" class="tsd-index-link"
327
+ ><svg
328
+ class="tsd-kind-icon"
329
+ viewBox="0 0 24 24"
330
+ aria-label="Property"
331
+ >
332
+ <use href="../assets/icons.svg#icon-1024"></use></svg
333
+ ><span>inherit?</span></a
334
+ >
335
+ <a href="#pattern" class="tsd-index-link"
336
+ ><svg
337
+ class="tsd-kind-icon"
338
+ viewBox="0 0 24 24"
339
+ aria-label="Property"
340
+ >
341
+ <use href="../assets/icons.svg#icon-1024"></use></svg
342
+ ><span>pattern?</span></a
343
+ >
344
+ <a href="#raw" class="tsd-index-link"
345
+ ><svg
346
+ class="tsd-kind-icon"
347
+ viewBox="0 0 24 24"
348
+ aria-label="Property"
349
+ >
350
+ <use href="../assets/icons.svg#icon-1024"></use></svg
351
+ ><span>raw?</span></a
352
+ >
353
+ </div>
354
+ </section>
355
+ <section class="tsd-index-section">
356
+ <h3 class="tsd-index-heading">Methods</h3>
357
+ <div class="tsd-index-list">
358
+ <a href="#decode" class="tsd-index-link"
359
+ ><svg
360
+ class="tsd-kind-icon"
361
+ viewBox="0 0 24 24"
362
+ aria-label="Method"
363
+ >
364
+ <use href="../assets/icons.svg#icon-2048"></use></svg
365
+ ><span>decode</span></a
366
+ >
367
+ <a href="#encode" class="tsd-index-link"
368
+ ><svg
369
+ class="tsd-kind-icon"
370
+ viewBox="0 0 24 24"
371
+ aria-label="Method"
372
+ >
373
+ <use href="../assets/icons.svg#icon-2048"></use></svg
374
+ ><span>encode</span></a
375
+ >
376
+ <a href="#equals" class="tsd-index-link"
377
+ ><svg
378
+ class="tsd-kind-icon"
379
+ viewBox="0 0 24 24"
380
+ aria-label="Method"
381
+ >
382
+ <use href="../assets/icons.svg#icon-2048"></use></svg
383
+ ><span>equals</span></a
384
+ >
385
+ <a href="#is" class="tsd-index-link"
386
+ ><svg
387
+ class="tsd-kind-icon"
388
+ viewBox="0 0 24 24"
389
+ aria-label="Method"
390
+ >
391
+ <use href="../assets/icons.svg#icon-2048"></use></svg
392
+ ><span>is</span></a
393
+ >
394
+ </div>
395
+ </section>
396
+ </div>
397
+ </details>
398
+ </section>
399
+ </section>
400
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open>
401
+ <summary class="tsd-accordion-summary" data-key="section-Properties">
402
+ <svg
403
+ width="20"
404
+ height="20"
405
+ viewBox="0 0 24 24"
406
+ fill="none"
407
+ aria-hidden="true"
408
+ >
409
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
410
+ </svg>
411
+ <h2>Properties</h2>
412
+ </summary>
413
+ <section>
414
+ <section class="tsd-panel tsd-member">
415
+ <h3 class="tsd-anchor-link" id="dynamic">
416
+ <code class="tsd-tag">Optional</code><span>dynamic</span
417
+ ><a
418
+ href="#dynamic"
419
+ aria-label="Permalink"
420
+ class="tsd-anchor-icon"
421
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
422
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
423
+ ></a>
424
+ </h3>
425
+ <div class="tsd-signature">
426
+ <span class="tsd-kind-property">dynamic</span
427
+ ><span class="tsd-signature-symbol">?:</span>
428
+ <span class="tsd-signature-type">boolean</span>
429
+ </div>
430
+ <div class="tsd-comment tsd-typography">
431
+ <p>Dynamic flag</p>
432
+ <p>
433
+ When <code>dynamic</code> is <code>true</code>, changes to the
434
+ parameter value will not cause the state to be entered/exited.
435
+ </p>
436
+ <p>
437
+ Normally, if a parameter value changes, the state which
438
+ declared that the parameter will be reloaded (entered/exited).
439
+ When a parameter is <code>dynamic</code>, a transition still
440
+ occurs, but it does not cause the state to exit/enter.
441
+ </p>
442
+ <p>Default: <code>false</code></p>
443
+ </div>
444
+ <div class="tsd-comment tsd-typography"></div>
445
+ <aside class="tsd-sources">
446
+ <ul>
447
+ <li>
448
+ Defined in
449
+ <a
450
+ href="https://github.com/Angular-Wave/angular.ts/blob/e14e445af22a0918c5aea3160db49b26512bc6c0/src/router/params/interface.ts#L546"
451
+ >src/router/params/interface.ts:546</a
452
+ >
453
+ </li>
454
+ </ul>
455
+ </aside>
456
+ </section>
457
+ <section class="tsd-panel tsd-member">
458
+ <h3 class="tsd-anchor-link" id="inherit">
459
+ <code class="tsd-tag">Optional</code><span>inherit</span
460
+ ><a
461
+ href="#inherit"
462
+ aria-label="Permalink"
463
+ class="tsd-anchor-icon"
464
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
465
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
466
+ ></a>
467
+ </h3>
468
+ <div class="tsd-signature">
469
+ <span class="tsd-kind-property">inherit</span
470
+ ><span class="tsd-signature-symbol">?:</span>
471
+ <span class="tsd-signature-type">boolean</span>
472
+ </div>
473
+ <div class="tsd-comment tsd-typography">
474
+ <p>
475
+ Enables/disables inheriting of parameter values (of this type)
476
+ </p>
477
+ <p>
478
+ When a transition is run with [[TransitionOptions.inherit]]
479
+ set to <code>true</code>, the current param values are
480
+ inherited in the new transition. However, parameters whose
481
+ type has <code>inherit: false</code> set will
482
+ <em>not be inherited</em>.
483
+ </p>
484
+ <p>
485
+ The internal parameter type of <code>hash</code> has
486
+ <code>inherit: false</code>. This is used to disable
487
+ inheriting of the hash value (<code>#</code>) on subsequent
488
+ transitions.
489
+ </p>
490
+ <h4 id="example-2" class="tsd-anchor-link">
491
+ Example:<a
492
+ href="#example-2"
493
+ aria-label="Permalink"
494
+ class="tsd-anchor-icon"
495
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
496
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
497
+ ></a>
498
+ </h4>
499
+ <pre><code class="js"><span class="hl-10">$state</span><span class="hl-1">.</span><span class="hl-0">go</span><span class="hl-1">(</span><span class="hl-2">&#39;home&#39;</span><span class="hl-1">, { </span><span class="hl-2">&#39;#&#39;</span><span class="hl-10">:</span><span class="hl-1"> </span><span class="hl-2">&#39;inboxAnchor&#39;</span><span class="hl-1"> });</span><br/><span class="hl-1">...</span><br/><span class="hl-9">// &quot;#&quot; is not inherited.</span><br/><span class="hl-9">// The value of the &quot;#&quot; parameter will be `null`</span><br/><span class="hl-9">// The url&#39;s hash will be cleared.</span><br/><span class="hl-10">$state</span><span class="hl-1">.</span><span class="hl-0">go</span><span class="hl-1">(</span><span class="hl-2">&#39;home.nest&#39;</span><span class="hl-1">);</span>
500
+ </code><button type="button">Copy</button></pre>
501
+
502
+ <hr />
503
+ <p>
504
+ See also [[TransitionOptions.inherit]] and
505
+ [[ParamDeclaration.inherit]]
506
+ </p>
507
+ </div>
508
+ <div class="tsd-comment tsd-typography"></div>
509
+ <aside class="tsd-sources">
510
+ <ul>
511
+ <li>
512
+ Defined in
513
+ <a
514
+ href="https://github.com/Angular-Wave/angular.ts/blob/e14e445af22a0918c5aea3160db49b26512bc6c0/src/router/params/interface.ts#L534"
515
+ >src/router/params/interface.ts:534</a
516
+ >
517
+ </li>
518
+ </ul>
519
+ </aside>
520
+ </section>
521
+ <section class="tsd-panel tsd-member">
522
+ <h3 class="tsd-anchor-link" id="pattern">
523
+ <code class="tsd-tag">Optional</code><span>pattern</span
524
+ ><a
525
+ href="#pattern"
526
+ aria-label="Permalink"
527
+ class="tsd-anchor-icon"
528
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
529
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
530
+ ></a>
531
+ </h3>
532
+ <div class="tsd-signature">
533
+ <span class="tsd-kind-property">pattern</span
534
+ ><span class="tsd-signature-symbol">?:</span>
535
+ <span class="tsd-signature-type">RegExp</span>
536
+ </div>
537
+ <div class="tsd-comment tsd-typography">
538
+ <p>
539
+ A regular expression that matches the encoded parameter type
540
+ </p>
541
+ <p>
542
+ This regular expression is used to match an encoded parameter
543
+ value <strong>in the URL</strong>.
544
+ </p>
545
+ <p>
546
+ For example, if your type encodes as a dash-separated numbers,
547
+ match that here:
548
+ <code>new RegExp(&quot;[0-9]+(?:-[0-9]+)*&quot;)</code>.
549
+ </p>
550
+ <p>There are some limitations to these regexps:</p>
551
+ <ul>
552
+ <li>
553
+ No capturing groups are allowed (use non-capturing groups:
554
+ <code>(?: )</code>)
555
+ </li>
556
+ <li>No pattern modifiers like case insensitive</li>
557
+ <li>
558
+ No start-of-string or end-of-string: <code>/^foo$/</code>
559
+ </li>
560
+ </ul>
561
+ </div>
562
+ <div class="tsd-comment tsd-typography"></div>
563
+ <aside class="tsd-sources">
564
+ <ul>
565
+ <li>
566
+ Defined in
567
+ <a
568
+ href="https://github.com/Angular-Wave/angular.ts/blob/e14e445af22a0918c5aea3160db49b26512bc6c0/src/router/params/interface.ts#L494"
569
+ >src/router/params/interface.ts:494</a
570
+ >
571
+ </li>
572
+ </ul>
573
+ </aside>
574
+ </section>
575
+ <section class="tsd-panel tsd-member">
576
+ <h3 class="tsd-anchor-link" id="raw">
577
+ <code class="tsd-tag">Optional</code><span>raw</span
578
+ ><a href="#raw" aria-label="Permalink" class="tsd-anchor-icon"
579
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
580
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
581
+ ></a>
582
+ </h3>
583
+ <div class="tsd-signature">
584
+ <span class="tsd-kind-property">raw</span
585
+ ><span class="tsd-signature-symbol">?:</span>
586
+ <span class="tsd-signature-type">boolean</span>
587
+ </div>
588
+ <div class="tsd-comment tsd-typography">
589
+ <p>Disables url-encoding of parameter values</p>
590
+ <p>
591
+ If a parameter type is declared <code>raw</code>, it will not
592
+ be url-encoded. Custom encoding can still be applied in the
593
+ [[encode]] function.
594
+ </p>
595
+ <h3 id="decoding-warning" class="tsd-anchor-link">
596
+ Decoding warning<a
597
+ href="#decoding-warning"
598
+ aria-label="Permalink"
599
+ class="tsd-anchor-icon"
600
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
601
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
602
+ ></a>
603
+ </h3>
604
+ <p>
605
+ The decoding behavior of raw parameters is not defined. See:
606
+ [[ParamDeclaration.raw]] for details
607
+ </p>
608
+ </div>
609
+ <div class="tsd-comment tsd-typography"></div>
610
+ <aside class="tsd-sources">
611
+ <ul>
612
+ <li>
613
+ Defined in
614
+ <a
615
+ href="https://github.com/Angular-Wave/angular.ts/blob/e14e445af22a0918c5aea3160db49b26512bc6c0/src/router/params/interface.ts#L507"
616
+ >src/router/params/interface.ts:507</a
617
+ >
618
+ </li>
619
+ </ul>
620
+ </aside>
621
+ </section>
622
+ </section>
623
+ </details>
624
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open>
625
+ <summary class="tsd-accordion-summary" data-key="section-Methods">
626
+ <svg
627
+ width="20"
628
+ height="20"
629
+ viewBox="0 0 24 24"
630
+ fill="none"
631
+ aria-hidden="true"
632
+ >
633
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
634
+ </svg>
635
+ <h2>Methods</h2>
636
+ </summary>
637
+ <section>
638
+ <section class="tsd-panel tsd-member">
639
+ <h3 class="tsd-anchor-link" id="decode">
640
+ <span>decode</span
641
+ ><a
642
+ href="#decode"
643
+ aria-label="Permalink"
644
+ class="tsd-anchor-icon"
645
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
646
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
647
+ ></a>
648
+ </h3>
649
+ <ul class="tsd-signatures">
650
+ <li class="">
651
+ <div class="tsd-signature tsd-anchor-link" id="decode-1">
652
+ <span class="tsd-kind-call-signature">decode</span
653
+ ><span class="tsd-signature-symbol">(</span
654
+ ><span class="tsd-kind-parameter">val</span
655
+ ><span class="tsd-signature-symbol">:</span>
656
+ <span class="tsd-signature-type">string</span
657
+ ><span class="tsd-signature-symbol">,</span>
658
+ <span class="tsd-kind-parameter">key</span
659
+ ><span class="tsd-signature-symbol">?:</span>
660
+ <span class="tsd-signature-type">string</span
661
+ ><span class="tsd-signature-symbol">)</span
662
+ ><span class="tsd-signature-symbol">:</span>
663
+ <span class="tsd-signature-type">any</span
664
+ ><a
665
+ href="#decode-1"
666
+ aria-label="Permalink"
667
+ class="tsd-anchor-icon"
668
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
669
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
670
+ ></a>
671
+ </div>
672
+ <div class="tsd-description">
673
+ <div class="tsd-comment tsd-typography">
674
+ <p>
675
+ Decodes a parameter value string (from URL string or
676
+ transition param) to a custom/native value.
677
+ </p>
678
+ <p>
679
+ For example, if your type decodes to an array of ints,
680
+ then decode the string as an array of ints here:
681
+ </p>
682
+ <pre><code class="js"><span class="hl-15">decode</span><span class="hl-1">: (</span><span class="hl-10">str</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-10">str</span><span class="hl-1">.</span><span class="hl-0">split</span><span class="hl-1">(</span><span class="hl-2">&quot;-&quot;</span><span class="hl-1">).</span><span class="hl-0">map</span><span class="hl-1">(</span><span class="hl-10">str</span><span class="hl-1"> </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-0">parseInt</span><span class="hl-1">(</span><span class="hl-10">str</span><span class="hl-1">, </span><span class="hl-16">10</span><span class="hl-1">))</span>
683
+ </code><button type="button">Copy</button></pre>
684
+
685
+ <p>
686
+ Note: in general, [[encode]] and [[decode]] should be
687
+ symmetrical. That is,
688
+ <code>encode(decode(str)) === str</code>
689
+ </p>
690
+ </div>
691
+ <div class="tsd-parameters">
692
+ <h4 class="tsd-parameters-title">Parameters</h4>
693
+ <ul class="tsd-parameter-list">
694
+ <li>
695
+ <span
696
+ ><span class="tsd-kind-parameter">val</span>:
697
+ <span class="tsd-signature-type">string</span></span
698
+ >
699
+ <div class="tsd-comment tsd-typography">
700
+ <p>The URL parameter value to decode.</p>
701
+ </div>
702
+ <div class="tsd-comment tsd-typography"></div>
703
+ </li>
704
+ <li>
705
+ <span
706
+ ><code class="tsd-tag">Optional</code
707
+ ><span class="tsd-kind-parameter">key</span>:
708
+ <span class="tsd-signature-type">string</span></span
709
+ >
710
+ <div class="tsd-comment tsd-typography">
711
+ <p>
712
+ The name of the parameter in which
713
+ <code>val</code> is stored. Can be used for
714
+ meta-programming of
715
+ <code>ParamType</code> objects.
716
+ </p>
717
+ </div>
718
+ <div class="tsd-comment tsd-typography"></div>
719
+ </li>
720
+ </ul>
721
+ </div>
722
+ <h4 class="tsd-returns-title">
723
+ Returns <span class="tsd-signature-type">any</span>
724
+ </h4>
725
+ <p>a custom representation of the URL parameter value.</p>
726
+ <div class="tsd-comment tsd-typography"></div>
727
+ <aside class="tsd-sources">
728
+ <ul>
729
+ <li>
730
+ Defined in
731
+ <a
732
+ href="https://github.com/Angular-Wave/angular.ts/blob/e14e445af22a0918c5aea3160db49b26512bc6c0/src/router/params/interface.ts#L611"
733
+ >src/router/params/interface.ts:611</a
734
+ >
735
+ </li>
736
+ </ul>
737
+ </aside>
738
+ </div>
739
+ </li>
740
+ </ul>
741
+ </section>
742
+ <section class="tsd-panel tsd-member">
743
+ <h3 class="tsd-anchor-link" id="encode">
744
+ <span>encode</span
745
+ ><a
746
+ href="#encode"
747
+ aria-label="Permalink"
748
+ class="tsd-anchor-icon"
749
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
750
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
751
+ ></a>
752
+ </h3>
753
+ <ul class="tsd-signatures">
754
+ <li class="">
755
+ <div class="tsd-signature tsd-anchor-link" id="encode-1">
756
+ <span class="tsd-kind-call-signature">encode</span
757
+ ><span class="tsd-signature-symbol">(</span
758
+ ><span class="tsd-kind-parameter">val</span
759
+ ><span class="tsd-signature-symbol">:</span>
760
+ <span class="tsd-signature-type">any</span
761
+ ><span class="tsd-signature-symbol">,</span>
762
+ <span class="tsd-kind-parameter">key</span
763
+ ><span class="tsd-signature-symbol">?:</span>
764
+ <span class="tsd-signature-type">string</span
765
+ ><span class="tsd-signature-symbol">)</span
766
+ ><span class="tsd-signature-symbol">:</span>
767
+ <span class="tsd-signature-type">string</span>
768
+ <span class="tsd-signature-symbol">|</span>
769
+ <span class="tsd-signature-type">string</span
770
+ ><span class="tsd-signature-symbol">[]</span
771
+ ><a
772
+ href="#encode-1"
773
+ aria-label="Permalink"
774
+ class="tsd-anchor-icon"
775
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
776
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
777
+ ></a>
778
+ </div>
779
+ <div class="tsd-description">
780
+ <div class="tsd-comment tsd-typography">
781
+ <p>
782
+ Encodes a custom/native type value to a string that can
783
+ be embedded in a URL.
784
+ </p>
785
+ <p>
786
+ Note that the return value does <em>not</em> need to be
787
+ URL-safe (i.e. passed through
788
+ <code>encodeURIComponent()</code>). It only needs to be
789
+ a representation of <code>val</code> that has been
790
+ encoded as a string.
791
+ </p>
792
+ <p>
793
+ For example, if your custom type decodes to an array of
794
+ ints, then encode the array of ints to a string here:
795
+ </p>
796
+ <pre><code class="js"><span class="hl-15">encode</span><span class="hl-1">: (</span><span class="hl-10">intarray</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-10">intarray</span><span class="hl-1">.</span><span class="hl-0">join</span><span class="hl-1">(</span><span class="hl-2">&quot;-&quot;</span><span class="hl-1">)</span>
797
+ </code><button type="button">Copy</button></pre>
798
+
799
+ <p>
800
+ Note: in general, [[encode]] and [[decode]] should be
801
+ symmetrical. That is,
802
+ <code>encode(decode(str)) === str</code>
803
+ </p>
804
+ </div>
805
+ <div class="tsd-parameters">
806
+ <h4 class="tsd-parameters-title">Parameters</h4>
807
+ <ul class="tsd-parameter-list">
808
+ <li>
809
+ <span
810
+ ><span class="tsd-kind-parameter">val</span>:
811
+ <span class="tsd-signature-type">any</span></span
812
+ >
813
+ <div class="tsd-comment tsd-typography">
814
+ <p>The value to encode.</p>
815
+ </div>
816
+ <div class="tsd-comment tsd-typography"></div>
817
+ </li>
818
+ <li>
819
+ <span
820
+ ><code class="tsd-tag">Optional</code
821
+ ><span class="tsd-kind-parameter">key</span>:
822
+ <span class="tsd-signature-type">string</span></span
823
+ >
824
+ <div class="tsd-comment tsd-typography">
825
+ <p>
826
+ The name of the parameter in which
827
+ <code>val</code> is stored. Can be used for
828
+ meta-programming of
829
+ <code>ParamType</code> objects.
830
+ </p>
831
+ </div>
832
+ <div class="tsd-comment tsd-typography"></div>
833
+ </li>
834
+ </ul>
835
+ </div>
836
+ <h4 class="tsd-returns-title">
837
+ Returns <span class="tsd-signature-type">string</span>
838
+ <span class="tsd-signature-symbol">|</span>
839
+ <span class="tsd-signature-type">string</span
840
+ ><span class="tsd-signature-symbol">[]</span>
841
+ </h4>
842
+ <p>
843
+ a string representation of <code>val</code> that can be
844
+ encoded in a URL.
845
+ </p>
846
+ <div class="tsd-comment tsd-typography"></div>
847
+ <aside class="tsd-sources">
848
+ <ul>
849
+ <li>
850
+ Defined in
851
+ <a
852
+ href="https://github.com/Angular-Wave/angular.ts/blob/e14e445af22a0918c5aea3160db49b26512bc6c0/src/router/params/interface.ts#L595"
853
+ >src/router/params/interface.ts:595</a
854
+ >
855
+ </li>
856
+ </ul>
857
+ </aside>
858
+ </div>
859
+ </li>
860
+ </ul>
861
+ </section>
862
+ <section class="tsd-panel tsd-member">
863
+ <h3 class="tsd-anchor-link" id="equals">
864
+ <span>equals</span
865
+ ><a
866
+ href="#equals"
867
+ aria-label="Permalink"
868
+ class="tsd-anchor-icon"
869
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
870
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
871
+ ></a>
872
+ </h3>
873
+ <ul class="tsd-signatures">
874
+ <li class="">
875
+ <div class="tsd-signature tsd-anchor-link" id="equals-1">
876
+ <span class="tsd-kind-call-signature">equals</span
877
+ ><span class="tsd-signature-symbol">(</span
878
+ ><span class="tsd-kind-parameter">a</span
879
+ ><span class="tsd-signature-symbol">:</span>
880
+ <span class="tsd-signature-type">any</span
881
+ ><span class="tsd-signature-symbol">,</span>
882
+ <span class="tsd-kind-parameter">b</span
883
+ ><span class="tsd-signature-symbol">:</span>
884
+ <span class="tsd-signature-type">any</span
885
+ ><span class="tsd-signature-symbol">)</span
886
+ ><span class="tsd-signature-symbol">:</span>
887
+ <span class="tsd-signature-type">boolean</span
888
+ ><a
889
+ href="#equals-1"
890
+ aria-label="Permalink"
891
+ class="tsd-anchor-icon"
892
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
893
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
894
+ ></a>
895
+ </div>
896
+ <div class="tsd-description">
897
+ <div class="tsd-comment tsd-typography">
898
+ <p>
899
+ Determines whether two decoded values are equivalent.
900
+ </p>
901
+ <p>
902
+ For example, if your type decodes to an array of ints,
903
+ then check if the arrays are equal:
904
+ </p>
905
+ <pre><code class="js"><span class="hl-15">equals</span><span class="hl-1">: (</span><span class="hl-10">a</span><span class="hl-1">, </span><span class="hl-10">b</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-10">a</span><span class="hl-1">.</span><span class="hl-10">length</span><span class="hl-1"> === </span><span class="hl-10">b</span><span class="hl-1">.</span><span class="hl-10">length</span><span class="hl-1"> &amp;&amp; </span><span class="hl-10">a</span><span class="hl-1">.</span><span class="hl-0">reduce</span><span class="hl-1">((</span><span class="hl-10">acc</span><span class="hl-1">, </span><span class="hl-10">x</span><span class="hl-1">, </span><span class="hl-10">idx</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-10">acc</span><span class="hl-1"> &amp;&amp; </span><span class="hl-10">x</span><span class="hl-1"> === </span><span class="hl-10">b</span><span class="hl-1">[</span><span class="hl-10">idx</span><span class="hl-1">], </span><span class="hl-11">true</span><span class="hl-1">)</span>
906
+ </code><button type="button">Copy</button></pre>
907
+ </div>
908
+ <div class="tsd-parameters">
909
+ <h4 class="tsd-parameters-title">Parameters</h4>
910
+ <ul class="tsd-parameter-list">
911
+ <li>
912
+ <span
913
+ ><span class="tsd-kind-parameter">a</span>:
914
+ <span class="tsd-signature-type">any</span></span
915
+ >
916
+ <div class="tsd-comment tsd-typography">
917
+ <p>A value to compare against.</p>
918
+ </div>
919
+ <div class="tsd-comment tsd-typography"></div>
920
+ </li>
921
+ <li>
922
+ <span
923
+ ><span class="tsd-kind-parameter">b</span>:
924
+ <span class="tsd-signature-type">any</span></span
925
+ >
926
+ <div class="tsd-comment tsd-typography">
927
+ <p>A value to compare against.</p>
928
+ </div>
929
+ <div class="tsd-comment tsd-typography"></div>
930
+ </li>
931
+ </ul>
932
+ </div>
933
+ <h4 class="tsd-returns-title">
934
+ Returns <span class="tsd-signature-type">boolean</span>
935
+ </h4>
936
+ <p>
937
+ <code>true</code> if the values are equivalent/equal,
938
+ otherwise <code>false</code>.
939
+ </p>
940
+ <div class="tsd-comment tsd-typography"></div>
941
+ <aside class="tsd-sources">
942
+ <ul>
943
+ <li>
944
+ Defined in
945
+ <a
946
+ href="https://github.com/Angular-Wave/angular.ts/blob/e14e445af22a0918c5aea3160db49b26512bc6c0/src/router/params/interface.ts#L625"
947
+ >src/router/params/interface.ts:625</a
948
+ >
949
+ </li>
950
+ </ul>
951
+ </aside>
952
+ </div>
953
+ </li>
954
+ </ul>
955
+ </section>
956
+ <section class="tsd-panel tsd-member">
957
+ <h3 class="tsd-anchor-link" id="is">
958
+ <span>is</span
959
+ ><a href="#is" aria-label="Permalink" class="tsd-anchor-icon"
960
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
961
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
962
+ ></a>
963
+ </h3>
964
+ <ul class="tsd-signatures">
965
+ <li class="">
966
+ <div class="tsd-signature tsd-anchor-link" id="is-1">
967
+ <span class="tsd-kind-call-signature">is</span
968
+ ><span class="tsd-signature-symbol">(</span
969
+ ><span class="tsd-kind-parameter">val</span
970
+ ><span class="tsd-signature-symbol">:</span>
971
+ <span class="tsd-signature-type">any</span
972
+ ><span class="tsd-signature-symbol">,</span>
973
+ <span class="tsd-kind-parameter">key</span
974
+ ><span class="tsd-signature-symbol">?:</span>
975
+ <span class="tsd-signature-type">string</span
976
+ ><span class="tsd-signature-symbol">)</span
977
+ ><span class="tsd-signature-symbol">:</span>
978
+ <span class="tsd-signature-type">boolean</span
979
+ ><a
980
+ href="#is-1"
981
+ aria-label="Permalink"
982
+ class="tsd-anchor-icon"
983
+ ><svg viewBox="0 0 24 24" aria-hidden="true">
984
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
985
+ ></a>
986
+ </div>
987
+ <div class="tsd-description">
988
+ <div class="tsd-comment tsd-typography">
989
+ <p>
990
+ Tests if some object type is compatible with this
991
+ parameter type
992
+ </p>
993
+ <p>
994
+ Detects whether some value is of this particular type.
995
+ Accepts a decoded value and determines whether it
996
+ matches this <code>ParamType</code> object.
997
+ </p>
998
+ <p>
999
+ If your custom type encodes the parameter to a specific
1000
+ type, check for that type here. For example, if your
1001
+ custom type decodes the URL parameter value as an array
1002
+ of ints, return true if the input is an array of ints:
1003
+ </p>
1004
+ <pre><code><span class="hl-15">is</span><span class="hl-1">: (</span><span class="hl-10">val</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-10">Array</span><span class="hl-1">.</span><span class="hl-0">isArray</span><span class="hl-1">(</span><span class="hl-10">val</span><span class="hl-1">) &amp;&amp; </span><span class="hl-10">array</span><span class="hl-1">.</span><span class="hl-0">reduce</span><span class="hl-1">((</span><span class="hl-10">acc</span><span class="hl-1">, </span><span class="hl-10">x</span><span class="hl-1">) </span><span class="hl-11">=&gt;</span><span class="hl-1"> </span><span class="hl-10">acc</span><span class="hl-1"> &amp;&amp; </span><span class="hl-0">parseInt</span><span class="hl-1">(</span><span class="hl-10">val</span><span class="hl-1">, </span><span class="hl-16">10</span><span class="hl-1">) === </span><span class="hl-10">val</span><span class="hl-1">, </span><span class="hl-11">true</span><span class="hl-1">)</span>
1005
+ </code><button>Copy</button></pre>
1006
+
1007
+ <p>
1008
+ If your type decodes the URL parameter value to a custom
1009
+ string, check that the string matches the pattern (don't
1010
+ use an arrow fn if you need <code>this</code>):
1011
+ <code
1012
+ >function (val) { return !!this.pattern.exec(val)
1013
+ }</code
1014
+ >
1015
+ </p>
1016
+ <p>
1017
+ Note: This method is
1018
+ <em>not used to check if the URL matches</em>. It's used
1019
+ to check if a
1020
+ <em>decoded value <em>is</em> this type</em>. Use
1021
+ [[pattern]] to check the encoded value in the URL.
1022
+ </p>
1023
+ </div>
1024
+ <div class="tsd-parameters">
1025
+ <h4 class="tsd-parameters-title">Parameters</h4>
1026
+ <ul class="tsd-parameter-list">
1027
+ <li>
1028
+ <span
1029
+ ><span class="tsd-kind-parameter">val</span>:
1030
+ <span class="tsd-signature-type">any</span></span
1031
+ >
1032
+ <div class="tsd-comment tsd-typography">
1033
+ <p>The value to check.</p>
1034
+ </div>
1035
+ <div class="tsd-comment tsd-typography"></div>
1036
+ </li>
1037
+ <li>
1038
+ <span
1039
+ ><code class="tsd-tag">Optional</code
1040
+ ><span class="tsd-kind-parameter">key</span>:
1041
+ <span class="tsd-signature-type">string</span></span
1042
+ >
1043
+ <div class="tsd-comment tsd-typography">
1044
+ <p>
1045
+ If the type check is happening in the context of a
1046
+ specific [[UrlMatcher]] object, this is the name
1047
+ of the parameter in which <code>val</code> is
1048
+ stored. Can be used for meta-programming of
1049
+ <code>ParamType</code> objects.
1050
+ </p>
1051
+ </div>
1052
+ <div class="tsd-comment tsd-typography"></div>
1053
+ </li>
1054
+ </ul>
1055
+ </div>
1056
+ <h4 class="tsd-returns-title">
1057
+ Returns <span class="tsd-signature-type">boolean</span>
1058
+ </h4>
1059
+ <p>
1060
+ <code>true</code> if the value matches the type, otherwise
1061
+ <code>false</code>.
1062
+ </p>
1063
+ <div class="tsd-comment tsd-typography"></div>
1064
+ <aside class="tsd-sources">
1065
+ <ul>
1066
+ <li>
1067
+ Defined in
1068
+ <a
1069
+ href="https://github.com/Angular-Wave/angular.ts/blob/e14e445af22a0918c5aea3160db49b26512bc6c0/src/router/params/interface.ts#L575"
1070
+ >src/router/params/interface.ts:575</a
1071
+ >
1072
+ </li>
1073
+ </ul>
1074
+ </aside>
1075
+ </div>
1076
+ </li>
1077
+ </ul>
1078
+ </section>
1079
+ </section>
1080
+ </details>
1081
+ </div>
1082
+ <div class="col-sidebar">
1083
+ <div class="page-menu">
1084
+ <div class="tsd-navigation settings">
1085
+ <details class="tsd-accordion">
1086
+ <summary class="tsd-accordion-summary">
1087
+ <svg
1088
+ width="20"
1089
+ height="20"
1090
+ viewBox="0 0 24 24"
1091
+ fill="none"
1092
+ aria-hidden="true"
1093
+ >
1094
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
1095
+ </svg>
1096
+ <h3>Settings</h3>
1097
+ </summary>
1098
+ <div class="tsd-accordion-details">
1099
+ <div class="tsd-filter-visibility">
1100
+ <span class="settings-label">Member Visibility</span>
1101
+ <ul id="tsd-filter-options">
1102
+ <li class="tsd-filter-item">
1103
+ <label class="tsd-filter-input"
1104
+ ><input
1105
+ type="checkbox"
1106
+ id="tsd-filter-protected"
1107
+ name="protected"
1108
+ /><svg
1109
+ width="32"
1110
+ height="32"
1111
+ viewBox="0 0 32 32"
1112
+ aria-hidden="true"
1113
+ >
1114
+ <rect
1115
+ class="tsd-checkbox-background"
1116
+ width="30"
1117
+ height="30"
1118
+ x="1"
1119
+ y="1"
1120
+ rx="6"
1121
+ fill="none"
1122
+ ></rect>
1123
+ <path
1124
+ class="tsd-checkbox-checkmark"
1125
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
1126
+ stroke="none"
1127
+ stroke-width="3.5"
1128
+ stroke-linejoin="round"
1129
+ fill="none"
1130
+ ></path></svg
1131
+ ><span>Protected</span></label
1132
+ >
1133
+ </li>
1134
+ <li class="tsd-filter-item">
1135
+ <label class="tsd-filter-input"
1136
+ ><input
1137
+ type="checkbox"
1138
+ id="tsd-filter-inherited"
1139
+ name="inherited"
1140
+ checked
1141
+ /><svg
1142
+ width="32"
1143
+ height="32"
1144
+ viewBox="0 0 32 32"
1145
+ aria-hidden="true"
1146
+ >
1147
+ <rect
1148
+ class="tsd-checkbox-background"
1149
+ width="30"
1150
+ height="30"
1151
+ x="1"
1152
+ y="1"
1153
+ rx="6"
1154
+ fill="none"
1155
+ ></rect>
1156
+ <path
1157
+ class="tsd-checkbox-checkmark"
1158
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
1159
+ stroke="none"
1160
+ stroke-width="3.5"
1161
+ stroke-linejoin="round"
1162
+ fill="none"
1163
+ ></path></svg
1164
+ ><span>Inherited</span></label
1165
+ >
1166
+ </li>
1167
+ <li class="tsd-filter-item">
1168
+ <label class="tsd-filter-input"
1169
+ ><input
1170
+ type="checkbox"
1171
+ id="tsd-filter-external"
1172
+ name="external"
1173
+ /><svg
1174
+ width="32"
1175
+ height="32"
1176
+ viewBox="0 0 32 32"
1177
+ aria-hidden="true"
1178
+ >
1179
+ <rect
1180
+ class="tsd-checkbox-background"
1181
+ width="30"
1182
+ height="30"
1183
+ x="1"
1184
+ y="1"
1185
+ rx="6"
1186
+ fill="none"
1187
+ ></rect>
1188
+ <path
1189
+ class="tsd-checkbox-checkmark"
1190
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
1191
+ stroke="none"
1192
+ stroke-width="3.5"
1193
+ stroke-linejoin="round"
1194
+ fill="none"
1195
+ ></path></svg
1196
+ ><span>External</span></label
1197
+ >
1198
+ </li>
1199
+ </ul>
1200
+ </div>
1201
+ <div class="tsd-theme-toggle">
1202
+ <label class="settings-label" for="tsd-theme">Theme</label
1203
+ ><select id="tsd-theme">
1204
+ <option value="os">OS</option>
1205
+ <option value="light">Light</option>
1206
+ <option value="dark">Dark</option>
1207
+ </select>
1208
+ </div>
1209
+ </div>
1210
+ </details>
1211
+ </div>
1212
+ <details open class="tsd-accordion tsd-page-navigation">
1213
+ <summary class="tsd-accordion-summary">
1214
+ <svg
1215
+ width="20"
1216
+ height="20"
1217
+ viewBox="0 0 24 24"
1218
+ fill="none"
1219
+ aria-hidden="true"
1220
+ >
1221
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
1222
+ </svg>
1223
+ <h3>On This Page</h3>
1224
+ </summary>
1225
+ <div class="tsd-accordion-details">
1226
+ <a href="#examples"><span>Examples</span></a>
1227
+ <details open class="tsd-accordion tsd-page-navigation-section">
1228
+ <summary
1229
+ class="tsd-accordion-summary"
1230
+ data-key="section-Properties"
1231
+ >
1232
+ <svg
1233
+ width="20"
1234
+ height="20"
1235
+ viewBox="0 0 24 24"
1236
+ fill="none"
1237
+ aria-hidden="true"
1238
+ >
1239
+ <use href="../assets/icons.svg#icon-chevronDown"></use></svg
1240
+ >Properties
1241
+ </summary>
1242
+ <div>
1243
+ <a href="#dynamic"
1244
+ ><svg
1245
+ class="tsd-kind-icon"
1246
+ viewBox="0 0 24 24"
1247
+ aria-label="Property"
1248
+ >
1249
+ <use href="../assets/icons.svg#icon-1024"></use></svg
1250
+ ><span>dynamic</span></a
1251
+ ><a href="#inherit"
1252
+ ><svg
1253
+ class="tsd-kind-icon"
1254
+ viewBox="0 0 24 24"
1255
+ aria-label="Property"
1256
+ >
1257
+ <use href="../assets/icons.svg#icon-1024"></use></svg
1258
+ ><span>inherit</span></a
1259
+ >
1260
+ <ul>
1261
+ <li>
1262
+ <ul>
1263
+ <li>
1264
+ <ul>
1265
+ <li>
1266
+ <ul>
1267
+ <li>
1268
+ <a href="#example-2"><span>Example:</span></a>
1269
+ </li>
1270
+ </ul>
1271
+ </li>
1272
+ </ul>
1273
+ </li>
1274
+ </ul>
1275
+ </li>
1276
+ </ul>
1277
+ <a href="#pattern"
1278
+ ><svg
1279
+ class="tsd-kind-icon"
1280
+ viewBox="0 0 24 24"
1281
+ aria-label="Property"
1282
+ >
1283
+ <use href="../assets/icons.svg#icon-1024"></use></svg
1284
+ ><span>pattern</span></a
1285
+ ><a href="#raw"
1286
+ ><svg
1287
+ class="tsd-kind-icon"
1288
+ viewBox="0 0 24 24"
1289
+ aria-label="Property"
1290
+ >
1291
+ <use href="../assets/icons.svg#icon-1024"></use></svg
1292
+ ><span>raw</span></a
1293
+ >
1294
+ <ul>
1295
+ <li>
1296
+ <a href="#decoding-warning"
1297
+ ><span>Decoding warning</span></a
1298
+ >
1299
+ </li>
1300
+ </ul>
1301
+ </div>
1302
+ </details>
1303
+ <details open class="tsd-accordion tsd-page-navigation-section">
1304
+ <summary
1305
+ class="tsd-accordion-summary"
1306
+ data-key="section-Methods"
1307
+ >
1308
+ <svg
1309
+ width="20"
1310
+ height="20"
1311
+ viewBox="0 0 24 24"
1312
+ fill="none"
1313
+ aria-hidden="true"
1314
+ >
1315
+ <use href="../assets/icons.svg#icon-chevronDown"></use></svg
1316
+ >Methods
1317
+ </summary>
1318
+ <div>
1319
+ <a href="#decode"
1320
+ ><svg
1321
+ class="tsd-kind-icon"
1322
+ viewBox="0 0 24 24"
1323
+ aria-label="Method"
1324
+ >
1325
+ <use href="../assets/icons.svg#icon-2048"></use></svg
1326
+ ><span>decode</span></a
1327
+ ><a href="#encode"
1328
+ ><svg
1329
+ class="tsd-kind-icon"
1330
+ viewBox="0 0 24 24"
1331
+ aria-label="Method"
1332
+ >
1333
+ <use href="../assets/icons.svg#icon-2048"></use></svg
1334
+ ><span>encode</span></a
1335
+ ><a href="#equals"
1336
+ ><svg
1337
+ class="tsd-kind-icon"
1338
+ viewBox="0 0 24 24"
1339
+ aria-label="Method"
1340
+ >
1341
+ <use href="../assets/icons.svg#icon-2048"></use></svg
1342
+ ><span>equals</span></a
1343
+ ><a href="#is"
1344
+ ><svg
1345
+ class="tsd-kind-icon"
1346
+ viewBox="0 0 24 24"
1347
+ aria-label="Method"
1348
+ >
1349
+ <use href="../assets/icons.svg#icon-2048"></use></svg
1350
+ ><span>is</span></a
1351
+ >
1352
+ </div>
1353
+ </details>
1354
+ </div>
1355
+ </details>
1356
+ </div>
1357
+ <div class="site-menu">
1358
+ <nav class="tsd-navigation">
1359
+ <a href="../modules.html">@angular-wave/angular.ts</a>
1360
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
1361
+ <li>Loading...</li>
1362
+ </ul>
1363
+ </nav>
1364
+ </div>
1365
+ </div>
1366
+ </div>
1367
+ <footer>
1368
+ <p class="tsd-generator">
1369
+ Generated using
1370
+ <a href="https://typedoc.org/" target="_blank">TypeDoc</a>
1371
+ </p>
1372
+ </footer>
1373
+ <div class="overlay"></div>
1374
+ </body>
1375
+ </html>