@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,1439 @@
1
+ [@rxap/forms](../wiki/globals) / FormDefinitionArray
2
+
3
+ # Interface: FormDefinitionArray\<T\>
4
+
5
+ Defined in: [packages/angular/forms/src/lib/model.ts:84](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/model.ts#L84)
6
+
7
+ ## Extends
8
+
9
+ - `Array`\<`T`\>
10
+
11
+ ## Type Parameters
12
+
13
+ • **T**
14
+
15
+ ## Indexable
16
+
17
+ \[`n`: `number`\]: `T`
18
+
19
+ ## Properties
20
+
21
+ ### \[unscopables\]
22
+
23
+ > `readonly` **\[unscopables\]**: `object`
24
+
25
+ Defined in: node\_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:97
26
+
27
+ Is an object whose properties have the value 'true'
28
+ when they will be absent when used in a 'with' statement.
29
+
30
+ #### Index Signature
31
+
32
+ \[`key`: `number`\]: `undefined` \| `boolean`
33
+
34
+ #### \[iterator\]?
35
+
36
+ > `optional` **\[iterator\]**: `boolean`
37
+
38
+ #### \[unscopables\]?
39
+
40
+ > `readonly` `optional` **\[unscopables\]**: `boolean`
41
+
42
+ Is an object whose properties have the value 'true'
43
+ when they will be absent when used in a 'with' statement.
44
+
45
+ #### concat?
46
+
47
+ > `optional` **concat**: `boolean`
48
+
49
+ #### copyWithin?
50
+
51
+ > `optional` **copyWithin**: `boolean`
52
+
53
+ #### entries?
54
+
55
+ > `optional` **entries**: `boolean`
56
+
57
+ #### every?
58
+
59
+ > `optional` **every**: `boolean`
60
+
61
+ #### fill?
62
+
63
+ > `optional` **fill**: `boolean`
64
+
65
+ #### filter?
66
+
67
+ > `optional` **filter**: `boolean`
68
+
69
+ #### find?
70
+
71
+ > `optional` **find**: `boolean`
72
+
73
+ #### findIndex?
74
+
75
+ > `optional` **findIndex**: `boolean`
76
+
77
+ #### flat?
78
+
79
+ > `optional` **flat**: `boolean`
80
+
81
+ #### flatMap?
82
+
83
+ > `optional` **flatMap**: `boolean`
84
+
85
+ #### forEach?
86
+
87
+ > `optional` **forEach**: `boolean`
88
+
89
+ #### includes?
90
+
91
+ > `optional` **includes**: `boolean`
92
+
93
+ #### indexOf?
94
+
95
+ > `optional` **indexOf**: `boolean`
96
+
97
+ #### join?
98
+
99
+ > `optional` **join**: `boolean`
100
+
101
+ #### keys?
102
+
103
+ > `optional` **keys**: `boolean`
104
+
105
+ #### lastIndexOf?
106
+
107
+ > `optional` **lastIndexOf**: `boolean`
108
+
109
+ #### length?
110
+
111
+ > `optional` **length**: `boolean`
112
+
113
+ Gets or sets the length of the array. This is a number one higher than the highest index in the array.
114
+
115
+ #### map?
116
+
117
+ > `optional` **map**: `boolean`
118
+
119
+ #### pop?
120
+
121
+ > `optional` **pop**: `boolean`
122
+
123
+ #### push?
124
+
125
+ > `optional` **push**: `boolean`
126
+
127
+ #### reduce?
128
+
129
+ > `optional` **reduce**: `boolean`
130
+
131
+ #### reduceRight?
132
+
133
+ > `optional` **reduceRight**: `boolean`
134
+
135
+ #### reverse?
136
+
137
+ > `optional` **reverse**: `boolean`
138
+
139
+ #### shift?
140
+
141
+ > `optional` **shift**: `boolean`
142
+
143
+ #### slice?
144
+
145
+ > `optional` **slice**: `boolean`
146
+
147
+ #### some?
148
+
149
+ > `optional` **some**: `boolean`
150
+
151
+ #### sort?
152
+
153
+ > `optional` **sort**: `boolean`
154
+
155
+ #### splice?
156
+
157
+ > `optional` **splice**: `boolean`
158
+
159
+ #### toLocaleString?
160
+
161
+ > `optional` **toLocaleString**: `boolean`
162
+
163
+ #### toString?
164
+
165
+ > `optional` **toString**: `boolean`
166
+
167
+ #### unshift?
168
+
169
+ > `optional` **unshift**: `boolean`
170
+
171
+ #### values?
172
+
173
+ > `optional` **values**: `boolean`
174
+
175
+ #### Inherited from
176
+
177
+ `Array.[unscopables]`
178
+
179
+ ***
180
+
181
+ ### length
182
+
183
+ > **length**: `number`
184
+
185
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1326
186
+
187
+ Gets or sets the length of the array. This is a number one higher than the highest index in the array.
188
+
189
+ #### Inherited from
190
+
191
+ `Array.length`
192
+
193
+ ***
194
+
195
+ ### rxapFormArray
196
+
197
+ > **rxapFormArray**: [`RxapFormArray`](../wiki/Class.RxapFormArray)
198
+
199
+ Defined in: [packages/angular/forms/src/lib/model.ts:85](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/model.ts#L85)
200
+
201
+ ## Methods
202
+
203
+ ### \[iterator\]()
204
+
205
+ > **\[iterator\]**(): `ArrayIterator`\<`T`\>
206
+
207
+ Defined in: node\_modules/typescript/lib/lib.es2015.iterable.d.ts:78
208
+
209
+ Iterator
210
+
211
+ #### Returns
212
+
213
+ `ArrayIterator`\<`T`\>
214
+
215
+ #### Inherited from
216
+
217
+ `Array.[iterator]`
218
+
219
+ ***
220
+
221
+ ### concat()
222
+
223
+ #### Call Signature
224
+
225
+ > **concat**(...`items`): `T`[]
226
+
227
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1350
228
+
229
+ Combines two or more arrays.
230
+ This method returns a new array without modifying any existing arrays.
231
+
232
+ ##### Parameters
233
+
234
+ ###### items
235
+
236
+ ...`ConcatArray`\<`T`\>[]
237
+
238
+ Additional arrays and/or items to add to the end of the array.
239
+
240
+ ##### Returns
241
+
242
+ `T`[]
243
+
244
+ ##### Inherited from
245
+
246
+ `Array.concat`
247
+
248
+ #### Call Signature
249
+
250
+ > **concat**(...`items`): `T`[]
251
+
252
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1356
253
+
254
+ Combines two or more arrays.
255
+ This method returns a new array without modifying any existing arrays.
256
+
257
+ ##### Parameters
258
+
259
+ ###### items
260
+
261
+ ...(`T` \| `ConcatArray`\<`T`\>)[]
262
+
263
+ Additional arrays and/or items to add to the end of the array.
264
+
265
+ ##### Returns
266
+
267
+ `T`[]
268
+
269
+ ##### Inherited from
270
+
271
+ `Array.concat`
272
+
273
+ ***
274
+
275
+ ### copyWithin()
276
+
277
+ > **copyWithin**(`target`, `start`, `end`?): `this`
278
+
279
+ Defined in: node\_modules/typescript/lib/lib.es2015.core.d.ts:62
280
+
281
+ Returns the this object after copying a section of the array identified by start and end
282
+ to the same array starting at position target
283
+
284
+ #### Parameters
285
+
286
+ ##### target
287
+
288
+ `number`
289
+
290
+ If target is negative, it is treated as length+target where length is the
291
+ length of the array.
292
+
293
+ ##### start
294
+
295
+ `number`
296
+
297
+ If start is negative, it is treated as length+start. If end is negative, it
298
+ is treated as length+end.
299
+
300
+ ##### end?
301
+
302
+ `number`
303
+
304
+ If not specified, length of the this object is used as its default value.
305
+
306
+ #### Returns
307
+
308
+ `this`
309
+
310
+ #### Inherited from
311
+
312
+ `Array.copyWithin`
313
+
314
+ ***
315
+
316
+ ### entries()
317
+
318
+ > **entries**(): `ArrayIterator`\<\[`number`, `T`\]\>
319
+
320
+ Defined in: node\_modules/typescript/lib/lib.es2015.iterable.d.ts:83
321
+
322
+ Returns an iterable of key, value pairs for every entry in the array
323
+
324
+ #### Returns
325
+
326
+ `ArrayIterator`\<\[`number`, `T`\]\>
327
+
328
+ #### Inherited from
329
+
330
+ `Array.entries`
331
+
332
+ ***
333
+
334
+ ### every()
335
+
336
+ #### Call Signature
337
+
338
+ > **every**\<`S`\>(`predicate`, `thisArg`?): `this is S[]`
339
+
340
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1433
341
+
342
+ Determines whether all the members of an array satisfy the specified test.
343
+
344
+ ##### Type Parameters
345
+
346
+ • **S**
347
+
348
+ ##### Parameters
349
+
350
+ ###### predicate
351
+
352
+ (`value`, `index`, `array`) => `value is S`
353
+
354
+ A function that accepts up to three arguments. The every method calls
355
+ the predicate function for each element in the array until the predicate returns a value
356
+ which is coercible to the Boolean value false, or until the end of the array.
357
+
358
+ ###### thisArg?
359
+
360
+ `any`
361
+
362
+ An object to which the this keyword can refer in the predicate function.
363
+ If thisArg is omitted, undefined is used as the this value.
364
+
365
+ ##### Returns
366
+
367
+ `this is S[]`
368
+
369
+ ##### Inherited from
370
+
371
+ `Array.every`
372
+
373
+ #### Call Signature
374
+
375
+ > **every**(`predicate`, `thisArg`?): `boolean`
376
+
377
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1442
378
+
379
+ Determines whether all the members of an array satisfy the specified test.
380
+
381
+ ##### Parameters
382
+
383
+ ###### predicate
384
+
385
+ (`value`, `index`, `array`) => `unknown`
386
+
387
+ A function that accepts up to three arguments. The every method calls
388
+ the predicate function for each element in the array until the predicate returns a value
389
+ which is coercible to the Boolean value false, or until the end of the array.
390
+
391
+ ###### thisArg?
392
+
393
+ `any`
394
+
395
+ An object to which the this keyword can refer in the predicate function.
396
+ If thisArg is omitted, undefined is used as the this value.
397
+
398
+ ##### Returns
399
+
400
+ `boolean`
401
+
402
+ ##### Inherited from
403
+
404
+ `Array.every`
405
+
406
+ ***
407
+
408
+ ### fill()
409
+
410
+ > **fill**(`value`, `start`?, `end`?): `this`
411
+
412
+ Defined in: node\_modules/typescript/lib/lib.es2015.core.d.ts:51
413
+
414
+ Changes all array elements from `start` to `end` index to a static `value` and returns the modified array
415
+
416
+ #### Parameters
417
+
418
+ ##### value
419
+
420
+ `T`
421
+
422
+ value to fill array section with
423
+
424
+ ##### start?
425
+
426
+ `number`
427
+
428
+ index to start filling the array at. If start is negative, it is treated as
429
+ length+start where length is the length of the array.
430
+
431
+ ##### end?
432
+
433
+ `number`
434
+
435
+ index to stop filling the array at. If end is negative, it is treated as
436
+ length+end.
437
+
438
+ #### Returns
439
+
440
+ `this`
441
+
442
+ #### Inherited from
443
+
444
+ `Array.fill`
445
+
446
+ ***
447
+
448
+ ### filter()
449
+
450
+ #### Call Signature
451
+
452
+ > **filter**\<`S`\>(`predicate`, `thisArg`?): `S`[]
453
+
454
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1469
455
+
456
+ Returns the elements of an array that meet the condition specified in a callback function.
457
+
458
+ ##### Type Parameters
459
+
460
+ • **S**
461
+
462
+ ##### Parameters
463
+
464
+ ###### predicate
465
+
466
+ (`value`, `index`, `array`) => `value is S`
467
+
468
+ A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
469
+
470
+ ###### thisArg?
471
+
472
+ `any`
473
+
474
+ An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
475
+
476
+ ##### Returns
477
+
478
+ `S`[]
479
+
480
+ ##### Inherited from
481
+
482
+ `Array.filter`
483
+
484
+ #### Call Signature
485
+
486
+ > **filter**(`predicate`, `thisArg`?): `T`[]
487
+
488
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1475
489
+
490
+ Returns the elements of an array that meet the condition specified in a callback function.
491
+
492
+ ##### Parameters
493
+
494
+ ###### predicate
495
+
496
+ (`value`, `index`, `array`) => `unknown`
497
+
498
+ A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
499
+
500
+ ###### thisArg?
501
+
502
+ `any`
503
+
504
+ An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
505
+
506
+ ##### Returns
507
+
508
+ `T`[]
509
+
510
+ ##### Inherited from
511
+
512
+ `Array.filter`
513
+
514
+ ***
515
+
516
+ ### find()
517
+
518
+ #### Call Signature
519
+
520
+ > **find**\<`S`\>(`predicate`, `thisArg`?): `undefined` \| `S`
521
+
522
+ Defined in: node\_modules/typescript/lib/lib.es2015.core.d.ts:29
523
+
524
+ Returns the value of the first element in the array where predicate is true, and undefined
525
+ otherwise.
526
+
527
+ ##### Type Parameters
528
+
529
+ • **S**
530
+
531
+ ##### Parameters
532
+
533
+ ###### predicate
534
+
535
+ (`value`, `index`, `obj`) => `value is S`
536
+
537
+ find calls predicate once for each element of the array, in ascending
538
+ order, until it finds one where predicate returns true. If such an element is found, find
539
+ immediately returns that element value. Otherwise, find returns undefined.
540
+
541
+ ###### thisArg?
542
+
543
+ `any`
544
+
545
+ If provided, it will be used as the this value for each invocation of
546
+ predicate. If it is not provided, undefined is used instead.
547
+
548
+ ##### Returns
549
+
550
+ `undefined` \| `S`
551
+
552
+ ##### Inherited from
553
+
554
+ `Array.find`
555
+
556
+ #### Call Signature
557
+
558
+ > **find**(`predicate`, `thisArg`?): `undefined` \| `T`
559
+
560
+ Defined in: node\_modules/typescript/lib/lib.es2015.core.d.ts:30
561
+
562
+ ##### Parameters
563
+
564
+ ###### predicate
565
+
566
+ (`value`, `index`, `obj`) => `unknown`
567
+
568
+ ###### thisArg?
569
+
570
+ `any`
571
+
572
+ ##### Returns
573
+
574
+ `undefined` \| `T`
575
+
576
+ ##### Inherited from
577
+
578
+ `Array.find`
579
+
580
+ ***
581
+
582
+ ### findIndex()
583
+
584
+ > **findIndex**(`predicate`, `thisArg`?): `number`
585
+
586
+ Defined in: node\_modules/typescript/lib/lib.es2015.core.d.ts:41
587
+
588
+ Returns the index of the first element in the array where predicate is true, and -1
589
+ otherwise.
590
+
591
+ #### Parameters
592
+
593
+ ##### predicate
594
+
595
+ (`value`, `index`, `obj`) => `unknown`
596
+
597
+ find calls predicate once for each element of the array, in ascending
598
+ order, until it finds one where predicate returns true. If such an element is found,
599
+ findIndex immediately returns that element index. Otherwise, findIndex returns -1.
600
+
601
+ ##### thisArg?
602
+
603
+ `any`
604
+
605
+ If provided, it will be used as the this value for each invocation of
606
+ predicate. If it is not provided, undefined is used instead.
607
+
608
+ #### Returns
609
+
610
+ `number`
611
+
612
+ #### Inherited from
613
+
614
+ `Array.findIndex`
615
+
616
+ ***
617
+
618
+ ### flat()
619
+
620
+ > **flat**\<`A`, `D`\>(`this`, `depth`?): `FlatArray`\<`A`, `D`\>[]
621
+
622
+ Defined in: node\_modules/typescript/lib/lib.es2019.array.d.ts:75
623
+
624
+ Returns a new array with all sub-array elements concatenated into it recursively up to the
625
+ specified depth.
626
+
627
+ #### Type Parameters
628
+
629
+ • **A**
630
+
631
+ • **D** *extends* `number` = `1`
632
+
633
+ #### Parameters
634
+
635
+ ##### this
636
+
637
+ `A`
638
+
639
+ ##### depth?
640
+
641
+ `D`
642
+
643
+ The maximum recursion depth
644
+
645
+ #### Returns
646
+
647
+ `FlatArray`\<`A`, `D`\>[]
648
+
649
+ #### Inherited from
650
+
651
+ `Array.flat`
652
+
653
+ ***
654
+
655
+ ### flatMap()
656
+
657
+ > **flatMap**\<`U`, `This`\>(`callback`, `thisArg`?): `U`[]
658
+
659
+ Defined in: node\_modules/typescript/lib/lib.es2019.array.d.ts:64
660
+
661
+ Calls a defined callback function on each element of an array. Then, flattens the result into
662
+ a new array.
663
+ This is identical to a map followed by flat with depth 1.
664
+
665
+ #### Type Parameters
666
+
667
+ • **U**
668
+
669
+ • **This** = `undefined`
670
+
671
+ #### Parameters
672
+
673
+ ##### callback
674
+
675
+ (`this`, `value`, `index`, `array`) => `U` \| readonly `U`[]
676
+
677
+ A function that accepts up to three arguments. The flatMap method calls the
678
+ callback function one time for each element in the array.
679
+
680
+ ##### thisArg?
681
+
682
+ `This`
683
+
684
+ An object to which the this keyword can refer in the callback function. If
685
+ thisArg is omitted, undefined is used as the this value.
686
+
687
+ #### Returns
688
+
689
+ `U`[]
690
+
691
+ #### Inherited from
692
+
693
+ `Array.flatMap`
694
+
695
+ ***
696
+
697
+ ### forEach()
698
+
699
+ > **forEach**(`callbackfn`, `thisArg`?): `void`
700
+
701
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1457
702
+
703
+ Performs the specified action for each element in an array.
704
+
705
+ #### Parameters
706
+
707
+ ##### callbackfn
708
+
709
+ (`value`, `index`, `array`) => `void`
710
+
711
+ A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
712
+
713
+ ##### thisArg?
714
+
715
+ `any`
716
+
717
+ An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
718
+
719
+ #### Returns
720
+
721
+ `void`
722
+
723
+ #### Inherited from
724
+
725
+ `Array.forEach`
726
+
727
+ ***
728
+
729
+ ### includes()
730
+
731
+ > **includes**(`searchElement`, `fromIndex`?): `boolean`
732
+
733
+ Defined in: node\_modules/typescript/lib/lib.es2016.array.include.d.ts:25
734
+
735
+ Determines whether an array includes a certain element, returning true or false as appropriate.
736
+
737
+ #### Parameters
738
+
739
+ ##### searchElement
740
+
741
+ `T`
742
+
743
+ The element to search for.
744
+
745
+ ##### fromIndex?
746
+
747
+ `number`
748
+
749
+ The position in this array at which to begin searching for searchElement.
750
+
751
+ #### Returns
752
+
753
+ `boolean`
754
+
755
+ #### Inherited from
756
+
757
+ `Array.includes`
758
+
759
+ ***
760
+
761
+ ### indexOf()
762
+
763
+ > **indexOf**(`searchElement`, `fromIndex`?): `number`
764
+
765
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1418
766
+
767
+ Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
768
+
769
+ #### Parameters
770
+
771
+ ##### searchElement
772
+
773
+ `T`
774
+
775
+ The value to locate in the array.
776
+
777
+ ##### fromIndex?
778
+
779
+ `number`
780
+
781
+ The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
782
+
783
+ #### Returns
784
+
785
+ `number`
786
+
787
+ #### Inherited from
788
+
789
+ `Array.indexOf`
790
+
791
+ ***
792
+
793
+ ### join()
794
+
795
+ > **join**(`separator`?): `string`
796
+
797
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1361
798
+
799
+ Adds all the elements of an array into a string, separated by the specified separator string.
800
+
801
+ #### Parameters
802
+
803
+ ##### separator?
804
+
805
+ `string`
806
+
807
+ A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.
808
+
809
+ #### Returns
810
+
811
+ `string`
812
+
813
+ #### Inherited from
814
+
815
+ `Array.join`
816
+
817
+ ***
818
+
819
+ ### keys()
820
+
821
+ > **keys**(): `ArrayIterator`\<`number`\>
822
+
823
+ Defined in: node\_modules/typescript/lib/lib.es2015.iterable.d.ts:88
824
+
825
+ Returns an iterable of keys in the array
826
+
827
+ #### Returns
828
+
829
+ `ArrayIterator`\<`number`\>
830
+
831
+ #### Inherited from
832
+
833
+ `Array.keys`
834
+
835
+ ***
836
+
837
+ ### lastIndexOf()
838
+
839
+ > **lastIndexOf**(`searchElement`, `fromIndex`?): `number`
840
+
841
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1424
842
+
843
+ Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
844
+
845
+ #### Parameters
846
+
847
+ ##### searchElement
848
+
849
+ `T`
850
+
851
+ The value to locate in the array.
852
+
853
+ ##### fromIndex?
854
+
855
+ `number`
856
+
857
+ The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.
858
+
859
+ #### Returns
860
+
861
+ `number`
862
+
863
+ #### Inherited from
864
+
865
+ `Array.lastIndexOf`
866
+
867
+ ***
868
+
869
+ ### map()
870
+
871
+ > **map**\<`U`\>(`callbackfn`, `thisArg`?): `U`[]
872
+
873
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1463
874
+
875
+ Calls a defined callback function on each element of an array, and returns an array that contains the results.
876
+
877
+ #### Type Parameters
878
+
879
+ • **U**
880
+
881
+ #### Parameters
882
+
883
+ ##### callbackfn
884
+
885
+ (`value`, `index`, `array`) => `U`
886
+
887
+ A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
888
+
889
+ ##### thisArg?
890
+
891
+ `any`
892
+
893
+ An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
894
+
895
+ #### Returns
896
+
897
+ `U`[]
898
+
899
+ #### Inherited from
900
+
901
+ `Array.map`
902
+
903
+ ***
904
+
905
+ ### pop()
906
+
907
+ > **pop**(): `undefined` \| `T`
908
+
909
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1339
910
+
911
+ Removes the last element from an array and returns it.
912
+ If the array is empty, undefined is returned and the array is not modified.
913
+
914
+ #### Returns
915
+
916
+ `undefined` \| `T`
917
+
918
+ #### Inherited from
919
+
920
+ `Array.pop`
921
+
922
+ ***
923
+
924
+ ### push()
925
+
926
+ > **push**(...`items`): `number`
927
+
928
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1344
929
+
930
+ Appends new elements to the end of an array, and returns the new length of the array.
931
+
932
+ #### Parameters
933
+
934
+ ##### items
935
+
936
+ ...`T`[]
937
+
938
+ New elements to add to the array.
939
+
940
+ #### Returns
941
+
942
+ `number`
943
+
944
+ #### Inherited from
945
+
946
+ `Array.push`
947
+
948
+ ***
949
+
950
+ ### reduce()
951
+
952
+ #### Call Signature
953
+
954
+ > **reduce**(`callbackfn`): `T`
955
+
956
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1481
957
+
958
+ Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
959
+
960
+ ##### Parameters
961
+
962
+ ###### callbackfn
963
+
964
+ (`previousValue`, `currentValue`, `currentIndex`, `array`) => `T`
965
+
966
+ A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
967
+
968
+ ##### Returns
969
+
970
+ `T`
971
+
972
+ ##### Inherited from
973
+
974
+ `Array.reduce`
975
+
976
+ #### Call Signature
977
+
978
+ > **reduce**(`callbackfn`, `initialValue`): `T`
979
+
980
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1482
981
+
982
+ ##### Parameters
983
+
984
+ ###### callbackfn
985
+
986
+ (`previousValue`, `currentValue`, `currentIndex`, `array`) => `T`
987
+
988
+ ###### initialValue
989
+
990
+ `T`
991
+
992
+ ##### Returns
993
+
994
+ `T`
995
+
996
+ ##### Inherited from
997
+
998
+ `Array.reduce`
999
+
1000
+ #### Call Signature
1001
+
1002
+ > **reduce**\<`U`\>(`callbackfn`, `initialValue`): `U`
1003
+
1004
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1488
1005
+
1006
+ Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
1007
+
1008
+ ##### Type Parameters
1009
+
1010
+ • **U**
1011
+
1012
+ ##### Parameters
1013
+
1014
+ ###### callbackfn
1015
+
1016
+ (`previousValue`, `currentValue`, `currentIndex`, `array`) => `U`
1017
+
1018
+ A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
1019
+
1020
+ ###### initialValue
1021
+
1022
+ `U`
1023
+
1024
+ If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
1025
+
1026
+ ##### Returns
1027
+
1028
+ `U`
1029
+
1030
+ ##### Inherited from
1031
+
1032
+ `Array.reduce`
1033
+
1034
+ ***
1035
+
1036
+ ### reduceRight()
1037
+
1038
+ #### Call Signature
1039
+
1040
+ > **reduceRight**(`callbackfn`): `T`
1041
+
1042
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1494
1043
+
1044
+ Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
1045
+
1046
+ ##### Parameters
1047
+
1048
+ ###### callbackfn
1049
+
1050
+ (`previousValue`, `currentValue`, `currentIndex`, `array`) => `T`
1051
+
1052
+ A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
1053
+
1054
+ ##### Returns
1055
+
1056
+ `T`
1057
+
1058
+ ##### Inherited from
1059
+
1060
+ `Array.reduceRight`
1061
+
1062
+ #### Call Signature
1063
+
1064
+ > **reduceRight**(`callbackfn`, `initialValue`): `T`
1065
+
1066
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1495
1067
+
1068
+ ##### Parameters
1069
+
1070
+ ###### callbackfn
1071
+
1072
+ (`previousValue`, `currentValue`, `currentIndex`, `array`) => `T`
1073
+
1074
+ ###### initialValue
1075
+
1076
+ `T`
1077
+
1078
+ ##### Returns
1079
+
1080
+ `T`
1081
+
1082
+ ##### Inherited from
1083
+
1084
+ `Array.reduceRight`
1085
+
1086
+ #### Call Signature
1087
+
1088
+ > **reduceRight**\<`U`\>(`callbackfn`, `initialValue`): `U`
1089
+
1090
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1501
1091
+
1092
+ Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
1093
+
1094
+ ##### Type Parameters
1095
+
1096
+ • **U**
1097
+
1098
+ ##### Parameters
1099
+
1100
+ ###### callbackfn
1101
+
1102
+ (`previousValue`, `currentValue`, `currentIndex`, `array`) => `U`
1103
+
1104
+ A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
1105
+
1106
+ ###### initialValue
1107
+
1108
+ `U`
1109
+
1110
+ If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
1111
+
1112
+ ##### Returns
1113
+
1114
+ `U`
1115
+
1116
+ ##### Inherited from
1117
+
1118
+ `Array.reduceRight`
1119
+
1120
+ ***
1121
+
1122
+ ### reverse()
1123
+
1124
+ > **reverse**(): `T`[]
1125
+
1126
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1366
1127
+
1128
+ Reverses the elements in an array in place.
1129
+ This method mutates the array and returns a reference to the same array.
1130
+
1131
+ #### Returns
1132
+
1133
+ `T`[]
1134
+
1135
+ #### Inherited from
1136
+
1137
+ `Array.reverse`
1138
+
1139
+ ***
1140
+
1141
+ ### shift()
1142
+
1143
+ > **shift**(): `undefined` \| `T`
1144
+
1145
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1371
1146
+
1147
+ Removes the first element from an array and returns it.
1148
+ If the array is empty, undefined is returned and the array is not modified.
1149
+
1150
+ #### Returns
1151
+
1152
+ `undefined` \| `T`
1153
+
1154
+ #### Inherited from
1155
+
1156
+ `Array.shift`
1157
+
1158
+ ***
1159
+
1160
+ ### slice()
1161
+
1162
+ > **slice**(`start`?, `end`?): `T`[]
1163
+
1164
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1381
1165
+
1166
+ Returns a copy of a section of an array.
1167
+ For both start and end, a negative index can be used to indicate an offset from the end of the array.
1168
+ For example, -2 refers to the second to last element of the array.
1169
+
1170
+ #### Parameters
1171
+
1172
+ ##### start?
1173
+
1174
+ `number`
1175
+
1176
+ The beginning index of the specified portion of the array.
1177
+ If start is undefined, then the slice begins at index 0.
1178
+
1179
+ ##### end?
1180
+
1181
+ `number`
1182
+
1183
+ The end index of the specified portion of the array. This is exclusive of the element at the index 'end'.
1184
+ If end is undefined, then the slice extends to the end of the array.
1185
+
1186
+ #### Returns
1187
+
1188
+ `T`[]
1189
+
1190
+ #### Inherited from
1191
+
1192
+ `Array.slice`
1193
+
1194
+ ***
1195
+
1196
+ ### some()
1197
+
1198
+ > **some**(`predicate`, `thisArg`?): `boolean`
1199
+
1200
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1451
1201
+
1202
+ Determines whether the specified callback function returns true for any element of an array.
1203
+
1204
+ #### Parameters
1205
+
1206
+ ##### predicate
1207
+
1208
+ (`value`, `index`, `array`) => `unknown`
1209
+
1210
+ A function that accepts up to three arguments. The some method calls
1211
+ the predicate function for each element in the array until the predicate returns a value
1212
+ which is coercible to the Boolean value true, or until the end of the array.
1213
+
1214
+ ##### thisArg?
1215
+
1216
+ `any`
1217
+
1218
+ An object to which the this keyword can refer in the predicate function.
1219
+ If thisArg is omitted, undefined is used as the this value.
1220
+
1221
+ #### Returns
1222
+
1223
+ `boolean`
1224
+
1225
+ #### Inherited from
1226
+
1227
+ `Array.some`
1228
+
1229
+ ***
1230
+
1231
+ ### sort()
1232
+
1233
+ > **sort**(`compareFn`?): `this`
1234
+
1235
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1392
1236
+
1237
+ Sorts an array in place.
1238
+ This method mutates the array and returns a reference to the same array.
1239
+
1240
+ #### Parameters
1241
+
1242
+ ##### compareFn?
1243
+
1244
+ (`a`, `b`) => `number`
1245
+
1246
+ Function used to determine the order of the elements. It is expected to return
1247
+ a negative value if the first argument is less than the second argument, zero if they're equal, and a positive
1248
+ value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.
1249
+ ```ts
1250
+ [11,2,22,1].sort((a, b) => a - b)
1251
+ ```
1252
+
1253
+ #### Returns
1254
+
1255
+ `this`
1256
+
1257
+ #### Inherited from
1258
+
1259
+ `Array.sort`
1260
+
1261
+ ***
1262
+
1263
+ ### splice()
1264
+
1265
+ #### Call Signature
1266
+
1267
+ > **splice**(`start`, `deleteCount`?): `T`[]
1268
+
1269
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1399
1270
+
1271
+ Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
1272
+
1273
+ ##### Parameters
1274
+
1275
+ ###### start
1276
+
1277
+ `number`
1278
+
1279
+ The zero-based location in the array from which to start removing elements.
1280
+
1281
+ ###### deleteCount?
1282
+
1283
+ `number`
1284
+
1285
+ The number of elements to remove.
1286
+
1287
+ ##### Returns
1288
+
1289
+ `T`[]
1290
+
1291
+ An array containing the elements that were deleted.
1292
+
1293
+ ##### Inherited from
1294
+
1295
+ `Array.splice`
1296
+
1297
+ #### Call Signature
1298
+
1299
+ > **splice**(`start`, `deleteCount`, ...`items`): `T`[]
1300
+
1301
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1407
1302
+
1303
+ Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
1304
+
1305
+ ##### Parameters
1306
+
1307
+ ###### start
1308
+
1309
+ `number`
1310
+
1311
+ The zero-based location in the array from which to start removing elements.
1312
+
1313
+ ###### deleteCount
1314
+
1315
+ `number`
1316
+
1317
+ The number of elements to remove.
1318
+
1319
+ ###### items
1320
+
1321
+ ...`T`[]
1322
+
1323
+ Elements to insert into the array in place of the deleted elements.
1324
+
1325
+ ##### Returns
1326
+
1327
+ `T`[]
1328
+
1329
+ An array containing the elements that were deleted.
1330
+
1331
+ ##### Inherited from
1332
+
1333
+ `Array.splice`
1334
+
1335
+ ***
1336
+
1337
+ ### toLocaleString()
1338
+
1339
+ #### Call Signature
1340
+
1341
+ > **toLocaleString**(): `string`
1342
+
1343
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1334
1344
+
1345
+ Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.
1346
+
1347
+ ##### Returns
1348
+
1349
+ `string`
1350
+
1351
+ ##### Inherited from
1352
+
1353
+ `Array.toLocaleString`
1354
+
1355
+ #### Call Signature
1356
+
1357
+ > **toLocaleString**(`locales`, `options`?): `string`
1358
+
1359
+ Defined in: node\_modules/typescript/lib/lib.es2015.core.d.ts:64
1360
+
1361
+ ##### Parameters
1362
+
1363
+ ###### locales
1364
+
1365
+ `string` | `string`[]
1366
+
1367
+ ###### options?
1368
+
1369
+ `NumberFormatOptions` & `DateTimeFormatOptions`
1370
+
1371
+ ##### Returns
1372
+
1373
+ `string`
1374
+
1375
+ ##### Inherited from
1376
+
1377
+ `Array.toLocaleString`
1378
+
1379
+ ***
1380
+
1381
+ ### toString()
1382
+
1383
+ > **toString**(): `string`
1384
+
1385
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1330
1386
+
1387
+ Returns a string representation of an array.
1388
+
1389
+ #### Returns
1390
+
1391
+ `string`
1392
+
1393
+ #### Inherited from
1394
+
1395
+ `Array.toString`
1396
+
1397
+ ***
1398
+
1399
+ ### unshift()
1400
+
1401
+ > **unshift**(...`items`): `number`
1402
+
1403
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1412
1404
+
1405
+ Inserts new elements at the start of an array, and returns the new length of the array.
1406
+
1407
+ #### Parameters
1408
+
1409
+ ##### items
1410
+
1411
+ ...`T`[]
1412
+
1413
+ Elements to insert at the start of the array.
1414
+
1415
+ #### Returns
1416
+
1417
+ `number`
1418
+
1419
+ #### Inherited from
1420
+
1421
+ `Array.unshift`
1422
+
1423
+ ***
1424
+
1425
+ ### values()
1426
+
1427
+ > **values**(): `ArrayIterator`\<`T`\>
1428
+
1429
+ Defined in: node\_modules/typescript/lib/lib.es2015.iterable.d.ts:93
1430
+
1431
+ Returns an iterable of values in the array
1432
+
1433
+ #### Returns
1434
+
1435
+ `ArrayIterator`\<`T`\>
1436
+
1437
+ #### Inherited from
1438
+
1439
+ `Array.values`