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