@rxap/forms 19.0.1-dev.4 → 19.0.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 (555) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +24 -25
  3. package/compodoc/changelog.html +9 -0
  4. package/compodoc/dependencies.html +8 -8
  5. package/compodoc/index.html +26 -17
  6. package/compodoc/js/search/search_index.js +2 -2
  7. package/compodoc/miscellaneous/variables.html +26 -0
  8. package/compodoc/properties.html +4 -1
  9. package/docs/documentation.json +13986 -15658
  10. package/docs/html/assets/hierarchy.js +1 -0
  11. package/docs/{assets → html/assets}/highlight.css +27 -20
  12. package/docs/html/assets/icons.js +18 -0
  13. package/docs/html/assets/icons.svg +1 -0
  14. package/docs/{assets → html/assets}/main.js +5 -4
  15. package/docs/html/assets/navigation.js +1 -0
  16. package/docs/html/assets/search.js +1 -0
  17. package/docs/html/assets/style.css +1611 -0
  18. package/docs/html/classes/ControlValueAccessor.html +46 -0
  19. package/docs/html/classes/FormArrayControlManager.html +4 -0
  20. package/docs/html/classes/FormControlErrorDirective.html +14 -0
  21. package/docs/html/classes/FormControlMarkDirtyDirective.html +3 -0
  22. package/docs/html/classes/FormControlMarkPristineDirective.html +3 -0
  23. package/docs/html/classes/FormControlMarkTouchedDirective.html +3 -0
  24. package/docs/html/classes/FormControlMarkUntouchedDirective.html +3 -0
  25. package/docs/html/classes/FormControlNameDirective.html +122 -0
  26. package/docs/html/classes/FormDirective.html +198 -0
  27. package/docs/html/classes/FormGroupNameDirective.html +110 -0
  28. package/docs/html/classes/FormLoadedDirective.html +9 -0
  29. package/docs/html/classes/FormLoadingDirective.html +9 -0
  30. package/docs/html/classes/FormLoadingErrorDirective.html +9 -0
  31. package/docs/html/classes/FormResetDirective.html +7 -0
  32. package/docs/html/classes/FormSubmitDirective.html +13 -0
  33. package/docs/html/classes/FormSubmitFailedDirective.html +9 -0
  34. package/docs/html/classes/FormSubmitInvalidDirective.html +9 -0
  35. package/docs/html/classes/FormSubmitSuccessfulDirective.html +9 -0
  36. package/docs/html/classes/FormSubmittingDirective.html +9 -0
  37. package/docs/html/classes/ParentControlContainerDirective.html +2 -0
  38. package/docs/html/classes/RxapFormArray.html +528 -0
  39. package/docs/html/classes/RxapFormBuilder.html +3 -0
  40. package/docs/html/classes/RxapFormControl.html +453 -0
  41. package/docs/html/classes/RxapFormGroup.html +499 -0
  42. package/docs/html/classes/RxapFormsModule.html +2 -0
  43. package/docs/html/enums/MetadataKeys.html +9 -0
  44. package/docs/html/functions/ControlAsyncValidator.html +1 -0
  45. package/docs/html/functions/ControlChange.html +1 -0
  46. package/docs/html/functions/ControlSetValue.html +1 -0
  47. package/docs/html/functions/ControlValidator.html +1 -0
  48. package/docs/html/functions/IsArray.html +1 -0
  49. package/docs/html/functions/IsBoolean.html +1 -0
  50. package/docs/html/functions/IsComplex.html +1 -0
  51. package/docs/html/functions/IsDate.html +1 -0
  52. package/docs/html/functions/IsEmail.html +1 -0
  53. package/docs/html/functions/IsEnum.html +1 -0
  54. package/docs/html/functions/IsIP.html +1 -0
  55. package/docs/html/functions/IsInt.html +1 -0
  56. package/docs/html/functions/IsNumber-1.html +2 -0
  57. package/docs/html/functions/IsObject.html +1 -0
  58. package/docs/html/functions/IsPhoneNumber.html +1 -0
  59. package/docs/html/functions/IsPort.html +1 -0
  60. package/docs/html/functions/IsString.html +1 -0
  61. package/docs/html/functions/IsUUID.html +1 -0
  62. package/docs/html/functions/IsUrl.html +1 -0
  63. package/docs/html/functions/RxapForm.html +1 -0
  64. package/docs/html/functions/ToFormMethod.html +1 -0
  65. package/docs/html/functions/ToFormSubmitMethod.html +3 -0
  66. package/docs/html/functions/ToMethodWithInjectionContext.html +1 -0
  67. package/docs/html/functions/ToMethodWithInjectionContextFactory.html +1 -0
  68. package/docs/html/functions/UseFormArrayControl.html +1 -0
  69. package/docs/html/functions/UseFormArrayGroup.html +1 -0
  70. package/docs/html/functions/UseFormControl.html +1 -0
  71. package/docs/html/functions/UseFormGroup.html +1 -0
  72. package/docs/html/functions/_IsNumber.html +1 -0
  73. package/docs/html/functions/controlDisabledWhile.html +1 -0
  74. package/docs/html/functions/controlDisabled_.html +1 -0
  75. package/docs/html/functions/controlEnabledWhile.html +1 -0
  76. package/docs/html/functions/controlEnabled_.html +1 -0
  77. package/docs/html/functions/controlErrorChanges_.html +1 -0
  78. package/docs/html/functions/controlReadonly_.html +1 -0
  79. package/docs/html/functions/controlStatusChanges_.html +1 -0
  80. package/docs/html/functions/controlValueChanges_.html +1 -0
  81. package/docs/html/functions/disableControl.html +1 -0
  82. package/docs/html/functions/enableControl.html +1 -0
  83. package/docs/html/functions/hasErrorAndDirty.html +1 -0
  84. package/docs/html/functions/hasErrorAndTouched.html +1 -0
  85. package/docs/html/functions/isNumber.html +2 -0
  86. package/docs/html/functions/markAllDirty.html +1 -0
  87. package/docs/html/functions/markAllPristine.html +1 -0
  88. package/docs/html/functions/markAllUntouched.html +1 -0
  89. package/docs/html/functions/mergeControlValidators.html +1 -0
  90. package/docs/html/functions/selectControlValue_.html +1 -0
  91. package/docs/html/functions/validateControlOn.html +1 -0
  92. package/docs/html/hierarchy.html +1 -0
  93. package/docs/html/index.html +33 -0
  94. package/docs/html/interfaces/AbstractControl.html +387 -0
  95. package/docs/html/interfaces/AbstractControlOptions.html +7 -0
  96. package/docs/html/interfaces/BoxedValue.html +3 -0
  97. package/docs/html/interfaces/ComplexityOptions.html +11 -0
  98. package/docs/html/interfaces/ControlOptions.html +20 -0
  99. package/docs/html/interfaces/ControlSetValueOptions.html +3 -0
  100. package/docs/html/interfaces/FormArrayOptions.html +16 -0
  101. package/docs/html/interfaces/FormDefinition.html +13 -0
  102. package/docs/html/interfaces/FormDefinitionArray.html +176 -0
  103. package/docs/html/interfaces/FormDefinitionMetadata.html +17 -0
  104. package/docs/html/interfaces/FormGroupOptions.html +13 -0
  105. package/docs/html/interfaces/FormLoadFailedMethod.html +3 -0
  106. package/docs/html/interfaces/FormLoadMethod.html +3 -0
  107. package/docs/html/interfaces/FormLoadSuccessfulMethod.html +3 -0
  108. package/docs/html/interfaces/FormOptions.html +13 -0
  109. package/docs/html/interfaces/FormSubmitFailedMethod.html +3 -0
  110. package/docs/html/interfaces/FormSubmitMethod.html +3 -0
  111. package/docs/html/interfaces/FormSubmitSuccessfulMethod.html +3 -0
  112. package/docs/html/interfaces/InjectableValidator.html +3 -0
  113. package/docs/html/interfaces/IsNumberOptions.html +6 -0
  114. package/docs/html/interfaces/NgValidatorsErrors.html +8 -0
  115. package/docs/html/interfaces/RxapAbstractControlOptionsWithDefinition.html +13 -0
  116. package/docs/html/interfaces/_RxapAbstractControlOptions.html +12 -0
  117. package/docs/html/modules.html +1 -0
  118. package/docs/html/types/AsyncValidator.html +1 -0
  119. package/docs/html/types/AsyncValidatorFn.html +1 -0
  120. package/docs/html/types/ChangeFn.html +1 -0
  121. package/docs/html/types/ControlEventOptions.html +1 -0
  122. package/docs/html/types/ControlInsertedFn.html +1 -0
  123. package/docs/html/types/ControlPath.html +1 -0
  124. package/docs/html/types/ControlRemovedFn.html +1 -0
  125. package/docs/html/types/ControlState.html +1 -0
  126. package/docs/html/types/EmitEvent.html +1 -0
  127. package/docs/html/types/ExtractAbstractControl.html +1 -0
  128. package/docs/html/types/ExtractStrings.html +1 -0
  129. package/docs/html/types/FormBuilderFn.html +1 -0
  130. package/docs/html/types/FormType.html +1 -0
  131. package/docs/html/types/KeyValueControls.html +1 -0
  132. package/docs/html/types/OnlySelf.html +1 -0
  133. package/docs/html/types/OrBoxedValue.html +1 -0
  134. package/docs/html/types/RxapAbstractControlOptions.html +1 -0
  135. package/docs/html/types/SetValueFn.html +1 -0
  136. package/docs/html/types/ValidationErrors.html +1 -0
  137. package/docs/html/types/Validator.html +1 -0
  138. package/docs/html/types/ValidatorFn.html +1 -0
  139. package/docs/html/types/ValidatorOrOpts.html +1 -0
  140. package/docs/html/variables/RXAP_FORM_CONTEXT.html +1 -0
  141. package/docs/html/variables/RXAP_FORM_DEFINITION.html +1 -0
  142. package/docs/html/variables/RXAP_FORM_DEFINITION_BUILDER.html +1 -0
  143. package/docs/html/variables/RXAP_FORM_INITIAL_STATE.html +1 -0
  144. package/docs/html/variables/RXAP_FORM_LOAD_FAILED_METHOD.html +1 -0
  145. package/docs/html/variables/RXAP_FORM_LOAD_METHOD.html +1 -0
  146. package/docs/html/variables/RXAP_FORM_LOAD_SUCCESSFUL_METHOD.html +1 -0
  147. package/docs/html/variables/RXAP_FORM_SUBMIT_FAILED_METHOD.html +1 -0
  148. package/docs/html/variables/RXAP_FORM_SUBMIT_METHOD.html +1 -0
  149. package/docs/html/variables/RXAP_FORM_SUBMIT_SUCCESSFUL_METHOD.html +1 -0
  150. package/docs/html/variables/RxapValidators.html +1 -0
  151. package/docs/markdown/README.md +37 -0
  152. package/docs/markdown/classes/ControlValueAccessor.md +230 -0
  153. package/docs/markdown/classes/FormArrayControlManager.md +75 -0
  154. package/docs/markdown/classes/FormControlErrorDirective.md +101 -0
  155. package/docs/markdown/classes/FormControlMarkDirtyDirective.md +39 -0
  156. package/docs/markdown/classes/FormControlMarkPristineDirective.md +39 -0
  157. package/docs/markdown/classes/FormControlMarkTouchedDirective.md +39 -0
  158. package/docs/markdown/classes/FormControlMarkUntouchedDirective.md +39 -0
  159. package/docs/markdown/classes/FormControlNameDirective.md +816 -0
  160. package/docs/markdown/classes/FormDirective.md +1596 -0
  161. package/docs/markdown/classes/FormGroupNameDirective.md +707 -0
  162. package/docs/markdown/classes/FormLoadedDirective.md +79 -0
  163. package/docs/markdown/classes/FormLoadingDirective.md +79 -0
  164. package/docs/markdown/classes/FormLoadingErrorDirective.md +79 -0
  165. package/docs/markdown/classes/FormResetDirective.md +115 -0
  166. package/docs/markdown/classes/FormSubmitDirective.md +178 -0
  167. package/docs/markdown/classes/FormSubmitFailedDirective.md +79 -0
  168. package/docs/markdown/classes/FormSubmitInvalidDirective.md +79 -0
  169. package/docs/markdown/classes/FormSubmitSuccessfulDirective.md +79 -0
  170. package/docs/markdown/classes/FormSubmittingDirective.md +79 -0
  171. package/docs/markdown/classes/ParentControlContainerDirective.md +19 -0
  172. package/docs/markdown/classes/RxapFormArray.md +2645 -0
  173. package/docs/markdown/classes/RxapFormBuilder.md +67 -0
  174. package/docs/markdown/classes/RxapFormControl.md +2204 -0
  175. package/docs/markdown/classes/RxapFormGroup.md +3002 -0
  176. package/docs/markdown/classes/RxapFormsModule.md +19 -0
  177. package/docs/markdown/enumerations/MetadataKeys.md +73 -0
  178. package/docs/markdown/functions/ControlAsyncValidator.md +35 -0
  179. package/docs/markdown/functions/ControlChange.md +35 -0
  180. package/docs/markdown/functions/ControlSetValue.md +39 -0
  181. package/docs/markdown/functions/ControlValidator.md +35 -0
  182. package/docs/markdown/functions/IsArray.md +33 -0
  183. package/docs/markdown/functions/IsBoolean.md +33 -0
  184. package/docs/markdown/functions/IsComplex.md +37 -0
  185. package/docs/markdown/functions/IsDate.md +33 -0
  186. package/docs/markdown/functions/IsEmail.md +37 -0
  187. package/docs/markdown/functions/IsEnum.md +37 -0
  188. package/docs/markdown/functions/IsIP.md +37 -0
  189. package/docs/markdown/functions/IsInt.md +37 -0
  190. package/docs/markdown/functions/IsNumber-2.md +25 -0
  191. package/docs/markdown/functions/IsNumber.md +37 -0
  192. package/docs/markdown/functions/IsObject.md +33 -0
  193. package/docs/markdown/functions/IsPhoneNumber.md +41 -0
  194. package/docs/markdown/functions/IsPort.md +33 -0
  195. package/docs/markdown/functions/IsString.md +33 -0
  196. package/docs/markdown/functions/IsUUID.md +37 -0
  197. package/docs/markdown/functions/IsUrl.md +37 -0
  198. package/docs/markdown/functions/RxapForm.md +39 -0
  199. package/docs/markdown/functions/ToFormMethod.md +31 -0
  200. package/docs/markdown/functions/ToFormSubmitMethod.md +31 -0
  201. package/docs/markdown/functions/ToMethodWithInjectionContext.md +37 -0
  202. package/docs/markdown/functions/ToMethodWithInjectionContextFactory.md +43 -0
  203. package/docs/markdown/functions/UseFormArrayControl.md +35 -0
  204. package/docs/markdown/functions/UseFormArrayGroup.md +39 -0
  205. package/docs/markdown/functions/UseFormControl.md +35 -0
  206. package/docs/markdown/functions/UseFormGroup.md +39 -0
  207. package/docs/markdown/functions/controlDisabled$.md +25 -0
  208. package/docs/markdown/functions/controlDisabledWhile.md +33 -0
  209. package/docs/markdown/functions/controlEnabled$.md +25 -0
  210. package/docs/markdown/functions/controlEnabledWhile.md +33 -0
  211. package/docs/markdown/functions/controlErrorChanges$.md +25 -0
  212. package/docs/markdown/functions/controlReadonly$.md +25 -0
  213. package/docs/markdown/functions/controlStatusChanges$.md +25 -0
  214. package/docs/markdown/functions/controlValueChanges$.md +25 -0
  215. package/docs/markdown/functions/disableControl.md +33 -0
  216. package/docs/markdown/functions/enableControl.md +33 -0
  217. package/docs/markdown/functions/hasErrorAndDirty.md +33 -0
  218. package/docs/markdown/functions/hasErrorAndTouched.md +33 -0
  219. package/docs/markdown/functions/isNumber-1.md +27 -0
  220. package/docs/markdown/functions/markAllDirty.md +25 -0
  221. package/docs/markdown/functions/markAllPristine.md +25 -0
  222. package/docs/markdown/functions/markAllUntouched.md +25 -0
  223. package/docs/markdown/functions/mergeControlValidators.md +31 -0
  224. package/docs/markdown/functions/selectControlValue$.md +31 -0
  225. package/docs/markdown/functions/validateControlOn.md +29 -0
  226. package/docs/markdown/globals.md +153 -0
  227. package/docs/markdown/interfaces/AbstractControl.md +1691 -0
  228. package/docs/markdown/interfaces/AbstractControlOptions.md +67 -0
  229. package/docs/markdown/interfaces/BoxedValue.md +29 -0
  230. package/docs/markdown/interfaces/ComplexityOptions.md +89 -0
  231. package/docs/markdown/interfaces/ControlOptions.md +85 -0
  232. package/docs/markdown/interfaces/ControlSetValueOptions.md +25 -0
  233. package/docs/markdown/interfaces/FormArrayOptions.md +157 -0
  234. package/docs/markdown/interfaces/FormDefinition.md +80 -0
  235. package/docs/markdown/interfaces/FormDefinitionArray.md +1443 -0
  236. package/docs/markdown/interfaces/FormDefinitionMetadata.md +156 -0
  237. package/docs/markdown/interfaces/FormGroupOptions.md +133 -0
  238. package/docs/markdown/interfaces/FormLoadFailedMethod.md +47 -0
  239. package/docs/markdown/interfaces/FormLoadMethod.md +45 -0
  240. package/docs/markdown/interfaces/FormLoadSuccessfulMethod.md +51 -0
  241. package/docs/markdown/interfaces/FormOptions.md +137 -0
  242. package/docs/markdown/interfaces/FormSubmitFailedMethod.md +47 -0
  243. package/docs/markdown/interfaces/FormSubmitMethod.md +55 -0
  244. package/docs/markdown/interfaces/FormSubmitSuccessfulMethod.md +51 -0
  245. package/docs/markdown/interfaces/InjectableValidator.md +25 -0
  246. package/docs/markdown/interfaces/IsNumberOptions.md +43 -0
  247. package/docs/markdown/interfaces/NgValidatorsErrors.md +105 -0
  248. package/docs/markdown/interfaces/RxapAbstractControlOptions.md +103 -0
  249. package/docs/markdown/interfaces/RxapAbstractControlOptionsWithDefinition.md +133 -0
  250. package/docs/markdown/type-aliases/AsyncValidator.md +11 -0
  251. package/docs/markdown/type-aliases/AsyncValidatorFn.md +27 -0
  252. package/docs/markdown/type-aliases/ChangeFn.md +29 -0
  253. package/docs/markdown/type-aliases/ControlEventOptions.md +11 -0
  254. package/docs/markdown/type-aliases/ControlInsertedFn.md +25 -0
  255. package/docs/markdown/type-aliases/ControlPath.md +11 -0
  256. package/docs/markdown/type-aliases/ControlRemovedFn.md +21 -0
  257. package/docs/markdown/type-aliases/ControlState.md +11 -0
  258. package/docs/markdown/type-aliases/EmitEvent.md +11 -0
  259. package/docs/markdown/type-aliases/ExtractAbstractControl.md +17 -0
  260. package/docs/markdown/type-aliases/ExtractStrings.md +15 -0
  261. package/docs/markdown/type-aliases/FormBuilderFn.md +33 -0
  262. package/docs/markdown/type-aliases/FormType.md +15 -0
  263. package/docs/markdown/type-aliases/KeyValueControls.md +15 -0
  264. package/docs/markdown/type-aliases/OnlySelf.md +11 -0
  265. package/docs/markdown/type-aliases/OrBoxedValue.md +15 -0
  266. package/docs/markdown/type-aliases/RxapAbstractControlOptions.md +15 -0
  267. package/docs/markdown/type-aliases/SetValueFn.md +29 -0
  268. package/docs/markdown/type-aliases/ValidationErrors.md +15 -0
  269. package/docs/markdown/type-aliases/Validator.md +11 -0
  270. package/docs/markdown/type-aliases/ValidatorFn.md +27 -0
  271. package/docs/markdown/type-aliases/ValidatorOrOpts.md +11 -0
  272. package/docs/markdown/variables/RXAP_FORM_CONTEXT.md +11 -0
  273. package/docs/markdown/variables/RXAP_FORM_DEFINITION.md +11 -0
  274. package/docs/markdown/variables/RXAP_FORM_DEFINITION_BUILDER.md +11 -0
  275. package/docs/markdown/variables/RXAP_FORM_INITIAL_STATE.md +11 -0
  276. package/docs/markdown/variables/RXAP_FORM_LOAD_FAILED_METHOD.md +11 -0
  277. package/docs/markdown/variables/RXAP_FORM_LOAD_METHOD.md +11 -0
  278. package/docs/markdown/variables/RXAP_FORM_LOAD_SUCCESSFUL_METHOD.md +11 -0
  279. package/docs/markdown/variables/RXAP_FORM_SUBMIT_FAILED_METHOD.md +11 -0
  280. package/docs/markdown/variables/RXAP_FORM_SUBMIT_METHOD.md +11 -0
  281. package/docs/markdown/variables/RXAP_FORM_SUBMIT_SUCCESSFUL_METHOD.md +11 -0
  282. package/docs/markdown/variables/RxapValidators.md +443 -0
  283. package/docs/wiki/Class.ControlValueAccessor.md +226 -0
  284. package/docs/wiki/Class.FormArrayControlManager.md +71 -0
  285. package/docs/wiki/Class.FormControlErrorDirective.md +97 -0
  286. package/docs/wiki/Class.FormControlMarkDirtyDirective.md +35 -0
  287. package/docs/wiki/Class.FormControlMarkPristineDirective.md +35 -0
  288. package/docs/wiki/Class.FormControlMarkTouchedDirective.md +35 -0
  289. package/docs/wiki/Class.FormControlMarkUntouchedDirective.md +35 -0
  290. package/docs/wiki/Class.FormControlNameDirective.md +812 -0
  291. package/docs/wiki/Class.FormDirective.md +1592 -0
  292. package/docs/wiki/Class.FormGroupNameDirective.md +703 -0
  293. package/docs/wiki/Class.FormLoadedDirective.md +75 -0
  294. package/docs/wiki/Class.FormLoadingDirective.md +75 -0
  295. package/docs/wiki/Class.FormLoadingErrorDirective.md +75 -0
  296. package/docs/wiki/Class.FormResetDirective.md +111 -0
  297. package/docs/wiki/Class.FormSubmitDirective.md +174 -0
  298. package/docs/wiki/Class.FormSubmitFailedDirective.md +75 -0
  299. package/docs/wiki/Class.FormSubmitInvalidDirective.md +75 -0
  300. package/docs/wiki/Class.FormSubmitSuccessfulDirective.md +75 -0
  301. package/docs/wiki/Class.FormSubmittingDirective.md +75 -0
  302. package/docs/wiki/Class.ParentControlContainerDirective.md +15 -0
  303. package/docs/wiki/Class.RxapFormArray.md +2641 -0
  304. package/docs/wiki/Class.RxapFormBuilder.md +63 -0
  305. package/docs/wiki/Class.RxapFormControl.md +2200 -0
  306. package/docs/wiki/Class.RxapFormGroup.md +2998 -0
  307. package/docs/wiki/Class.RxapFormsModule.md +15 -0
  308. package/docs/wiki/Enumeration.MetadataKeys.md +69 -0
  309. package/docs/wiki/Function.ControlAsyncValidator.md +31 -0
  310. package/docs/wiki/Function.ControlChange.md +31 -0
  311. package/docs/wiki/Function.ControlSetValue.md +35 -0
  312. package/docs/wiki/Function.ControlValidator.md +31 -0
  313. package/docs/wiki/Function.IsArray.md +29 -0
  314. package/docs/wiki/Function.IsBoolean.md +29 -0
  315. package/docs/wiki/Function.IsComplex.md +33 -0
  316. package/docs/wiki/Function.IsDate.md +29 -0
  317. package/docs/wiki/Function.IsEmail.md +33 -0
  318. package/docs/wiki/Function.IsEnum.md +33 -0
  319. package/docs/wiki/Function.IsIP.md +33 -0
  320. package/docs/wiki/Function.IsInt.md +33 -0
  321. package/docs/wiki/Function.IsNumber.md +21 -0
  322. package/docs/wiki/Function.IsObject.md +29 -0
  323. package/docs/wiki/Function.IsPhoneNumber.md +37 -0
  324. package/docs/wiki/Function.IsPort.md +29 -0
  325. package/docs/wiki/Function.IsString.md +29 -0
  326. package/docs/wiki/Function.IsUUID.md +33 -0
  327. package/docs/wiki/Function.IsUrl.md +33 -0
  328. package/docs/wiki/Function.RxapForm.md +35 -0
  329. package/docs/wiki/Function.ToFormMethod.md +27 -0
  330. package/docs/wiki/Function.ToFormSubmitMethod.md +27 -0
  331. package/docs/wiki/Function.ToMethodWithInjectionContext.md +33 -0
  332. package/docs/wiki/Function.ToMethodWithInjectionContextFactory.md +39 -0
  333. package/docs/wiki/Function.UseFormArrayControl.md +31 -0
  334. package/docs/wiki/Function.UseFormArrayGroup.md +35 -0
  335. package/docs/wiki/Function.UseFormControl.md +31 -0
  336. package/docs/wiki/Function.UseFormGroup.md +35 -0
  337. package/docs/wiki/Function._IsNumber.md +33 -0
  338. package/docs/wiki/Function.controlDisabled$.md +21 -0
  339. package/docs/wiki/Function.controlDisabledWhile.md +29 -0
  340. package/docs/wiki/Function.controlEnabled$.md +21 -0
  341. package/docs/wiki/Function.controlEnabledWhile.md +29 -0
  342. package/docs/wiki/Function.controlErrorChanges$.md +21 -0
  343. package/docs/wiki/Function.controlReadonly$.md +21 -0
  344. package/docs/wiki/Function.controlStatusChanges$.md +21 -0
  345. package/docs/wiki/Function.controlValueChanges$.md +21 -0
  346. package/docs/wiki/Function.disableControl.md +29 -0
  347. package/docs/wiki/Function.enableControl.md +29 -0
  348. package/docs/wiki/Function.hasErrorAndDirty.md +29 -0
  349. package/docs/wiki/Function.hasErrorAndTouched.md +29 -0
  350. package/docs/wiki/Function.isNumber.md +23 -0
  351. package/docs/wiki/Function.markAllDirty.md +21 -0
  352. package/docs/wiki/Function.markAllPristine.md +21 -0
  353. package/docs/wiki/Function.markAllUntouched.md +21 -0
  354. package/docs/wiki/Function.mergeControlValidators.md +27 -0
  355. package/docs/wiki/Function.selectControlValue$.md +27 -0
  356. package/docs/wiki/Function.validateControlOn.md +25 -0
  357. package/docs/wiki/Home.md +33 -0
  358. package/docs/wiki/Interface.AbstractControl.md +1687 -0
  359. package/docs/wiki/Interface.AbstractControlOptions.md +63 -0
  360. package/docs/wiki/Interface.BoxedValue.md +25 -0
  361. package/docs/wiki/Interface.ComplexityOptions.md +85 -0
  362. package/docs/wiki/Interface.ControlOptions.md +81 -0
  363. package/docs/wiki/Interface.ControlSetValueOptions.md +21 -0
  364. package/docs/wiki/Interface.FormArrayOptions.md +153 -0
  365. package/docs/wiki/Interface.FormDefinition.md +76 -0
  366. package/docs/wiki/Interface.FormDefinitionArray.md +1439 -0
  367. package/docs/wiki/Interface.FormDefinitionMetadata.md +152 -0
  368. package/docs/wiki/Interface.FormGroupOptions.md +129 -0
  369. package/docs/wiki/Interface.FormLoadFailedMethod.md +43 -0
  370. package/docs/wiki/Interface.FormLoadMethod.md +41 -0
  371. package/docs/wiki/Interface.FormLoadSuccessfulMethod.md +47 -0
  372. package/docs/wiki/Interface.FormOptions.md +133 -0
  373. package/docs/wiki/Interface.FormSubmitFailedMethod.md +43 -0
  374. package/docs/wiki/Interface.FormSubmitMethod.md +51 -0
  375. package/docs/wiki/Interface.FormSubmitSuccessfulMethod.md +47 -0
  376. package/docs/wiki/Interface.InjectableValidator.md +21 -0
  377. package/docs/wiki/Interface.IsNumberOptions.md +39 -0
  378. package/docs/wiki/Interface.NgValidatorsErrors.md +101 -0
  379. package/docs/wiki/Interface.RxapAbstractControlOptionsWithDefinition.md +129 -0
  380. package/docs/wiki/Interface._RxapAbstractControlOptions.md +99 -0
  381. package/docs/wiki/TypeAlias.AsyncValidator.md +7 -0
  382. package/docs/wiki/TypeAlias.AsyncValidatorFn.md +23 -0
  383. package/docs/wiki/TypeAlias.ChangeFn.md +25 -0
  384. package/docs/wiki/TypeAlias.ControlEventOptions.md +7 -0
  385. package/docs/wiki/TypeAlias.ControlInsertedFn.md +21 -0
  386. package/docs/wiki/TypeAlias.ControlPath.md +7 -0
  387. package/docs/wiki/TypeAlias.ControlRemovedFn.md +17 -0
  388. package/docs/wiki/TypeAlias.ControlState.md +7 -0
  389. package/docs/wiki/TypeAlias.EmitEvent.md +7 -0
  390. package/docs/wiki/TypeAlias.ExtractAbstractControl.md +13 -0
  391. package/docs/wiki/TypeAlias.ExtractStrings.md +11 -0
  392. package/docs/wiki/TypeAlias.FormBuilderFn.md +29 -0
  393. package/docs/wiki/TypeAlias.FormType.md +11 -0
  394. package/docs/wiki/TypeAlias.KeyValueControls.md +11 -0
  395. package/docs/wiki/TypeAlias.OnlySelf.md +7 -0
  396. package/docs/wiki/TypeAlias.OrBoxedValue.md +11 -0
  397. package/docs/wiki/TypeAlias.RxapAbstractControlOptions.md +11 -0
  398. package/docs/wiki/TypeAlias.SetValueFn.md +25 -0
  399. package/docs/wiki/TypeAlias.ValidationErrors.md +11 -0
  400. package/docs/wiki/TypeAlias.Validator.md +7 -0
  401. package/docs/wiki/TypeAlias.ValidatorFn.md +23 -0
  402. package/docs/wiki/TypeAlias.ValidatorOrOpts.md +7 -0
  403. package/docs/wiki/Variable.RXAP_FORM_CONTEXT.md +7 -0
  404. package/docs/wiki/Variable.RXAP_FORM_DEFINITION.md +7 -0
  405. package/docs/wiki/Variable.RXAP_FORM_DEFINITION_BUILDER.md +7 -0
  406. package/docs/wiki/Variable.RXAP_FORM_INITIAL_STATE.md +7 -0
  407. package/docs/wiki/Variable.RXAP_FORM_LOAD_FAILED_METHOD.md +7 -0
  408. package/docs/wiki/Variable.RXAP_FORM_LOAD_METHOD.md +7 -0
  409. package/docs/wiki/Variable.RXAP_FORM_LOAD_SUCCESSFUL_METHOD.md +7 -0
  410. package/docs/wiki/Variable.RXAP_FORM_SUBMIT_FAILED_METHOD.md +7 -0
  411. package/docs/wiki/Variable.RXAP_FORM_SUBMIT_METHOD.md +7 -0
  412. package/docs/wiki/Variable.RXAP_FORM_SUBMIT_SUCCESSFUL_METHOD.md +7 -0
  413. package/docs/wiki/Variable.RxapValidators.md +439 -0
  414. package/docs/wiki/_Sidebar.md +149 -0
  415. package/docs/wiki/globals.md +149 -0
  416. package/package.json +20 -18
  417. package/docs/assets/icons.js +0 -15
  418. package/docs/assets/icons.svg +0 -1
  419. package/docs/assets/navigation.js +0 -1
  420. package/docs/assets/search.js +0 -1
  421. package/docs/assets/style.css +0 -1412
  422. package/docs/classes/ControlValueAccessor.html +0 -8
  423. package/docs/classes/FormArrayControlManager.html +0 -6
  424. package/docs/classes/FormControlErrorDirective.html +0 -11
  425. package/docs/classes/FormControlMarkDirtyDirective.html +0 -4
  426. package/docs/classes/FormControlMarkPristineDirective.html +0 -4
  427. package/docs/classes/FormControlMarkTouchedDirective.html +0 -4
  428. package/docs/classes/FormControlMarkUntouchedDirective.html +0 -4
  429. package/docs/classes/FormControlNameDirective.html +0 -113
  430. package/docs/classes/FormDirective.html +0 -188
  431. package/docs/classes/FormGroupNameDirective.html +0 -101
  432. package/docs/classes/FormLoadedDirective.html +0 -8
  433. package/docs/classes/FormLoadingDirective.html +0 -8
  434. package/docs/classes/FormLoadingErrorDirective.html +0 -8
  435. package/docs/classes/FormResetDirective.html +0 -8
  436. package/docs/classes/FormSubmitDirective.html +0 -15
  437. package/docs/classes/FormSubmitFailedDirective.html +0 -8
  438. package/docs/classes/FormSubmitInvalidDirective.html +0 -8
  439. package/docs/classes/FormSubmitSuccessfulDirective.html +0 -8
  440. package/docs/classes/FormSubmittingDirective.html +0 -8
  441. package/docs/classes/ParentControlContainerDirective.html +0 -2
  442. package/docs/classes/RxapFormArray.html +0 -425
  443. package/docs/classes/RxapFormBuilder.html +0 -65
  444. package/docs/classes/RxapFormControl.html +0 -264
  445. package/docs/classes/RxapFormGroup.html +0 -260
  446. package/docs/classes/RxapFormsModule.html +0 -2
  447. package/docs/enums/MetadataKeys.html +0 -9
  448. package/docs/functions/ControlAsyncValidator.html +0 -1
  449. package/docs/functions/ControlChange.html +0 -1
  450. package/docs/functions/ControlSetValue.html +0 -1
  451. package/docs/functions/ControlValidator.html +0 -1
  452. package/docs/functions/IsArray.html +0 -1
  453. package/docs/functions/IsBoolean.html +0 -1
  454. package/docs/functions/IsComplex.html +0 -1
  455. package/docs/functions/IsDate.html +0 -1
  456. package/docs/functions/IsEmail.html +0 -1
  457. package/docs/functions/IsEnum.html +0 -1
  458. package/docs/functions/IsIP.html +0 -1
  459. package/docs/functions/IsInt.html +0 -1
  460. package/docs/functions/IsNumber.html +0 -2
  461. package/docs/functions/IsObject.html +0 -1
  462. package/docs/functions/IsPhoneNumber.html +0 -1
  463. package/docs/functions/IsPort.html +0 -1
  464. package/docs/functions/IsString.html +0 -1
  465. package/docs/functions/IsUUID.html +0 -1
  466. package/docs/functions/IsUrl.html +0 -1
  467. package/docs/functions/RxapForm.html +0 -1
  468. package/docs/functions/ToFormMethod.html +0 -1
  469. package/docs/functions/ToFormSubmitMethod.html +0 -3
  470. package/docs/functions/ToMethodWithInjectionContext.html +0 -1
  471. package/docs/functions/ToMethodWithInjectionContextFactory.html +0 -1
  472. package/docs/functions/UseFormArrayControl.html +0 -1
  473. package/docs/functions/UseFormArrayGroup.html +0 -1
  474. package/docs/functions/UseFormControl.html +0 -1
  475. package/docs/functions/UseFormGroup.html +0 -1
  476. package/docs/functions/_IsNumber.html +0 -1
  477. package/docs/functions/controlDisabledWhile.html +0 -1
  478. package/docs/functions/controlDisabled_.html +0 -1
  479. package/docs/functions/controlEnabledWhile.html +0 -1
  480. package/docs/functions/controlEnabled_.html +0 -1
  481. package/docs/functions/controlErrorChanges_.html +0 -1
  482. package/docs/functions/controlReadonly_.html +0 -1
  483. package/docs/functions/controlStatusChanges_.html +0 -1
  484. package/docs/functions/controlValueChanges_.html +0 -1
  485. package/docs/functions/disableControl.html +0 -1
  486. package/docs/functions/enableControl.html +0 -1
  487. package/docs/functions/hasErrorAndDirty.html +0 -1
  488. package/docs/functions/hasErrorAndTouched.html +0 -1
  489. package/docs/functions/isNumber-1.html +0 -2
  490. package/docs/functions/markAllDirty.html +0 -1
  491. package/docs/functions/markAllPristine.html +0 -1
  492. package/docs/functions/markAllUntouched.html +0 -1
  493. package/docs/functions/mergeControlValidators.html +0 -1
  494. package/docs/functions/selectControlValue_.html +0 -1
  495. package/docs/functions/validateControlOn.html +0 -1
  496. package/docs/hierarchy.html +0 -1
  497. package/docs/index.html +0 -25
  498. package/docs/interfaces/AbstractControl.html +0 -373
  499. package/docs/interfaces/AbstractControlOptions.html +0 -5
  500. package/docs/interfaces/BoxedValue.html +0 -3
  501. package/docs/interfaces/ComplexityOptions.html +0 -11
  502. package/docs/interfaces/ControlOptions.html +0 -20
  503. package/docs/interfaces/ControlSetValueOptions.html +0 -3
  504. package/docs/interfaces/FormArrayOptions.html +0 -16
  505. package/docs/interfaces/FormDefinition.html +0 -13
  506. package/docs/interfaces/FormDefinitionArray.html +0 -175
  507. package/docs/interfaces/FormDefinitionMetadata.html +0 -17
  508. package/docs/interfaces/FormGroupOptions.html +0 -13
  509. package/docs/interfaces/FormLoadFailedMethod.html +0 -3
  510. package/docs/interfaces/FormLoadMethod.html +0 -3
  511. package/docs/interfaces/FormLoadSuccessfulMethod.html +0 -3
  512. package/docs/interfaces/FormOptions.html +0 -13
  513. package/docs/interfaces/FormSubmitFailedMethod.html +0 -3
  514. package/docs/interfaces/FormSubmitMethod.html +0 -3
  515. package/docs/interfaces/FormSubmitSuccessfulMethod.html +0 -3
  516. package/docs/interfaces/InjectableValidator.html +0 -3
  517. package/docs/interfaces/IsNumberOptions.html +0 -6
  518. package/docs/interfaces/NgValidatorsErrors.html +0 -8
  519. package/docs/interfaces/RxapAbstractControlOptionsWithDefinition.html +0 -13
  520. package/docs/interfaces/_RxapAbstractControlOptions.html +0 -12
  521. package/docs/modules.html +0 -131
  522. package/docs/types/AsyncValidator.html +0 -1
  523. package/docs/types/AsyncValidatorFn.html +0 -1
  524. package/docs/types/ChangeFn.html +0 -1
  525. package/docs/types/ControlEventOptions.html +0 -1
  526. package/docs/types/ControlInsertedFn.html +0 -1
  527. package/docs/types/ControlPath.html +0 -1
  528. package/docs/types/ControlRemovedFn.html +0 -1
  529. package/docs/types/ControlState.html +0 -1
  530. package/docs/types/EmitEvent.html +0 -1
  531. package/docs/types/ExtractAbstractControl.html +0 -1
  532. package/docs/types/ExtractStrings.html +0 -1
  533. package/docs/types/FormBuilderFn.html +0 -1
  534. package/docs/types/FormType.html +0 -1
  535. package/docs/types/KeyValueControls.html +0 -1
  536. package/docs/types/OnlySelf.html +0 -1
  537. package/docs/types/OrBoxedValue.html +0 -1
  538. package/docs/types/RxapAbstractControlOptions.html +0 -1
  539. package/docs/types/SetValueFn.html +0 -1
  540. package/docs/types/ValidationErrors.html +0 -1
  541. package/docs/types/Validator.html +0 -1
  542. package/docs/types/ValidatorFn.html +0 -1
  543. package/docs/types/ValidatorOrOpts.html +0 -1
  544. package/docs/variables/RXAP_FORM_CONTEXT.html +0 -1
  545. package/docs/variables/RXAP_FORM_DEFINITION.html +0 -1
  546. package/docs/variables/RXAP_FORM_DEFINITION_BUILDER.html +0 -1
  547. package/docs/variables/RXAP_FORM_INITIAL_STATE.html +0 -1
  548. package/docs/variables/RXAP_FORM_LOAD_FAILED_METHOD.html +0 -1
  549. package/docs/variables/RXAP_FORM_LOAD_METHOD.html +0 -1
  550. package/docs/variables/RXAP_FORM_LOAD_SUCCESSFUL_METHOD.html +0 -1
  551. package/docs/variables/RXAP_FORM_SUBMIT_FAILED_METHOD.html +0 -1
  552. package/docs/variables/RXAP_FORM_SUBMIT_METHOD.html +0 -1
  553. package/docs/variables/RXAP_FORM_SUBMIT_SUCCESSFUL_METHOD.html +0 -1
  554. package/docs/variables/RxapValidators.html +0 -1
  555. /package/docs/{.nojekyll → html/.nojekyll} +0 -0
