@rxap/forms 19.0.1-dev.2 → 19.0.1-dev.5

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