@rxap/forms
Version:
This package provides a set of tools and directives to simplify working with Angular forms, including reactive forms, custom validators, and form directives for handling loading, submitting, and error states. It offers decorators for defining forms and co
1,171 lines (1,041 loc) • 163 kB
HTML
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>angular-forms</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/style.css">
<link rel="stylesheet" href="../styles/dark.css">
</head>
<body>
<script>
// Blocking script to avoid flickering dark mode
// Dark mode toggle button
var useDark = window.matchMedia('(prefers-color-scheme: dark)');
var darkModeState = useDark.matches;
var $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
var $darkModeToggles = document.querySelectorAll('.dark-mode-switch');
var darkModeStateLocal = localStorage.getItem('compodoc_darkmode-state');
function checkToggle(check) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].checked = check;
}
}
function toggleDarkMode(state) {
if (window.localStorage) {
localStorage.setItem('compodoc_darkmode-state', state);
}
checkToggle(state);
const hasClass = document.body.classList.contains('dark');
if (state) {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.add('dark');
}
if (!hasClass) {
document.body.classList.add('dark');
}
} else {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.remove('dark');
}
if (hasClass) {
document.body.classList.remove('dark');
}
}
}
useDark.addEventListener('change', function (evt) {
toggleDarkMode(evt.matches);
});
if (darkModeStateLocal) {
darkModeState = darkModeStateLocal === 'true';
}
toggleDarkMode(darkModeState);
</script>
<div class="navbar navbar-default navbar-fixed-top d-md-none p-0">
<div class="d-flex">
<a href="../" class="navbar-brand">angular-forms</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
</div>
<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="d-none d-md-block menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content class">
<div class="content-data">
<ol class="breadcrumb">
<li class="breadcrumb-item">Classes</li>
<li class="breadcrumb-item" >RxapFormArray</li>
</ol>
<ul class="nav nav-tabs" role="tablist">
<li class="nav-item">
<a href="#info"
class="nav-link"
class="nav-link active"
role="tab" id="info-tab" data-bs-toggle="tab" data-link="info">Info</a>
</li>
<li class="nav-item">
<a href="#source"
class="nav-link"
role="tab" id="source-tab" data-bs-toggle="tab" data-link="source">Source</a>
</li>
</ul>
<div class="tab-content">
<div class="tab-pane fade active in" id="info">
<p class="comment">
<h3>File</h3>
</p>
<p class="comment">
<code>src/lib/form-array.ts</code>
</p>
<p class="comment">
<h3>Extends</h3>
</p>
<p class="comment">
<code>UntypedFormArray</code>
</p>
<p class="comment">
<h3>Implements</h3>
</p>
<p class="comment">
<code><a href="../interfaces/AbstractControl.html" target="_self" >AbstractControl</a></code>
</p>
<section data-compodoc="block-index">
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<tr>
<td class="col-md-4">
<h6><b>Properties</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<a href="#controlId" >controlId</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier"></span>
<a href="#controls" >controls</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<a href="#dirty$" >dirty$</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<a href="#disabled$" >disabled$</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<a href="#enabled$" >enabled$</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier"></span>
<span class="modifier">Readonly</span>
<a href="#errors" >errors</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<a href="#errors$" >errors$</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier"></span>
<span class="modifier">Readonly</span>
<a href="#status" >status</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<a href="#status$" >status$</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier"></span>
<span class="modifier">Readonly</span>
<a href="#statusChanges" >statusChanges</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<a href="#touch$" >touch$</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier"></span>
<span class="modifier">Readonly</span>
<a href="#value" >value</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<a href="#value$" >value$</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier"></span>
<span class="modifier">Readonly</span>
<a href="#valueChanges" >valueChanges</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Methods</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier">Public</span>
<span class="modifier"></span>
<a href="#at" >at</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#disabledWhile" >disabledWhile</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#enabledWhile" >enabledWhile</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier"></span>
<a href="#getError" >getError</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier"></span>
<a href="#getRawValue" >getRawValue</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier"></span>
<a href="#hasError" >hasError</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#hasErrorAndDirty" >hasErrorAndDirty</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#hasErrorAndTouched" >hasErrorAndTouched</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier"></span>
<a href="#insert" >insert</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#insertAt" >insertAt</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#markAllAsDirty" >markAllAsDirty</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#markAllAsPristine" >markAllAsPristine</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#markAllAsUntouched" >markAllAsUntouched</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier"></span>
<a href="#markAsDirty" >markAsDirty</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier"></span>
<a href="#markAsPristine" >markAsPristine</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier"></span>
<a href="#markAsTouched" >markAsTouched</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier"></span>
<a href="#markAsUntouched" >markAsUntouched</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#mergeAsyncValidators" >mergeAsyncValidators</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#mergeValidators" >mergeValidators</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier"></span>
<a href="#patchValue" >patchValue</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier"></span>
<a href="#push" >push</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier"></span>
<a href="#removeAt" >removeAt</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier"></span>
<a href="#reset" >reset</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#select" >select</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier"></span>
<a href="#setAsyncValidators" >setAsyncValidators</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier"></span>
<a href="#setControl" >setControl</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#setDisable" >setDisable</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#setEnable" >setEnable</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier"></span>
<a href="#setErrors" >setErrors</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier"></span>
<a href="#setValidators" >setValidators</a>
</li>
<li>
<span class="modifier">Public</span>
<span class="modifier"></span>
<a href="#setValue" >setValue</a>
</li>
<li>
<span class="modifier">Public</span>
<a href="#validateOn" >validateOn</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Accessors</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#readonly" >readonly</a>
</li>
<li>
<a href="#controlPath" >controlPath</a>
</li>
<li>
<a href="#fullControlPath" >fullControlPath</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-constructor">
<h3 id="constructor">Constructor</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<code>constructor(controls: <a href="../interfaces/AbstractControl.html" target="_self">Array<AbstractControl<T>></a>, options: <a href="../interfaces/FormArrayOptions.html" target="_self">FormArrayOptions</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="129" class="link-to-prism">src/lib/form-array.ts:129</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div>
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>controls</td>
<td>
<code><a href="../interfaces/AbstractControl.html" target="_self" >Array<AbstractControl<T>></a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>options</td>
<td>
<code><a href="../interfaces/FormArrayOptions.html" target="_self" >FormArrayOptions</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-properties">
<h3 id="inputs">
Properties
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="controlId"></a>
<span class="name">
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<span ><b>controlId</b></span>
<a href="#controlId"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="118" class="link-to-prism">src/lib/form-array.ts:118</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="controls"></a>
<span class="name">
<span class="modifier">Public</span>
<span class="modifier"></span>
<span ><b>controls</b></span>
<a href="#controls"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="../interfaces/AbstractControl.html" target="_self" >Array<AbstractControl<T>></a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="132" class="link-to-prism">src/lib/form-array.ts:132</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="dirty$"></a>
<span class="name">
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<span ><b>dirty$</b></span>
<a href="#dirty$"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>this.dirtyChanges
.asObservable()
.pipe(distinctUntilChanged())</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="124" class="link-to-prism">src/lib/form-array.ts:124</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="disabled$"></a>
<span class="name">
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<span ><b>disabled$</b></span>
<a href="#disabled$"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>controlDisabled$(this)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="112" class="link-to-prism">src/lib/form-array.ts:112</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="enabled$"></a>
<span class="name">
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<span ><b>enabled$</b></span>
<a href="#enabled$"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>controlEnabled$(this)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="114" class="link-to-prism">src/lib/form-array.ts:114</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="errors"></a>
<span class="name">
<span class="modifier">Public</span>
<span class="modifier"></span>
<span class="modifier">Readonly</span>
<span ><b>errors</b></span>
<a href="#errors"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>E | null</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="115" class="link-to-prism">src/lib/form-array.ts:115</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="errors$"></a>
<span class="name">
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<span ><b>errors$</b></span>
<a href="#errors$"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>controlErrorChanges$<E>(this)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="117" class="link-to-prism">src/lib/form-array.ts:117</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="status"></a>
<span class="name">
<span class="modifier">Public</span>
<span class="modifier"></span>
<span class="modifier">Readonly</span>
<span ><b>status</b></span>
<a href="#status"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="../miscellaneous/typealiases.html#ControlState" target="_self" >ControlState</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="111" class="link-to-prism">src/lib/form-array.ts:111</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="status$"></a>
<span class="name">
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<span ><b>status$</b></span>
<a href="#status$"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>controlStatusChanges$(this)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="116" class="link-to-prism">src/lib/form-array.ts:116</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="statusChanges"></a>
<span class="name">
<span class="modifier">Public</span>
<span class="modifier"></span>
<span class="modifier">Readonly</span>
<span ><b>statusChanges</b></span>
<a href="#statusChanges"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="../miscellaneous/typealiases.html#ControlState" target="_self" >Observable<ControlState></a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="113" class="link-to-prism">src/lib/form-array.ts:113</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="touch$"></a>
<span class="name">
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<span ><b>touch$</b></span>
<a href="#touch$"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>this.touchChanges
.asObservable()
.pipe(distinctUntilChanged())</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="120" class="link-to-prism">src/lib/form-array.ts:120</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="value"></a>
<span class="name">
<span class="modifier">Public</span>
<span class="modifier"></span>
<span class="modifier">Readonly</span>
<span ><b>value</b></span>
<a href="#value"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>T[]</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="95" class="link-to-prism">src/lib/form-array.ts:95</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="value$"></a>
<span class="name">
<span class="modifier">Public</span>
<span class="modifier">Readonly</span>
<span ><b>value$</b></span>
<a href="#value$"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>controlValueChanges$<T[]>(this)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="109" class="link-to-prism">src/lib/form-array.ts:109</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="valueChanges"></a>
<span class="name">
<span class="modifier">Public</span>
<span class="modifier"></span>
<span class="modifier">Readonly</span>
<span ><b>valueChanges</b></span>
<a href="#valueChanges"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>Observable<T[]></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="107" class="link-to-prism">src/lib/form-array.ts:107</a></div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-methods">
<h3 id="methods">
Methods
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="at"></a>
<span class="name">
<span class="modifier">Public</span>
<span class="modifier"></span>
<span ><b>at</b></span>
<a href="#at"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>at(index: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank">number</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="146"
class="link-to-prism">src/lib/form-array.ts:146</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>index</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="../interfaces/AbstractControl.html" target="_self" >AbstractControl<T></a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="disabledWhile"></a>
<span class="name">
<span class="modifier">Public</span>
<span ><b>disabledWhile</b></span>
<a href="#disabledWhile"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>disabledWhile(observable: Observable<boolean>, options?: <a href="../interfaces/ControlOptions.html" target="_self">ControlOptions</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="207"
class="link-to-prism">src/lib/form-array.ts:207</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>observable</td>
<td>
<code>Observable<boolean></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>options</td>
<td>
<code><a href="../interfaces/ControlOptions.html" target="_self" >ControlOptions</a></code>
</td>
<td>
Yes
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="enabledWhile"></a>
<span class="name">
<span class="modifier">Public</span>
<span ><b>enabledWhile</b></span>
<a href="#enabledWhile"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>enabledWhile(observable: Observable<boolean>, options?: <a href="../interfaces/ControlOptions.html" target="_self">ControlOptions</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="214"
class="link-to-prism">src/lib/form-array.ts:214</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>observable</td>
<td>
<code>Observable<boolean></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>options</td>
<td>
<code><a href="../interfaces/ControlOptions.html" target="_self" >ControlOptions</a></code>
</td>
<td>
Yes
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="getError"></a>
<span class="name">
<span class="modifier">Public</span>
<span class="modifier"></span>
<span ><b>getError</b></span>
<a href="#getError"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>getError(errorCode: K, path?: <a href="../undefineds/ControlPath.html" target="_self">ControlPath</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="411"
class="link-to-prism">src/lib/form-array.ts:411</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<b>Type parameters :</b>
<ul class="type-parameters">
<li>K</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>