@@ -0,0 +1,1687 @@
1
+ [@rxap/forms](../wiki/globals) / AbstractControl
2
+
3
+ # Interface: AbstractControl\<T\>
4
+
5
+ Defined in: [packages/angular/forms/src/lib/types.ts:70](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/forms/src/lib/types.ts#L70)
6
+
7
+ ## Extends
8
+
9
+ - `AbstractControl`
10
+
11
+ ## Type Parameters
12
+
13
+ • **T** = `any`
14
+
15
+ ## Properties
16
+
17
+ ### controlId?
18
+
19
+ > `optional` **controlId**: `string`
20
+
21
+ Defined in: [packages/angular/forms/src/lib/types.ts:72](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/forms/src/lib/types.ts#L72)
22
+
23
+ ***
24
+
25
+ ### errors
26
+
27
+ > `readonly` **errors**: `null` \| `ValidationErrors`
28
+
29
+ Defined in: node\_modules/@angular/forms/index.d.ts:149
30
+
31
+ An object containing any errors generated by failing validation,
32
+ or null if there are no errors.
33
+
34
+ #### Inherited from
35
+
36
+ `NgAbstractControl.errors`
37
+
38
+ ***
39
+
40
+ ### events
41
+
42
+ > `readonly` **events**: `Observable`\<`ControlEvent`\<`any`\>\>
43
+
44
+ Defined in: node\_modules/@angular/forms/index.d.ts:196
45
+
46
+ A multicasting observable that emits an event every time the state of the control changes.
47
+ It emits for value, status, pristine or touched changes.
48
+
49
+ **Note**: On value change, the emit happens right after a value of this control is updated. The
50
+ value of a parent control (for example if this FormControl is a part of a FormGroup) is updated
51
+ later, so accessing a value of a parent control (using the `value` property) from the callback
52
+ of this event might result in getting a value that has not been updated yet. Subscribe to the
53
+ `events` of the parent control instead.
54
+ For other event types, the events are emitted after the parent control has been updated.
55
+
56
+ #### Inherited from
57
+
58
+ `NgAbstractControl.events`
59
+
60
+ ***
61
+
62
+ ### fullControlPath?
63
+
64
+ > `optional` **fullControlPath**: `string`
65
+
66
+ Defined in: [packages/angular/forms/src/lib/types.ts:73](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/forms/src/lib/types.ts#L73)
67
+
68
+ ***
69
+
70
+ ### readonly?
71
+
72
+ > `optional` **readonly**: `boolean`
73
+
74
+ Defined in: [packages/angular/forms/src/lib/types.ts:75](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/forms/src/lib/types.ts#L75)
75
+
76
+ ***
77
+
78
+ ### rxapFormDefinition?
79
+
80
+ > `optional` **rxapFormDefinition**: [`FormDefinition`](../wiki/Interface.FormDefinition)\<`any`, `any`, `any`\>
81
+
82
+ Defined in: [packages/angular/forms/src/lib/types.ts:74](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/forms/src/lib/types.ts#L74)
83
+
84
+ ***
85
+
86
+ ### stateChanges?
87
+
88
+ > `optional` **stateChanges**: `Subject`\<`any`\>
89
+
90
+ Defined in: [packages/angular/forms/src/lib/types.ts:76](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/forms/src/lib/types.ts#L76)
91
+
92
+ ***
93
+
94
+ ### statusChanges
95
+
96
+ > `readonly` **statusChanges**: `Observable`\<`FormControlStatus`\>
97
+
98
+ Defined in: node\_modules/@angular/forms/index.d.ts:220
99
+
100
+ A multicasting observable that emits an event every time the validation `status` of the control
101
+ recalculates.
102
+
103
+ #### See
104
+
105
+ - FormControlStatus
106
+ - [AbstractControl.status](../wiki/Interface.AbstractControl#status)
107
+
108
+ TODO: this should be piped from events() but is breaking in G3
109
+
110
+ #### Inherited from
111
+
112
+ `NgAbstractControl.statusChanges`
113
+
114
+ ***
115
+
116
+ ### value
117
+
118
+ > **value**: `T`
119
+
120
+ Defined in: [packages/angular/forms/src/lib/types.ts:71](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/forms/src/lib/types.ts#L71)
121
+
122
+ The current value of the control.
123
+
124
+ * For a `FormControl`, the current value.
125
+ * For an enabled `FormGroup`, the values of enabled controls as an object
126
+ with a key-value pair for each member of the group.
127
+ * For a disabled `FormGroup`, the values of all controls as an object
128
+ with a key-value pair for each member of the group.
129
+ * For a `FormArray`, the values of enabled controls as an array.
130
+
131
+ #### Overrides
132
+
133
+ `NgAbstractControl.value`
134
+
135
+ ***
136
+
137
+ ### valueChanges
138
+
139
+ > `readonly` **valueChanges**: `Observable`\<`any`\>
140
+
141
+ Defined in: node\_modules/@angular/forms/index.d.ts:210
142
+
143
+ A multicasting observable that emits an event every time the value of the control changes, in
144
+ the UI or programmatically. It also emits an event each time you call enable() or disable()
145
+ without passing along {emitEvent: false} as a function argument.
146
+
147
+ **Note**: the emit happens right after a value of this control is updated. The value of a
148
+ parent control (for example if this FormControl is a part of a FormGroup) is updated later, so
149
+ accessing a value of a parent control (using the `value` property) from the callback of this
150
+ event might result in getting a value that has not been updated yet. Subscribe to the
151
+ `valueChanges` event of the parent control instead.
152
+
153
+ TODO: this should be piped from events() but is breaking in G3
154
+
155
+ #### Inherited from
156
+
157
+ `NgAbstractControl.valueChanges`
158
+
159
+ ## Accessors
160
+
161
+ ### asyncValidator
162
+
163
+ #### Get Signature
164
+
165
+ > **get** **asyncValidator**(): `null` \| `AsyncValidatorFn`
166
+
167
+ Defined in: node\_modules/@angular/forms/index.d.ts:79
168
+
169
+ Returns the function that is used to determine the validity of this control asynchronously.
170
+ If multiple validators have been added, this will be a single composed function.
171
+ See `Validators.compose()` for additional information.
172
+
173
+ ##### Returns
174
+
175
+ `null` \| `AsyncValidatorFn`
176
+
177
+ #### Set Signature
178
+
179
+ > **set** **asyncValidator**(`asyncValidatorFn`): `void`
180
+
181
+ Defined in: node\_modules/@angular/forms/index.d.ts:80
182
+
183
+ ##### Parameters
184
+
185
+ ###### asyncValidatorFn
186
+
187
+ `null` | `AsyncValidatorFn`
188
+
189
+ ##### Returns
190
+
191
+ `void`
192
+
193
+ #### Inherited from
194
+
195
+ `NgAbstractControl.asyncValidator`
196
+
197
+ ***
198
+
199
+ ### dirty
200
+
201
+ #### Get Signature
202
+
203
+ > **get** **dirty**(): `boolean`
204
+
205
+ Defined in: node\_modules/@angular/forms/index.d.ts:167
206
+
207
+ A control is `dirty` if the user has changed the value
208
+ in the UI.
209
+
210
+ ##### Returns
211
+
212
+ `boolean`
213
+
214
+ True if the user has changed the value of this control in the UI; compare `pristine`.
215
+ Programmatic changes to a control's value do not mark it dirty.
216
+
217
+ #### Inherited from
218
+
219
+ `NgAbstractControl.dirty`
220
+
221
+ ***
222
+
223
+ ### disabled
224
+
225
+ #### Get Signature
226
+
227
+ > **get** **disabled**(): `boolean`
228
+
229
+ Defined in: node\_modules/@angular/forms/index.d.ts:134
230
+
231
+ A control is `disabled` when its `status` is `DISABLED`.
232
+
233
+ Disabled controls are exempt from validation checks and
234
+ are not included in the aggregate value of their ancestor
235
+ controls.
236
+
237
+ ##### See
238
+
239
+ [AbstractControl.status](../wiki/Interface.AbstractControl#status)
240
+
241
+ ##### Returns
242
+
243
+ `boolean`
244
+
245
+ True if the control is disabled, false otherwise.
246
+
247
+ #### Inherited from
248
+
249
+ `NgAbstractControl.disabled`
250
+
251
+ ***
252
+
253
+ ### enabled
254
+
255
+ #### Get Signature
256
+
257
+ > **get** **enabled**(): `boolean`
258
+
259
+ Defined in: node\_modules/@angular/forms/index.d.ts:144
260
+
261
+ A control is `enabled` as long as its `status` is not `DISABLED`.
262
+
263
+ ##### See
264
+
265
+ [AbstractControl.status](../wiki/Interface.AbstractControl#status)
266
+
267
+ ##### Returns
268
+
269
+ `boolean`
270
+
271
+ True if the control has any status other than 'DISABLED',
272
+ false if the status is 'DISABLED'.
273
+
274
+ #### Inherited from
275
+
276
+ `NgAbstractControl.enabled`
277
+
278
+ ***
279
+
280
+ ### invalid
281
+
282
+ #### Get Signature
283
+
284
+ > **get** **invalid**(): `boolean`
285
+
286
+ Defined in: node\_modules/@angular/forms/index.d.ts:113
287
+
288
+ A control is `invalid` when its `status` is `INVALID`.
289
+
290
+ ##### See
291
+
292
+ [AbstractControl.status](../wiki/Interface.AbstractControl#status)
293
+
294
+ ##### Returns
295
+
296
+ `boolean`
297
+
298
+ True if this control has failed one or more of its validation checks,
299
+ false otherwise.
300
+
301
+ #### Inherited from
302
+
303
+ `NgAbstractControl.invalid`
304
+
305
+ ***
306
+
307
+ ### parent
308
+
309
+ #### Get Signature
310
+
311
+ > **get** **parent**(): `null` \| `FormGroup`\<`any`\> \| `FormArray`\<`any`\>
312
+
313
+ Defined in: node\_modules/@angular/forms/index.d.ts:84
314
+
315
+ The parent control.
316
+
317
+ ##### Returns
318
+
319
+ `null` \| `FormGroup`\<`any`\> \| `FormArray`\<`any`\>
320
+
321
+ #### Inherited from
322
+
323
+ `NgAbstractControl.parent`
324
+
325
+ ***
326
+
327
+ ### pending
328
+
329
+ #### Get Signature
330
+
331
+ > **get** **pending**(): `boolean`
332
+
333
+ Defined in: node\_modules/@angular/forms/index.d.ts:122
334
+
335
+ A control is `pending` when its `status` is `PENDING`.
336
+
337
+ ##### See
338
+
339
+ [AbstractControl.status](../wiki/Interface.AbstractControl#status)
340
+
341
+ ##### Returns
342
+
343
+ `boolean`
344
+
345
+ True if this control is in the process of conducting a validation check,
346
+ false otherwise.
347
+
348
+ #### Inherited from
349
+
350
+ `NgAbstractControl.pending`
351
+
352
+ ***
353
+
354
+ ### pristine
355
+
356
+ #### Get Signature
357
+
358
+ > **get** **pristine**(): `boolean`
359
+
360
+ Defined in: node\_modules/@angular/forms/index.d.ts:157
361
+
362
+ A control is `pristine` if the user has not yet changed
363
+ the value in the UI.
364
+
365
+ ##### Returns
366
+
367
+ `boolean`
368
+
369
+ True if the user has not yet changed the value in the UI; compare `dirty`.
370
+ Programmatic changes to a control's value do not mark it dirty.
371
+
372
+ #### Set Signature
373
+
374
+ > **set** **pristine**(`value`): `void`
375
+
376
+ Defined in: node\_modules/@angular/forms/index.d.ts:158
377
+
378
+ ##### Parameters
379
+
380
+ ###### value
381
+
382
+ `boolean`
383
+
384
+ ##### Returns
385
+
386
+ `void`
387
+
388
+ #### Inherited from
389
+
390
+ `NgAbstractControl.pristine`
391
+
392
+ ***
393
+
394
+ ### root
395
+
396
+ #### Get Signature
397
+
398
+ > **get** **root**(): `AbstractControl`
399
+
400
+ Defined in: node\_modules/@angular/forms/index.d.ts:680
401
+
402
+ Retrieves the top-level ancestor of this control.
403
+
404
+ ##### Returns
405
+
406
+ `AbstractControl`
407
+
408
+ #### Inherited from
409
+
410
+ `NgAbstractControl.root`
411
+
412
+ ***
413
+
414
+ ### status
415
+
416
+ #### Get Signature
417
+
418
+ > **get** **status**(): `FormControlStatus`
419
+
420
+ Defined in: node\_modules/@angular/forms/index.d.ts:93
421
+
422
+ The validation status of the control.
423
+
424
+ ##### See
425
+
426
+ FormControlStatus
427
+
428
+ These status values are mutually exclusive, so a control cannot be
429
+ both valid AND invalid or invalid AND disabled.
430
+
431
+ ##### Returns
432
+
433
+ `FormControlStatus`
434
+
435
+ #### Set Signature
436
+
437
+ > **set** **status**(`value`): `void`
438
+
439
+ Defined in: node\_modules/@angular/forms/index.d.ts:94
440
+
441
+ ##### Parameters
442
+
443
+ ###### value
444
+
445
+ `FormControlStatus`
446
+
447
+ ##### Returns
448
+
449
+ `void`
450
+
451
+ #### Inherited from
452
+
453
+ `NgAbstractControl.status`
454
+
455
+ ***
456
+
457
+ ### touched
458
+
459
+ #### Get Signature
460
+
461
+ > **get** **touched**(): `boolean`
462
+
463
+ Defined in: node\_modules/@angular/forms/index.d.ts:174
464
+
465
+ True if the control is marked as `touched`.
466
+
467
+ A control is marked `touched` once the user has triggered
468
+ a `blur` event on it.
469
+
470
+ ##### Returns
471
+
472
+ `boolean`
473
+
474
+ #### Set Signature
475
+
476
+ > **set** **touched**(`value`): `void`
477
+
478
+ Defined in: node\_modules/@angular/forms/index.d.ts:175
479
+
480
+ ##### Parameters
481
+
482
+ ###### value
483
+
484
+ `boolean`
485
+
486
+ ##### Returns
487
+
488
+ `void`
489
+
490
+ #### Inherited from
491
+
492
+ `NgAbstractControl.touched`
493
+
494
+ ***
495
+
496
+ ### untouched
497
+
498
+ #### Get Signature
499
+
500
+ > **get** **untouched**(): `boolean`
501
+
502
+ Defined in: node\_modules/@angular/forms/index.d.ts:183
503
+
504
+ True if the control has not been marked as touched
505
+
506
+ A control is `untouched` if the user has not yet triggered
507
+ a `blur` event on it.
508
+
509
+ ##### Returns
510
+
511
+ `boolean`
512
+
513
+ #### Inherited from
514
+
515
+ `NgAbstractControl.untouched`
516
+
517
+ ***
518
+
519
+ ### updateOn
520
+
521
+ #### Get Signature
522
+
523
+ > **get** **updateOn**(): `FormHooks`
524
+
525
+ Defined in: node\_modules/@angular/forms/index.d.ts:227
526
+
527
+ Reports the update strategy of the `AbstractControl` (meaning
528
+ the event on which the control updates itself).
529
+ Possible values: `'change'` | `'blur'` | `'submit'`
530
+ Default value: `'change'`
531
+
532
+ ##### Returns
533
+
534
+ `FormHooks`
535
+
536
+ #### Inherited from
537
+
538
+ `NgAbstractControl.updateOn`
539
+
540
+ ***
541
+
542
+ ### valid
543
+
544
+ #### Get Signature
545
+
546
+ > **get** **valid**(): `boolean`
547
+
548
+ Defined in: node\_modules/@angular/forms/index.d.ts:104
549
+
550
+ A control is `valid` when its `status` is `VALID`.
551
+
552
+ ##### See
553
+
554
+ [AbstractControl.status](../wiki/Interface.AbstractControl#status)
555
+
556
+ ##### Returns
557
+
558
+ `boolean`
559
+
560
+ True if the control has passed all of its validation tests,
561
+ false otherwise.
562
+
563
+ #### Inherited from
564
+
565
+ `NgAbstractControl.valid`
566
+
567
+ ***
568
+
569
+ ### validator
570
+
571
+ #### Get Signature
572
+
573
+ > **get** **validator**(): `null` \| `ValidatorFn`
574
+
575
+ Defined in: node\_modules/@angular/forms/index.d.ts:72
576
+
577
+ Returns the function that is used to determine the validity of this control synchronously.
578
+ If multiple validators have been added, this will be a single composed function.
579
+ See `Validators.compose()` for additional information.
580
+
581
+ ##### Returns
582
+
583
+ `null` \| `ValidatorFn`
584
+
585
+ #### Set Signature
586
+
587
+ > **set** **validator**(`validatorFn`): `void`
588
+
589
+ Defined in: node\_modules/@angular/forms/index.d.ts:73
590
+
591
+ ##### Parameters
592
+
593
+ ###### validatorFn
594
+
595
+ `null` | `ValidatorFn`
596
+
597
+ ##### Returns
598
+
599
+ `void`
600
+
601
+ #### Inherited from
602
+
603
+ `NgAbstractControl.validator`
604
+
605
+ ## Methods
606
+
607
+ ### addAsyncValidators()
608
+
609
+ > **addAsyncValidators**(`validators`): `void`
610
+
611
+ Defined in: node\_modules/@angular/forms/index.d.ts:274
612
+
613
+ Add an asynchronous validator or validators to this control, without affecting other
614
+ validators.
615
+
616
+ When you add or remove a validator at run time, you must call
617
+ `updateValueAndValidity()` for the new validation to take effect.
618
+
619
+ Adding a validator that already exists will have no effect.
620
+
621
+ #### Parameters
622
+
623
+ ##### validators
624
+
625
+ The new asynchronous validator function or functions to add to this control.
626
+
627
+ `AsyncValidatorFn` | `AsyncValidatorFn`[]
628
+
629
+ #### Returns
630
+
631
+ `void`
632
+
633
+ #### Inherited from
634
+
635
+ `NgAbstractControl.addAsyncValidators`
636
+
637
+ ***
638
+
639
+ ### addValidators()
640
+
641
+ > **addValidators**(`validators`): `void`
642
+
643
+ Defined in: node\_modules/@angular/forms/index.d.ts:262
644
+
645
+ Add a synchronous validator or validators to this control, without affecting other validators.
646
+
647
+ When you add or remove a validator at run time, you must call
648
+ `updateValueAndValidity()` for the new validation to take effect.
649
+
650
+ Adding a validator that already exists will have no effect. If duplicate validator functions
651
+ are present in the `validators` array, only the first instance would be added to a form
652
+ control.
653
+
654
+ #### Parameters
655
+
656
+ ##### validators
657
+
658
+ The new validator function or functions to add to this control.
659
+
660
+ `ValidatorFn` | `ValidatorFn`[]
661
+
662
+ #### Returns
663
+
664
+ `void`
665
+
666
+ #### Inherited from
667
+
668
+ `NgAbstractControl.addValidators`
669
+
670
+ ***
671
+
672
+ ### clearAsyncValidators()
673
+
674
+ > **clearAsyncValidators**(): `void`
675
+
676
+ Defined in: node\_modules/@angular/forms/index.d.ts:365
677
+
678
+ Empties out the async validator list.
679
+
680
+ When you add or remove a validator at run time, you must call
681
+ `updateValueAndValidity()` for the new validation to take effect.
682
+
683
+ #### Returns
684
+
685
+ `void`
686
+
687
+ #### Inherited from
688
+
689
+ `NgAbstractControl.clearAsyncValidators`
690
+
691
+ ***
692
+
693
+ ### clearValidators()
694
+
695
+ > **clearValidators**(): `void`
696
+
697
+ Defined in: node\_modules/@angular/forms/index.d.ts:357
698
+
699
+ Empties out the synchronous validator list.
700
+
701
+ When you add or remove a validator at run time, you must call
702
+ `updateValueAndValidity()` for the new validation to take effect.
703
+
704
+ #### Returns
705
+
706
+ `void`
707
+
708
+ #### Inherited from
709
+
710
+ `NgAbstractControl.clearValidators`
711
+
712
+ ***
713
+
714
+ ### disable()
715
+
716
+ > **disable**(`opts`?): `void`
717
+
718
+ Defined in: node\_modules/@angular/forms/index.d.ts:502
719
+
720
+ Disables the control. This means the control is exempt from validation checks and
721
+ excluded from the aggregate value of any parent. Its status is `DISABLED`.
722
+
723
+ If the control has children, all children are also disabled.
724
+
725
+ #### Parameters
726
+
727
+ ##### opts?
728
+
729
+ Configuration options that determine how the control propagates
730
+ changes and emits events after the control is disabled.
731
+ * `onlySelf`: When true, mark only this control. When false or not supplied,
732
+ marks all direct ancestors. Default is false.
733
+ * `emitEvent`: When true or not supplied (the default), the `statusChanges`,
734
+ `valueChanges` and `events`
735
+ observables emit events with the latest status and value when the control is disabled.
736
+ When false, no events are emitted.
737
+
738
+ ###### emitEvent?
739
+
740
+ `boolean`
741
+
742
+ ###### onlySelf?
743
+
744
+ `boolean`
745
+
746
+ #### Returns
747
+
748
+ `void`
749
+
750
+ #### See
751
+
752
+ [AbstractControl.status](../wiki/Interface.AbstractControl#status)
753
+
754
+ #### Inherited from
755
+
756
+ `NgAbstractControl.disable`
757
+
758
+ ***
759
+
760
+ ### enable()
761
+
762
+ > **enable**(`opts`?): `void`
763
+
764
+ Defined in: node\_modules/@angular/forms/index.d.ts:524
765
+
766
+ Enables the control. This means the control is included in validation checks and
767
+ the aggregate value of its parent. Its status recalculates based on its value and
768
+ its validators.
769
+
770
+ By default, if the control has children, all children are enabled.
771
+
772
+ #### Parameters
773
+
774
+ ##### opts?
775
+
776
+ Configure options that control how the control propagates changes and
777
+ emits events when marked as untouched
778
+ * `onlySelf`: When true, mark only this control. When false or not supplied,
779
+ marks all direct ancestors. Default is false.
780
+ * `emitEvent`: When true or not supplied (the default), the `statusChanges`,
781
+ `valueChanges` and `events`
782
+ observables emit events with the latest status and value when the control is enabled.
783
+ When false, no events are emitted.
784
+
785
+ ###### emitEvent?
786
+
787
+ `boolean`
788
+
789
+ ###### onlySelf?
790
+
791
+ `boolean`
792
+
793
+ #### Returns
794
+
795
+ `void`
796
+
797
+ #### See
798
+
799
+ [AbstractControl.status](../wiki/Interface.AbstractControl#status)
800
+
801
+ #### Inherited from
802
+
803
+ `NgAbstractControl.enable`
804
+
805
+ ***
806
+
807
+ ### get()
808
+
809
+ #### Call Signature
810
+
811
+ > **get**\<`P`\>(`path`): `null` \| `AbstractControl`\<`ɵGetProperty`\<`any`, `P`\>, `ɵGetProperty`\<`any`, `P`\>\>
812
+
813
+ Defined in: node\_modules/@angular/forms/index.d.ts:610
814
+
815
+ Retrieves a child control given the control's name or path.
816
+
817
+ This signature for get supports strings and `const` arrays (`.get(['foo', 'bar'] as const)`).
818
+
819
+ ##### Type Parameters
820
+
821
+ • **P** *extends* `string` \| readonly (`string` \| `number`)[]
822
+
823
+ ##### Parameters
824
+
825
+ ###### path
826
+
827
+ `P`
828
+
829
+ ##### Returns
830
+
831
+ `null` \| `AbstractControl`\<`ɵGetProperty`\<`any`, `P`\>, `ɵGetProperty`\<`any`, `P`\>\>
832
+
833
+ ##### Inherited from
834
+
835
+ `NgAbstractControl.get`
836
+
837
+ #### Call Signature
838
+
839
+ > **get**\<`P`\>(`path`): `null` \| `AbstractControl`\<`ɵGetProperty`\<`any`, `P`\>, `ɵGetProperty`\<`any`, `P`\>\>
840
+
841
+ Defined in: node\_modules/@angular/forms/index.d.ts:617
842
+
843
+ Retrieves a child control given the control's name or path.
844
+
845
+ This signature for `get` supports non-const (mutable) arrays. Inferred type
846
+ information will not be as robust, so prefer to pass a `readonly` array if possible.
847
+
848
+ ##### Type Parameters
849
+
850
+ • **P** *extends* `string` \| (`string` \| `number`)[]
851
+
852
+ ##### Parameters
853
+
854
+ ###### path
855
+
856
+ `P`
857
+
858
+ ##### Returns
859
+
860
+ `null` \| `AbstractControl`\<`ɵGetProperty`\<`any`, `P`\>, `ɵGetProperty`\<`any`, `P`\>\>
861
+
862
+ ##### Inherited from
863
+
864
+ `NgAbstractControl.get`
865
+
866
+ ***
867
+
868
+ ### getError()
869
+
870
+ > **getError**(`errorCode`, `path`?): `any`
871
+
872
+ Defined in: node\_modules/@angular/forms/index.d.ts:645
873
+
874
+ #### Parameters
875
+
876
+ ##### errorCode
877
+
878
+ `string`
879
+
880
+ The code of the error to check
881
+
882
+ ##### path?
883
+
884
+ A list of control names that designates how to move from the current control
885
+ to the control that should be queried for errors.
886
+
887
+ `string` | (`string` \| `number`)[]
888
+
889
+ #### Returns
890
+
891
+ `any`
892
+
893
+ error data for that particular error. If the control or error is not present,
894
+ null is returned.
895
+
896
+ #### Description
897
+
898
+ Reports error data for the control with the given path.
899
+
900
+ #### Usage Notes
901
+
902
+ For example, for the following `FormGroup`:
903
+
904
+ ```ts
905
+ form = new FormGroup({
906
+ address: new FormGroup({ street: new FormControl() })
907
+ });
908
+ ```
909
+
910
+ The path to the 'street' control from the root form would be 'address' -> 'street'.
911
+
912
+ It can be provided to this method in one of two formats:
913
+
914
+ 1. An array of string control names, e.g. `['address', 'street']`
915
+ 1. A period-delimited list of control names in one string, e.g. `'address.street'`
916
+
917
+ #### Inherited from
918
+
919
+ `NgAbstractControl.getError`
920
+
921
+ ***
922
+
923
+ ### getRawValue()
924
+
925
+ > **getRawValue**(): `any`
926
+
927
+ Defined in: node\_modules/@angular/forms/index.d.ts:551
928
+
929
+ The raw value of this control. For most control implementations, the raw value will include
930
+ disabled children.
931
+
932
+ #### Returns
933
+
934
+ `any`
935
+
936
+ #### Inherited from
937
+
938
+ `NgAbstractControl.getRawValue`
939
+
940
+ ***
941
+
942
+ ### hasAsyncValidator()
943
+
944
+ > **hasAsyncValidator**(`validator`): `boolean`
945
+
946
+ Defined in: node\_modules/@angular/forms/index.d.ts:349
947
+
948
+ Check whether an asynchronous validator function is present on this control. The provided
949
+ validator must be a reference to the exact same function that was provided.
950
+
951
+ #### Parameters
952
+
953
+ ##### validator
954
+
955
+ `AsyncValidatorFn`
956
+
957
+ The asynchronous validator to check for presence. Compared by function
958
+ reference.
959
+
960
+ #### Returns
961
+
962
+ `boolean`
963
+
964
+ Whether the provided asynchronous validator was found on this control.
965
+
966
+ #### Inherited from
967
+
968
+ `NgAbstractControl.hasAsyncValidator`
969
+
970
+ ***
971
+
972
+ ### hasError()
973
+
974
+ > **hasError**(`errorCode`, `path`?): `boolean`
975
+
976
+ Defined in: node\_modules/@angular/forms/index.d.ts:676
977
+
978
+ #### Parameters
979
+
980
+ ##### errorCode
981
+
982
+ `string`
983
+
984
+ The code of the error to check
985
+
986
+ ##### path?
987
+
988
+ A list of control names that designates how to move from the current control
989
+ to the control that should be queried for errors.
990
+
991
+ `string` | (`string` \| `number`)[]
992
+
993
+ #### Returns
994
+
995
+ `boolean`
996
+
997
+ whether the given error is present in the control at the given path.
998
+
999
+ If the control is not present, false is returned.
1000
+
1001
+ #### Description
1002
+
1003
+ Reports whether the control with the given path has the error specified.
1004
+
1005
+ #### Usage Notes
1006
+
1007
+ For example, for the following `FormGroup`:
1008
+
1009
+ ```ts
1010
+ form = new FormGroup({
1011
+ address: new FormGroup({ street: new FormControl() })
1012
+ });
1013
+ ```
1014
+
1015
+ The path to the 'street' control from the root form would be 'address' -> 'street'.
1016
+
1017
+ It can be provided to this method in one of two formats:
1018
+
1019
+ 1. An array of string control names, e.g. `['address', 'street']`
1020
+ 1. A period-delimited list of control names in one string, e.g. `'address.street'`
1021
+
1022
+ If no path is given, this method checks for the error on the current control.
1023
+
1024
+ #### Inherited from
1025
+
1026
+ `NgAbstractControl.hasError`
1027
+
1028
+ ***
1029
+
1030
+ ### hasValidator()
1031
+
1032
+ > **hasValidator**(`validator`): `boolean`
1033
+
1034
+ Defined in: node\_modules/@angular/forms/index.d.ts:340
1035
+
1036
+ Check whether a synchronous validator function is present on this control. The provided
1037
+ validator must be a reference to the exact same function that was provided.
1038
+
1039
+ #### Parameters
1040
+
1041
+ ##### validator
1042
+
1043
+ `ValidatorFn`
1044
+
1045
+ The validator to check for presence. Compared by function reference.
1046
+
1047
+ #### Returns
1048
+
1049
+ `boolean`
1050
+
1051
+ Whether the provided validator was found on this control.
1052
+
1053
+ #### Usage Notes
1054
+
1055
+ ### Reference to a ValidatorFn
1056
+
1057
+ ```
1058
+ // Reference to the RequiredValidator
1059
+ const ctrl = new FormControl<number | null>(0, Validators.required);
1060
+ expect(ctrl.hasValidator(Validators.required)).toEqual(true)
1061
+
1062
+ // Reference to anonymous function inside MinValidator
1063
+ const minValidator = Validators.min(3);
1064
+ const ctrl = new FormControl<number | null>(0, minValidator);
1065
+ expect(ctrl.hasValidator(minValidator)).toEqual(true)
1066
+ expect(ctrl.hasValidator(Validators.min(3))).toEqual(false)
1067
+ ```
1068
+
1069
+ #### Inherited from
1070
+
1071
+ `NgAbstractControl.hasValidator`
1072
+
1073
+ ***
1074
+
1075
+ ### markAllAsTouched()
1076
+
1077
+ > **markAllAsTouched**(`opts`?): `void`
1078
+
1079
+ Defined in: node\_modules/@angular/forms/index.d.ts:396
1080
+
1081
+ Marks the control and all its descendant controls as `touched`.
1082
+
1083
+ #### Parameters
1084
+
1085
+ ##### opts?
1086
+
1087
+ Configuration options that determine how the control propagates changes
1088
+ and emits events after marking is applied.
1089
+ * `emitEvent`: When true or not supplied (the default), the `events`
1090
+ observable emits a `TouchedChangeEvent` with the `touched` property being `true`.
1091
+ When false, no events are emitted.
1092
+
1093
+ ###### emitEvent?
1094
+
1095
+ `boolean`
1096
+
1097
+ #### Returns
1098
+
1099
+ `void`
1100
+
1101
+ #### See
1102
+
1103
+ [()](../wiki/Interface.AbstractControl#markastouched)
1104
+
1105
+ #### Inherited from
1106
+
1107
+ `NgAbstractControl.markAllAsTouched`
1108
+
1109
+ ***
1110
+
1111
+ ### markAsDirty()
1112
+
1113
+ > **markAsDirty**(`opts`?): `void`
1114
+
1115
+ Defined in: node\_modules/@angular/forms/index.d.ts:437
1116
+
1117
+ Marks the control as `dirty`. A control becomes dirty when
1118
+ the control's value is changed through the UI; compare `markAsTouched`.
1119
+
1120
+ #### Parameters
1121
+
1122
+ ##### opts?
1123
+
1124
+ Configuration options that determine how the control propagates changes
1125
+ and emits events after marking is applied.
1126
+ * `onlySelf`: When true, mark only this control. When false or not supplied,
1127
+ marks all direct ancestors. Default is false.
1128
+ * `emitEvent`: When true or not supplied (the default), the `events`
1129
+ observable emits a `PristineChangeEvent` with the `pristine` property being `false`.
1130
+ When false, no events are emitted.
1131
+
1132
+ ###### emitEvent?
1133
+
1134
+ `boolean`
1135
+
1136
+ ###### onlySelf?
1137
+
1138
+ `boolean`
1139
+
1140
+ #### Returns
1141
+
1142
+ `void`
1143
+
1144
+ #### See
1145
+
1146
+ - [()](../wiki/Interface.AbstractControl#markastouched)
1147
+ - [()](../wiki/Interface.AbstractControl#markasuntouched)
1148
+ - [()](../wiki/Interface.AbstractControl#markaspristine)
1149
+
1150
+ #### Inherited from
1151
+
1152
+ `NgAbstractControl.markAsDirty`
1153
+
1154
+ ***
1155
+
1156
+ ### markAsPending()
1157
+
1158
+ > **markAsPending**(`opts`?): `void`
1159
+
1160
+ Defined in: node\_modules/@angular/forms/index.d.ts:481
1161
+
1162
+ Marks the control as `pending`.
1163
+
1164
+ A control is pending while the control performs async validation.
1165
+
1166
+ #### Parameters
1167
+
1168
+ ##### opts?
1169
+
1170
+ Configuration options that determine how the control propagates changes and
1171
+ emits events after marking is applied.
1172
+ * `onlySelf`: When true, mark only this control. When false or not supplied,
1173
+ marks all direct ancestors. Default is false.
1174
+ * `emitEvent`: When true or not supplied (the default), the `statusChanges`
1175
+ observable emits an event with the latest status the control is marked pending
1176
+ and the `events` observable emits a `StatusChangeEvent` with the `status` property being
1177
+ `PENDING` When false, no events are emitted.
1178
+
1179
+ ###### emitEvent?
1180
+
1181
+ `boolean`
1182
+
1183
+ ###### onlySelf?
1184
+
1185
+ `boolean`
1186
+
1187
+ #### Returns
1188
+
1189
+ `void`
1190
+
1191
+ #### See
1192
+
1193
+ [AbstractControl.status](../wiki/Interface.AbstractControl#status)
1194
+
1195
+ #### Inherited from
1196
+
1197
+ `NgAbstractControl.markAsPending`
1198
+
1199
+ ***
1200
+
1201
+ ### markAsPristine()
1202
+
1203
+ > **markAsPristine**(`opts`?): `void`
1204
+
1205
+ Defined in: node\_modules/@angular/forms/index.d.ts:460
1206
+
1207
+ Marks the control as `pristine`.
1208
+
1209
+ If the control has any children, marks all children as `pristine`,
1210
+ and recalculates the `pristine` status of all parent
1211
+ controls.
1212
+
1213
+ #### Parameters
1214
+
1215
+ ##### opts?
1216
+
1217
+ Configuration options that determine how the control emits events after
1218
+ marking is applied.
1219
+ * `onlySelf`: When true, mark only this control. When false or not supplied,
1220
+ marks all direct ancestors. Default is false.
1221
+ * `emitEvent`: When true or not supplied (the default), the `events`
1222
+ observable emits a `PristineChangeEvent` with the `pristine` property being `true`.
1223
+ When false, no events are emitted.
1224
+
1225
+ ###### emitEvent?
1226
+
1227
+ `boolean`
1228
+
1229
+ ###### onlySelf?
1230
+
1231
+ `boolean`
1232
+
1233
+ #### Returns
1234
+
1235
+ `void`
1236
+
1237
+ #### See
1238
+
1239
+ - [()](../wiki/Interface.AbstractControl#markastouched)
1240
+ - [()](../wiki/Interface.AbstractControl#markasuntouched)
1241
+ - [()](../wiki/Interface.AbstractControl#markasdirty)
1242
+
1243
+ #### Inherited from
1244
+
1245
+ `NgAbstractControl.markAsPristine`
1246
+
1247
+ ***
1248
+
1249
+ ### markAsTouched()
1250
+
1251
+ > **markAsTouched**(`opts`?): `void`
1252
+
1253
+ Defined in: node\_modules/@angular/forms/index.d.ts:382
1254
+
1255
+ Marks the control as `touched`. A control is touched by focus and
1256
+ blur events that do not change the value.
1257
+
1258
+ #### Parameters
1259
+
1260
+ ##### opts?
1261
+
1262
+ Configuration options that determine how the control propagates changes
1263
+ and emits events after marking is applied.
1264
+ * `onlySelf`: When true, mark only this control. When false or not supplied,
1265
+ marks all direct ancestors. Default is false.
1266
+ * `emitEvent`: When true or not supplied (the default), the `events`
1267
+ observable emits a `TouchedChangeEvent` with the `touched` property being `true`.
1268
+ When false, no events are emitted.
1269
+
1270
+ ###### emitEvent?
1271
+
1272
+ `boolean`
1273
+
1274
+ ###### onlySelf?
1275
+
1276
+ `boolean`
1277
+
1278
+ #### Returns
1279
+
1280
+ `void`
1281
+
1282
+ #### See
1283
+
1284
+ - [()](../wiki/Interface.AbstractControl#markasuntouched)
1285
+ - [()](../wiki/Interface.AbstractControl#markasdirty)
1286
+ - [()](../wiki/Interface.AbstractControl#markaspristine)
1287
+
1288
+ #### Inherited from
1289
+
1290
+ `NgAbstractControl.markAsTouched`
1291
+
1292
+ ***
1293
+
1294
+ ### markAsUntouched()
1295
+
1296
+ > **markAsUntouched**(`opts`?): `void`
1297
+
1298
+ Defined in: node\_modules/@angular/forms/index.d.ts:417
1299
+
1300
+ Marks the control as `untouched`.
1301
+
1302
+ If the control has any children, also marks all children as `untouched`
1303
+ and recalculates the `touched` status of all parent controls.
1304
+
1305
+ #### Parameters
1306
+
1307
+ ##### opts?
1308
+
1309
+ Configuration options that determine how the control propagates changes
1310
+ and emits events after the marking is applied.
1311
+ * `onlySelf`: When true, mark only this control. When false or not supplied,
1312
+ marks all direct ancestors. Default is false.
1313
+ * `emitEvent`: When true or not supplied (the default), the `events`
1314
+ observable emits a `TouchedChangeEvent` with the `touched` property being `false`.
1315
+ When false, no events are emitted.
1316
+
1317
+ ###### emitEvent?
1318
+
1319
+ `boolean`
1320
+
1321
+ ###### onlySelf?
1322
+
1323
+ `boolean`
1324
+
1325
+ #### Returns
1326
+
1327
+ `void`
1328
+
1329
+ #### See
1330
+
1331
+ - [()](../wiki/Interface.AbstractControl#markastouched)
1332
+ - [()](../wiki/Interface.AbstractControl#markasdirty)
1333
+ - [()](../wiki/Interface.AbstractControl#markaspristine)
1334
+
1335
+ #### Inherited from
1336
+
1337
+ `NgAbstractControl.markAsUntouched`
1338
+
1339
+ ***
1340
+
1341
+ ### patchValue()
1342
+
1343
+ > `abstract` **patchValue**(`value`, `options`?): `void`
1344
+
1345
+ Defined in: node\_modules/@angular/forms/index.d.ts:542
1346
+
1347
+ Patches the value of the control. Abstract method (implemented in sub-classes).
1348
+
1349
+ #### Parameters
1350
+
1351
+ ##### value
1352
+
1353
+ `any`
1354
+
1355
+ ##### options?
1356
+
1357
+ `Object`
1358
+
1359
+ #### Returns
1360
+
1361
+ `void`
1362
+
1363
+ #### Inherited from
1364
+
1365
+ `NgAbstractControl.patchValue`
1366
+
1367
+ ***
1368
+
1369
+ ### removeAsyncValidators()
1370
+
1371
+ > **removeAsyncValidators**(`validators`): `void`
1372
+
1373
+ Defined in: node\_modules/@angular/forms/index.d.ts:316
1374
+
1375
+ Remove an asynchronous validator from this control, without affecting other validators.
1376
+ Validators are compared by function reference; you must pass a reference to the exact same
1377
+ validator function as the one that was originally set. If a provided validator is not found, it
1378
+ is ignored.
1379
+
1380
+ When you add or remove a validator at run time, you must call
1381
+ `updateValueAndValidity()` for the new validation to take effect.
1382
+
1383
+ #### Parameters
1384
+
1385
+ ##### validators
1386
+
1387
+ The asynchronous validator or validators to remove.
1388
+
1389
+ `AsyncValidatorFn` | `AsyncValidatorFn`[]
1390
+
1391
+ #### Returns
1392
+
1393
+ `void`
1394
+
1395
+ #### Inherited from
1396
+
1397
+ `NgAbstractControl.removeAsyncValidators`
1398
+
1399
+ ***
1400
+
1401
+ ### removeValidators()
1402
+
1403
+ > **removeValidators**(`validators`): `void`
1404
+
1405
+ Defined in: node\_modules/@angular/forms/index.d.ts:304
1406
+
1407
+ Remove a synchronous validator from this control, without affecting other validators.
1408
+ Validators are compared by function reference; you must pass a reference to the exact same
1409
+ validator function as the one that was originally set. If a provided validator is not found,
1410
+ it is ignored.
1411
+
1412
+ #### Parameters
1413
+
1414
+ ##### validators
1415
+
1416
+ The validator or validators to remove.
1417
+
1418
+ `ValidatorFn` | `ValidatorFn`[]
1419
+
1420
+ #### Returns
1421
+
1422
+ `void`
1423
+
1424
+ #### Usage Notes
1425
+
1426
+ ### Reference to a ValidatorFn
1427
+
1428
+ ```
1429
+ // Reference to the RequiredValidator
1430
+ const ctrl = new FormControl<string | null>('', Validators.required);
1431
+ ctrl.removeValidators(Validators.required);
1432
+
1433
+ // Reference to anonymous function inside MinValidator
1434
+ const minValidator = Validators.min(3);
1435
+ const ctrl = new FormControl<string | null>('', minValidator);
1436
+ expect(ctrl.hasValidator(minValidator)).toEqual(true)
1437
+ expect(ctrl.hasValidator(Validators.min(3))).toEqual(false)
1438
+
1439
+ ctrl.removeValidators(minValidator);
1440
+ ```
1441
+
1442
+ When you add or remove a validator at run time, you must call
1443
+ `updateValueAndValidity()` for the new validation to take effect.
1444
+
1445
+ #### Inherited from
1446
+
1447
+ `NgAbstractControl.removeValidators`
1448
+
1449
+ ***
1450
+
1451
+ ### reset()
1452
+
1453
+ > `abstract` **reset**(`value`?, `options`?): `void`
1454
+
1455
+ Defined in: node\_modules/@angular/forms/index.d.ts:546
1456
+
1457
+ Resets the control. Abstract method (implemented in sub-classes).
1458
+
1459
+ #### Parameters
1460
+
1461
+ ##### value?
1462
+
1463
+ `any`
1464
+
1465
+ ##### options?
1466
+
1467
+ `Object`
1468
+
1469
+ #### Returns
1470
+
1471
+ `void`
1472
+
1473
+ #### Inherited from
1474
+
1475
+ `NgAbstractControl.reset`
1476
+
1477
+ ***
1478
+
1479
+ ### setAsyncValidators()
1480
+
1481
+ > **setAsyncValidators**(`validators`): `void`
1482
+
1483
+ Defined in: node\_modules/@angular/forms/index.d.ts:249
1484
+
1485
+ Sets the asynchronous validators that are active on this control. Calling this
1486
+ overwrites any existing asynchronous validators.
1487
+
1488
+ When you add or remove a validator at run time, you must call
1489
+ `updateValueAndValidity()` for the new validation to take effect.
1490
+
1491
+ If you want to add a new validator without affecting existing ones, consider
1492
+ using `addAsyncValidators()` method instead.
1493
+
1494
+ #### Parameters
1495
+
1496
+ ##### validators
1497
+
1498
+ `null` | `AsyncValidatorFn` | `AsyncValidatorFn`[]
1499
+
1500
+ #### Returns
1501
+
1502
+ `void`
1503
+
1504
+ #### Inherited from
1505
+
1506
+ `NgAbstractControl.setAsyncValidators`
1507
+
1508
+ ***
1509
+
1510
+ ### setErrors()
1511
+
1512
+ > **setErrors**(`errors`, `opts`?): `void`
1513
+
1514
+ Defined in: node\_modules/@angular/forms/index.d.ts:602
1515
+
1516
+ Sets errors on a form control when running validations manually, rather than automatically.
1517
+
1518
+ Calling `setErrors` also updates the validity of the parent control.
1519
+
1520
+ #### Parameters
1521
+
1522
+ ##### errors
1523
+
1524
+ `null` | `ValidationErrors`
1525
+
1526
+ ##### opts?
1527
+
1528
+ Configuration options that determine how the control propagates
1529
+ changes and emits events after the control errors are set.
1530
+ * `emitEvent`: When true or not supplied (the default), the `statusChanges`
1531
+ observable emits an event after the errors are set.
1532
+
1533
+ ###### emitEvent?
1534
+
1535
+ `boolean`
1536
+
1537
+ #### Returns
1538
+
1539
+ `void`
1540
+
1541
+ #### Usage Notes
1542
+
1543
+ ### Manually set the errors for a control
1544
+
1545
+ ```ts
1546
+ const login = new FormControl('someLogin');
1547
+ login.setErrors({
1548
+ notUnique: true
1549
+ });
1550
+
1551
+ expect(login.valid).toEqual(false);
1552
+ expect(login.errors).toEqual({ notUnique: true });
1553
+
1554
+ login.setValue('someOtherLogin');
1555
+
1556
+ expect(login.valid).toEqual(true);
1557
+ ```
1558
+
1559
+ #### Inherited from
1560
+
1561
+ `NgAbstractControl.setErrors`
1562
+
1563
+ ***
1564
+
1565
+ ### setParent()
1566
+
1567
+ > **setParent**(`parent`): `void`
1568
+
1569
+ Defined in: node\_modules/@angular/forms/index.d.ts:534
1570
+
1571
+ Sets the parent of the control
1572
+
1573
+ #### Parameters
1574
+
1575
+ ##### parent
1576
+
1577
+ The new parent.
1578
+
1579
+ `null` | `FormGroup`\<`any`\> | `FormArray`\<`any`\>
1580
+
1581
+ #### Returns
1582
+
1583
+ `void`
1584
+
1585
+ #### Inherited from
1586
+
1587
+ `NgAbstractControl.setParent`
1588
+
1589
+ ***
1590
+
1591
+ ### setValidators()
1592
+
1593
+ > **setValidators**(`validators`): `void`
1594
+
1595
+ Defined in: node\_modules/@angular/forms/index.d.ts:238
1596
+
1597
+ Sets the synchronous validators that are active on this control. Calling
1598
+ this overwrites any existing synchronous validators.
1599
+
1600
+ When you add or remove a validator at run time, you must call
1601
+ `updateValueAndValidity()` for the new validation to take effect.
1602
+
1603
+ If you want to add a new validator without affecting existing ones, consider
1604
+ using `addValidators()` method instead.
1605
+
1606
+ #### Parameters
1607
+
1608
+ ##### validators
1609
+
1610
+ `null` | `ValidatorFn` | `ValidatorFn`[]
1611
+
1612
+ #### Returns
1613
+
1614
+ `void`
1615
+
1616
+ #### Inherited from
1617
+
1618
+ `NgAbstractControl.setValidators`
1619
+
1620
+ ***
1621
+
1622
+ ### setValue()
1623
+
1624
+ > `abstract` **setValue**(`value`, `options`?): `void`
1625
+
1626
+ Defined in: node\_modules/@angular/forms/index.d.ts:538
1627
+
1628
+ Sets the value of the control. Abstract method (implemented in sub-classes).
1629
+
1630
+ #### Parameters
1631
+
1632
+ ##### value
1633
+
1634
+ `any`
1635
+
1636
+ ##### options?
1637
+
1638
+ `Object`
1639
+
1640
+ #### Returns
1641
+
1642
+ `void`
1643
+
1644
+ #### Inherited from
1645
+
1646
+ `NgAbstractControl.setValue`
1647
+
1648
+ ***
1649
+
1650
+ ### updateValueAndValidity()
1651
+
1652
+ > **updateValueAndValidity**(`opts`?): `void`
1653
+
1654
+ Defined in: node\_modules/@angular/forms/index.d.ts:566
1655
+
1656
+ Recalculates the value and validation status of the control.
1657
+
1658
+ By default, it also updates the value and validity of its ancestors.
1659
+
1660
+ #### Parameters
1661
+
1662
+ ##### opts?
1663
+
1664
+ Configuration options determine how the control propagates changes and emits events
1665
+ after updates and validity checks are applied.
1666
+ * `onlySelf`: When true, only update this control. When false or not supplied,
1667
+ update all direct ancestors. Default is false.
1668
+ * `emitEvent`: When true or not supplied (the default), the `statusChanges`,
1669
+ `valueChanges` and `events`
1670
+ observables emit events with the latest status and value when the control is updated.
1671
+ When false, no events are emitted.
1672
+
1673
+ ###### emitEvent?
1674
+
1675
+ `boolean`
1676
+
1677
+ ###### onlySelf?
1678
+
1679
+ `boolean`
1680
+
1681
+ #### Returns
1682
+
1683
+ `void`
1684
+
1685
+ #### Inherited from
1686
+
1687
+ `NgAbstractControl.updateValueAndValidity`