@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
3,828 lines • 160 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 miscellaneous-functions">
<div class="content-data">
<ol class="breadcrumb">
<li class="breadcrumb-item">Miscellaneous</li>
<li class="breadcrumb-item">Functions</li>
</ol>
<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">
<ul class="index-list">
<li>
<a href="#_IsNumber" title="src/lib/validators/is-number.ts" ><b>_IsNumber</b> (src/.../is-number.ts)</a>
</li>
<li>
<a href="#check" title="src/lib/validators/is-complex.ts" ><b>check</b> (src/.../is-complex.ts)</a>
</li>
<li>
<a href="#checkError" title="src/lib/validators/is-complex.ts" ><b>checkError</b> (src/.../is-complex.ts)</a>
</li>
<li>
<a href="#ControlAsyncValidator" title="src/lib/decorators/control-async-validator.ts" ><b>ControlAsyncValidator</b> (src/.../control-async-validator.ts)</a>
</li>
<li>
<a href="#ControlChange" title="src/lib/decorators/control-change.ts" ><b>ControlChange</b> (src/.../control-change.ts)</a>
</li>
<li>
<a href="#controlDisabled$" title="src/lib/control-actions.ts" ><b>controlDisabled$</b> (src/.../control-actions.ts)</a>
</li>
<li>
<a href="#controlDisabledWhile" title="src/lib/control-actions.ts" ><b>controlDisabledWhile</b> (src/.../control-actions.ts)</a>
</li>
<li>
<a href="#controlEnabled$" title="src/lib/control-actions.ts" ><b>controlEnabled$</b> (src/.../control-actions.ts)</a>
</li>
<li>
<a href="#controlEnabledWhile" title="src/lib/control-actions.ts" ><b>controlEnabledWhile</b> (src/.../control-actions.ts)</a>
</li>
<li>
<a href="#controlErrorChanges$" title="src/lib/control-actions.ts" ><b>controlErrorChanges$</b> (src/.../control-actions.ts)</a>
</li>
<li>
<a href="#controlReadonly$" title="src/lib/control-actions.ts" ><b>controlReadonly$</b> (src/.../control-actions.ts)</a>
</li>
<li>
<a href="#ControlSetValue" title="src/lib/decorators/control-set-value.ts" ><b>ControlSetValue</b> (src/.../control-set-value.ts)</a>
</li>
<li>
<a href="#controlStatusChanges$" title="src/lib/control-actions.ts" ><b>controlStatusChanges$</b> (src/.../control-actions.ts)</a>
</li>
<li>
<a href="#ControlValidator" title="src/lib/decorators/control-validator.ts" ><b>ControlValidator</b> (src/.../control-validator.ts)</a>
</li>
<li>
<a href="#controlValueChanges$" title="src/lib/control-actions.ts" ><b>controlValueChanges$</b> (src/.../control-actions.ts)</a>
</li>
<li>
<a href="#create" title="src/lib/validators/is-complex.ts" ><b>create</b> (src/.../is-complex.ts)</a>
</li>
<li>
<a href="#disableControl" title="src/lib/control-actions.ts" ><b>disableControl</b> (src/.../control-actions.ts)</a>
</li>
<li>
<a href="#enableControl" title="src/lib/control-actions.ts" ><b>enableControl</b> (src/.../control-actions.ts)</a>
</li>
<li>
<a href="#getControlValue" title="src/lib/control-actions.ts" ><b>getControlValue</b> (src/.../control-actions.ts)</a>
</li>
<li>
<a href="#hasErrorAndDirty" title="src/lib/control-actions.ts" ><b>hasErrorAndDirty</b> (src/.../control-actions.ts)</a>
</li>
<li>
<a href="#hasErrorAndTouched" title="src/lib/control-actions.ts" ><b>hasErrorAndTouched</b> (src/.../control-actions.ts)</a>
</li>
<li>
<a href="#initGenerator" title="src/generators/init/generator.ts" ><b>initGenerator</b> (src/.../generator.ts)</a>
</li>
<li>
<a href="#inOperator" title="src/lib/validators/is-complex.ts" ><b>inOperator</b> (src/.../is-complex.ts)</a>
</li>
<li>
<a href="#IsArray" title="src/lib/validators/is-array.ts" ><b>IsArray</b> (src/.../is-array.ts)</a>
</li>
<li>
<a href="#IsBoolean" title="src/lib/validators/is-boolean.ts" ><b>IsBoolean</b> (src/.../is-boolean.ts)</a>
</li>
<li>
<a href="#IsComplex" title="src/lib/validators/is-complex.ts" ><b>IsComplex</b> (src/.../is-complex.ts)</a>
</li>
<li>
<a href="#IsDate" title="src/lib/validators/is-date.ts" ><b>IsDate</b> (src/.../is-date.ts)</a>
</li>
<li>
<a href="#IsEmail" title="src/lib/validators/is-email.ts" ><b>IsEmail</b> (src/.../is-email.ts)</a>
</li>
<li>
<a href="#IsEnum" title="src/lib/validators/is-enum.ts" ><b>IsEnum</b> (src/.../is-enum.ts)</a>
</li>
<li>
<a href="#IsInt" title="src/lib/validators/is-int.ts" ><b>IsInt</b> (src/.../is-int.ts)</a>
</li>
<li>
<a href="#IsIP" title="src/lib/validators/is-ip.ts" ><b>IsIP</b> (src/.../is-ip.ts)</a>
</li>
<li>
<a href="#isNumber" title="src/lib/validators/is-number.ts" ><b>isNumber</b> (src/.../is-number.ts)</a>
</li>
<li>
<a href="#IsNumber" title="src/lib/validators/is-number.ts" class="deprecated-name"><b>IsNumber</b> (src/.../is-number.ts)</a>
</li>
<li>
<a href="#IsObject" title="src/lib/validators/is-object.ts" ><b>IsObject</b> (src/.../is-object.ts)</a>
</li>
<li>
<a href="#IsPhoneNumber" title="src/lib/validators/is-phone-number.ts" ><b>IsPhoneNumber</b> (src/.../is-phone-number.ts)</a>
</li>
<li>
<a href="#IsPort" title="src/lib/validators/is-port.ts" ><b>IsPort</b> (src/.../is-port.ts)</a>
</li>
<li>
<a href="#IsString" title="src/lib/validators/is-string.ts" ><b>IsString</b> (src/.../is-string.ts)</a>
</li>
<li>
<a href="#IsUrl" title="src/lib/validators/is-url.ts" ><b>IsUrl</b> (src/.../is-url.ts)</a>
</li>
<li>
<a href="#IsUUID" title="src/lib/validators/is-uuid.ts" ><b>IsUUID</b> (src/.../is-uuid.ts)</a>
</li>
<li>
<a href="#markAllDirty" title="src/lib/control-actions.ts" ><b>markAllDirty</b> (src/.../control-actions.ts)</a>
</li>
<li>
<a href="#markAllPristine" title="src/lib/control-actions.ts" ><b>markAllPristine</b> (src/.../control-actions.ts)</a>
</li>
<li>
<a href="#markAllUntouched" title="src/lib/control-actions.ts" ><b>markAllUntouched</b> (src/.../control-actions.ts)</a>
</li>
<li>
<a href="#mergeControlValidators" title="src/lib/control-actions.ts" ><b>mergeControlValidators</b> (src/.../control-actions.ts)</a>
</li>
<li>
<a href="#RxapForm" title="src/lib/decorators/form.ts" ><b>RxapForm</b> (src/.../form.ts)</a>
</li>
<li>
<a href="#selectControlValue$" title="src/lib/control-actions.ts" ><b>selectControlValue$</b> (src/.../control-actions.ts)</a>
</li>
<li>
<a href="#ToFormMethod" title="src/lib/directives/models.ts" ><b>ToFormMethod</b> (src/.../models.ts)</a>
</li>
<li>
<a href="#ToFormSubmitMethod" title="src/lib/directives/models.ts" class="deprecated-name"><b>ToFormSubmitMethod</b> (src/.../models.ts)</a>
</li>
<li>
<a href="#UseFormArrayControl" title="src/lib/decorators/use-form-array.ts" ><b>UseFormArrayControl</b> (src/.../use-form-array.ts)</a>
</li>
<li>
<a href="#UseFormArrayGroup" title="src/lib/decorators/use-form-array.ts" ><b>UseFormArrayGroup</b> (src/.../use-form-array.ts)</a>
</li>
<li>
<a href="#UseFormControl" title="src/lib/decorators/use-form-control.ts" ><b>UseFormControl</b> (src/.../use-form-control.ts)</a>
</li>
<li>
<a href="#UseFormGroup" title="src/lib/decorators/use-form-group.ts" ><b>UseFormGroup</b> (src/.../use-form-group.ts)</a>
</li>
<li>
<a href="#validateControlOn" title="src/lib/control-actions.ts" ><b>validateControlOn</b> (src/.../control-actions.ts)</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/lib/validators/is-number.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="_IsNumber"></a>
<span class="name">
<span ><b>_IsNumber</b></span>
<a href="#_IsNumber"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>_IsNumber(__namedParameters: {message: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, options: <a href="../interfaces/IsNumberOptions.html" target="_self">IsNumberOptions</a>})</code>
</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>message</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>options</td>
<td>
<code><a href="../interfaces/IsNumberOptions.html" target="_self" >IsNumberOptions</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="isNumber"></a>
<span class="name">
<span ><b>isNumber</b></span>
<a href="#isNumber"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>isNumber(value, options: <a href="../interfaces/IsNumberOptions.html" target="_self">IsNumberOptions</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Checks if a given value is a number.</p>
</div>
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
<td>Default value</td>
</tr>
</thead>
<tbody>
<tr>
<td>value</td>
<td>
</td>
<td>
No
</td>
<td>
</td>
</tr>
<tr>
<td>options</td>
<td>
<code><a href="../interfaces/IsNumberOptions.html" target="_self" >IsNumberOptions</a></code>
</td>
<td>
No
</td>
<td>
<code>{}</code>
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</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="IsNumber"></a>
<span class="name">
<span class="deprecated-name"><b>IsNumber</b></span>
<a href="#IsNumber"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4 deprecated">
use RxapValidators.isNumber() instead
</td>
</tr>
<tr>
<td class="col-md-4">
<code>IsNumber(control: <a href="../interfaces/AbstractControl.html" target="_self">AbstractControl</a>)</code>
</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>control</td>
<td>
<code><a href="../interfaces/AbstractControl.html" target="_self" >AbstractControl</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="../miscellaneous/typealiases.html#ValidationErrors" target="_self" >ValidationErrors | null</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/lib/validators/is-complex.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="check"></a>
<span class="name">
<span ><b>check</b></span>
<a href="#check"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>check(str: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, regexStringOrOptions)</code>
</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>str</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>regexStringOrOptions</td>
<td>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="checkError"></a>
<span class="name">
<span ><b>checkError</b></span>
<a href="#checkError"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>checkError(str: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, options: <a href="../interfaces/ComplexityOptions.html" target="_self">ComplexityOptions</a>)</code>
</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>str</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>options</td>
<td>
<code><a href="../interfaces/ComplexityOptions.html" target="_self" >ComplexityOptions</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="create"></a>
<span class="name">
<span ><b>create</b></span>
<a href="#create"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>create(options: <a href="../interfaces/ComplexityOptions.html" target="_self">ComplexityOptions</a>)</code>
</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>options</td>
<td>
<code><a href="../interfaces/ComplexityOptions.html" target="_self" >ComplexityOptions</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</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="inOperator"></a>
<span class="name">
<span ><b>inOperator</b></span>
<a href="#inOperator"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>inOperator(k: K, o: T)</code>
</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>k</td>
<td>
<code>K</code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>o</td>
<td>
<code>T</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="../miscellaneous/typealiases.html#Discriminate" target="_self" >Discriminate<T | K></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="IsComplex"></a>
<span class="name">
<span ><b>IsComplex</b></span>
<a href="#IsComplex"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>IsComplex(__namedParameters: {message: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, options: <a href="../interfaces/ComplexityOptions.html" target="_self">ComplexityOptions</a>})</code>
</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>message</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>options</td>
<td>
<code><a href="../interfaces/ComplexityOptions.html" target="_self" >ComplexityOptions</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/lib/decorators/control-async-validator.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ControlAsyncValidator"></a>
<span class="name">
<span ><b>ControlAsyncValidator</b></span>
<a href="#ControlAsyncValidator"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>ControlAsyncValidator(...controlIds: undefined)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>controlIds</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/lib/decorators/control-change.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ControlChange"></a>
<span class="name">
<span ><b>ControlChange</b></span>
<a href="#ControlChange"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>ControlChange(...controlIds: undefined)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>controlIds</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/lib/control-actions.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="controlDisabled$"></a>
<span class="name">
<span ><b>controlDisabled$</b></span>
<a href="#controlDisabled$"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>controlDisabled$(control: <a href="../interfaces/AbstractControl.html" target="_self">AbstractControl</a>)</code>
</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>control</td>
<td>
<code><a href="../interfaces/AbstractControl.html" target="_self" >AbstractControl</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code>Observable<boolean></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="controlDisabledWhile"></a>
<span class="name">
<span ><b>controlDisabledWhile</b></span>
<a href="#controlDisabledWhile"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>controlDisabledWhile(control: <a href="../interfaces/AbstractControl.html" target="_self">AbstractControl</a>, observable: Observable, opts?: <a href="../interfaces/ControlOptions.html" target="_self">ControlOptions</a>)</code>
</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>control</td>
<td>
<code><a href="../interfaces/AbstractControl.html" target="_self" >AbstractControl</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>observable</td>
<td>
<code>Observable</code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>opts</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>Subscription</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="controlEnabled$"></a>
<span class="name">
<span ><b>controlEnabled$</b></span>
<a href="#controlEnabled$"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>controlEnabled$(control: <a href="../interfaces/AbstractControl.html" target="_self">AbstractControl</a>)</code>
</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>control</td>
<td>
<code><a href="../interfaces/AbstractControl.html" target="_self" >AbstractControl</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code>Observable<boolean></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="controlEnabledWhile"></a>
<span class="name">
<span ><b>controlEnabledWhile</b></span>
<a href="#controlEnabledWhile"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>controlEnabledWhile(control: <a href="../interfaces/AbstractControl.html" target="_self">AbstractControl</a>, observable: Observable, opts?: <a href="../interfaces/ControlOptions.html" target="_self">ControlOptions</a>)</code>
</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>control</td>
<td>
<code><a href="../interfaces/AbstractControl.html" target="_self" >AbstractControl</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>observable</td>
<td>
<code>Observable</code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>opts</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>Subscription</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="controlErrorChanges$"></a>
<span class="name">
<span ><b>controlErrorChanges$</b></span>
<a href="#controlErrorChanges$"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>controlErrorChanges$(control: <a href="../interfaces/AbstractControl.html" target="_self">AbstractControl</a>)</code>
</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>control</td>
<td>
<code><a href="../interfaces/AbstractControl.html" target="_self" >AbstractControl</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code>Observable<E | null></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="controlReadonly$"></a>
<span class="name">
<span ><b>controlReadonly$</b></span>
<a href="#controlReadonly$"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>controlReadonly$(control: <a href="../interfaces/AbstractControl.html" target="_self">AbstractControl</a>)</code>
</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>control</td>
<td>
<code><a href="../interfaces/AbstractControl.html" target="_self" >AbstractControl</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code>Observable<boolean></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="controlStatusChanges$"></a>
<span class="name">
<span ><b>controlStatusChanges$</b></span>
<a href="#controlStatusChanges$"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>controlStatusChanges$(control: <a href="../interfaces/AbstractControl.html" target="_self">AbstractControl</a>)</code>
</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>control</td>
<td>
<code><a href="../interfaces/AbstractControl.html" target="_self" >AbstractControl</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="../miscellaneous/typealiases.html#ControlState" target="_self" >Observable<ControlState></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="controlValueChanges$"></a>
<span class="name">
<span ><b>controlValueChanges$</b></span>
<a href="#controlValueChanges$"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>controlValueChanges$(control: <a href="../interfaces/AbstractControl.html" target="_self">AbstractControl</a>)</code>
</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>control</td>
<td>
<code><a href="../interfaces/AbstractControl.html" target="_self" >AbstractControl</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code>Observable<T></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="disableControl"></a>
<span class="name">
<span ><b>disableControl</b></span>
<a href="#disableControl"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>disableControl(control: <a href="../interfaces/AbstractControl.html" target="_self">AbstractControl</a>, disabled: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank">boolean</a>, opts?: <a href="../interfaces/ControlOptions.html" target="_self">ControlOptions</a>)</code>
</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>control</td>
<td>
<code><a href="../interfaces/AbstractControl.html" target="_self" >AbstractControl</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>disabled</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>opts</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" >void</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="enableControl"></a>
<span class="name">
<span ><b>enableControl</b></span>
<a href="#enableControl"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>enableControl(control: <a href="../interfaces/AbstractControl.html" target="_self">AbstractControl</a>, enabled: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank">boolean</a>, opts?: <a href="../interfaces/ControlOptions.html" target="_self">ControlOptions</a>)</code>
</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>control</td>
<td>
<code><a href="../interfaces/AbstractControl.html" target="_self" >AbstractControl</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>enabled</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>opts</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" >void</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="getControlValue"></a>
<span class="name">
<span ><b>getControlValue</b></span>
<a href="#getControlValue"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>getControlValue(control: <a href="../interfaces/AbstractControl.html" target="_self">AbstractControl</a>)</code>
</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>control</td>
<td>
<code><a href="../interfaces/AbstractControl.html" target="_self" >AbstractControl</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code>T</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="hasErrorAndDirty"></a>
<span class="name">
<span ><b>hasErrorAndDirty</b></span>
<a href="#hasErrorAndDirty"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>hasErrorAndDirty(control: <a href="../interfaces/AbstractControl.html" target="_self">AbstractControl</a>, error: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, path?: <a href="../undefineds/ControlPath.html" target="_self">ControlPath</a>)</code>
</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>control</td>
<td>
<code><a href="../interfaces/AbstractControl.html" target="_self" >AbstractControl</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>error</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>path</td>
<td>
<code><a href="../miscellaneous/typealiases.html#ControlPath" target="_self" >ControlPath</a></code>
</td>
<td>
Yes
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</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="hasErrorAndTouched"></a>
<span class="name">
<span ><b>hasErrorAndTouched</b></span>
<a href="#hasErrorAndTouched"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>hasErrorAndTouched(control: <a href="../interfaces/AbstractControl.html" target="_self">AbstractControl</a>, error: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, path?: <a href="../undefineds/ControlPath.html" target="_self">ControlPath</a>)</code>
</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>control</td>
<td>
<code><a href="../interfaces/AbstractControl.html" target="_self" >AbstractControl</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>error</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>path</td>
<td>
<code><a href="../miscellaneous/typealiases.html#ControlPath" target="_self" >ControlPath</a></code>
</td>
<td>
Yes
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</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="markAllDirty"></a>
<span class="name">
<span ><b>markAllDirty</b></span>
<a href="#markAllDirty"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>markAllDirty(control)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>control</td>
<td>
No
</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" >void</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="markAllPristine"></a>
<span class="name">
<span ><b>markAllPristine</b></span>
<a href="#markAllPristine"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>markAllPristine(control)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>control</td>
<td>
No
</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" >void</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="markAllUntouched"></a>
<span class="name">
<span ><b>markAllUntouched</b></span>
<a href="#markAllUntouched"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>markAllUntouched(control)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>control</td>
<td>
No
</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" >void</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="mergeControlValidators"></a>
<span class="name">
<span ><b>mergeControlValidators</b></span>
<a href="#mergeControlValidators"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>mergeControlValidators(control: Control, validators)</code>
</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>control</td>
<td>
<code>Control</code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>validators</td>
<td>
</td>
<td>
No
</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" >void</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="selectControlValue$"></a>
<span class="name">
<span ><b>selectControlValue$</b></span>
<a href="#selectControlValue$"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>selectControlValue$(control, mapFn)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>control</td>
<td>
No
</td>
</tr>
<tr>
<td>mapFn</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code>Observable<R></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="validateControlOn"></a>
<span class="name">
<span ><b>validateControlOn</b></span>
<a href="#validateControlOn"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>validateControlOn(control: <a href="../interfaces/AbstractControl.html" target="_self">AbstractControl</a>, validation: Observable)</code>
</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>control</td>
<td>
<code><a href="../interfaces/AbstractControl.html" target="_self" >AbstractControl</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>validation</td>
<td>
<code>Observable</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code>Subscription</code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/lib/decorators/control-set-value.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ControlSetValue"></a>
<span class="name">
<span ><b>ControlSetValue</b></span>
<a href="#ControlSetValue"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>ControlSetValue(controlId: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, options: Omit)</code>
</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>
<td>Default value</td>
</tr>
</thead>
<tbody>
<tr>
<td>controlId</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
<td>
</td>
</tr>
<tr>
<td>options</td>
<td>
<code>Omit</code>
</td>
<td>
No
</td>
<td>
<code>{}</code>
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/lib/decorators/control-validator.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ControlValidator"></a>
<span class="name">
<span ><b>ControlValidator</b></span>
<a href="#ControlValidator"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>ControlValidator(...controlIds: undefined)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>controlIds</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/generators/init/generator.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="initGenerator"></a>
<span class="name">
<span ><b>initGenerator</b></span>
<a href="#initGenerator"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>initGenerator(tree: Tree, options: InitGeneratorSchema)</code>
</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>tree</td>
<td>
<code>Tree</code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>options</td>
<td>
<code>InitGeneratorSchema</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/lib/validators/is-array.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="IsArray"></a>
<span class="name">
<span ><b>IsArray</b></span>
<a href="#IsArray"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>IsArray(__namedParameters: {message: <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-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>message</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/lib/validators/is-boolean.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="IsBoolean"></a>
<span class="name">
<span ><b>IsBoolean</b></span>
<a href="#IsBoolean"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>IsBoolean(__namedParameters: {message: <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-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>message</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/lib/validators/is-date.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="IsDate"></a>
<span class="name">
<span ><b>IsDate</b></span>
<a href="#IsDate"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>IsDate(__namedParameters: {message: <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-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>message</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/lib/validators/is-email.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="IsEmail"></a>
<span class="name">
<span ><b>IsEmail</b></span>
<a href="#IsEmail"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>IsEmail(__namedParameters: {message: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, options: <a href="../undefineds/IsEmail.html" target="_self">IsEmailOptions</a>})</code>
</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>message</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>options</td>
<td>
<code><a href="../miscellaneous/functions.html#IsEmail" target="_self" >IsEmailOptions</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/lib/validators/is-enum.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="IsEnum"></a>
<span class="name">
<span ><b>IsEnum</b></span>
<a href="#IsEnum"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>IsEnum(__namedParameters: {message: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, entity: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>})</code>
</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>message</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>entity</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/lib/validators/is-int.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="IsInt"></a>
<span class="name">
<span ><b>IsInt</b></span>
<a href="#IsInt"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>IsInt(__namedParameters: {message: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, options: <a href="../interfaces/IsNumberOptions.html" target="_self">IsNumberOptions</a>})</code>
</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>message</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>options</td>
<td>
<code><a href="../interfaces/IsNumberOptions.html" target="_self" >IsNumberOptions</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/lib/validators/is-ip.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="IsIP"></a>
<span class="name">
<span ><b>IsIP</b></span>
<a href="#IsIP"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>IsIP(__namedParameters: {message: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, version: string | number})</code>
</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>message</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>version</td>
<td>
<code>string | number</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/lib/validators/is-object.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="IsObject"></a>
<span class="name">
<span ><b>IsObject</b></span>
<a href="#IsObject"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>IsObject(__namedParameters: {message: <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-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>message</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/lib/validators/is-phone-number.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="IsPhoneNumber"></a>
<span class="name">
<span ><b>IsPhoneNumber</b></span>
<a href="#IsPhoneNumber"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>IsPhoneNumber(__namedParameters: {message: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, locale: "any" | MobilePhoneLocale | MobilePhoneLocale[], options: IsMobilePhoneOptions})</code>
</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>message</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>locale</td>
<td>
<code>"any" | MobilePhoneLocale | MobilePhoneLocale[]</code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>options</td>
<td>
<code>IsMobilePhoneOptions</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/lib/validators/is-port.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="IsPort"></a>
<span class="name">
<span ><b>IsPort</b></span>
<a href="#IsPort"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>IsPort(__namedParameters: {message: <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-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>message</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/lib/validators/is-string.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="IsString"></a>
<span class="name">
<span ><b>IsString</b></span>
<a href="#IsString"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>IsString(__namedParameters: {message: <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-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>message</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/lib/validators/is-url.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="IsUrl"></a>
<span class="name">
<span ><b>IsUrl</b></span>
<a href="#IsUrl"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>IsUrl(__namedParameters: {message: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, options: IsURLOptions})</code>
</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>message</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>options</td>
<td>
<code>IsURLOptions</code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/lib/validators/is-uuid.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="IsUUID"></a>
<span class="name">
<span ><b>IsUUID</b></span>
<a href="#IsUUID"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>IsUUID(__namedParameters: {message: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, version: <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-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
<td>Default value</td>
</tr>
</thead>
<tbody>
<tr>
<td>message</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
<td>
</td>
</tr>
<tr>
<td>version</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
<td>
<code>'all'</code>
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/lib/decorators/form.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="RxapForm"></a>
<span class="name">
<span ><b>RxapForm</b></span>
<a href="#RxapForm"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>RxapForm(optionsOrId, className: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, packageName: <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-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
<td>Default value</td>
</tr>
</thead>
<tbody>
<tr>
<td>optionsOrId</td>
<td>
</td>
<td>
No
</td>
<td>
</td>
</tr>
<tr>
<td>className</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
<td>
<code>'FormDefinition'</code>
</td>
</tr>
<tr>
<td>packageName</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
<td>
<code>'@rxap/forms'</code>
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/lib/directives/models.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ToFormMethod"></a>
<span class="name">
<span ><b>ToFormMethod</b></span>
<a href="#ToFormMethod"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>ToFormMethod(call)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>call</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code>Method<R, P></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="ToFormSubmitMethod"></a>
<span class="name">
<span class="deprecated-name"><b>ToFormSubmitMethod</b></span>
<a href="#ToFormSubmitMethod"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4 deprecated">
use ToFormMethod instead
</td>
</tr>
<tr>
<td class="col-md-4">
<code>ToFormSubmitMethod(call)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td>call</td>
<td>
No
</td>
<td>
<p>the call method implementation</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="../interfaces/FormSubmitMethod.html" target="_self" >FormSubmitMethod<T></a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/lib/decorators/use-form-array.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="UseFormArrayControl"></a>
<span class="name">
<span ><b>UseFormArrayControl</b></span>
<a href="#UseFormArrayControl"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>UseFormArrayControl(options: <a href="../undefineds/RxapAbstractControlOptions.html" target="_self">RxapAbstractControlOptions</a>)</code>
</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>
<td>Default value</td>
</tr>
</thead>
<tbody>
<tr>
<td>options</td>
<td>
<code><a href="../miscellaneous/typealiases.html#RxapAbstractControlOptions" target="_self" >RxapAbstractControlOptions</a></code>
</td>
<td>
No
</td>
<td>
<code>{}</code>
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="UseFormArrayGroup"></a>
<span class="name">
<span ><b>UseFormArrayGroup</b></span>
<a href="#UseFormArrayGroup"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>UseFormArrayGroup(definition: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Constructor" target="_blank">Constructor</a>, options: <a href="../undefineds/RxapAbstractControlOptions.html" target="_self">RxapAbstractControlOptions</a>)</code>
</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>
<td>Default value</td>
</tr>
</thead>
<tbody>
<tr>
<td>definition</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Constructor" target="_blank" >Constructor</a></code>
</td>
<td>
No
</td>
<td>
</td>
</tr>
<tr>
<td>options</td>
<td>
<code><a href="../miscellaneous/typealiases.html#RxapAbstractControlOptions" target="_self" >RxapAbstractControlOptions</a></code>
</td>
<td>
No
</td>
<td>
<code>{}</code>
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/lib/decorators/use-form-control.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="UseFormControl"></a>
<span class="name">
<span ><b>UseFormControl</b></span>
<a href="#UseFormControl"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>UseFormControl(options: <a href="../undefineds/RxapAbstractControlOptions.html" target="_self">RxapAbstractControlOptions</a>)</code>
</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>
<td>Default value</td>
</tr>
</thead>
<tbody>
<tr>
<td>options</td>
<td>
<code><a href="../miscellaneous/typealiases.html#RxapAbstractControlOptions" target="_self" >RxapAbstractControlOptions</a></code>
</td>
<td>
No
</td>
<td>
<code>{}</code>
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/lib/decorators/use-form-group.ts</h3>
<section data-compodoc="block-methods">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="UseFormGroup"></a>
<span class="name">
<span ><b>UseFormGroup</b></span>
<a href="#UseFormGroup"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>UseFormGroup(definition: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Constructor" target="_blank">Constructor</a>, options: <a href="../undefineds/RxapAbstractControlOptions.html" target="_self">RxapAbstractControlOptions</a>)</code>
</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>
<td>Default value</td>
</tr>
</thead>
<tbody>
<tr>
<td>definition</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Constructor" target="_blank" >Constructor</a></code>
</td>
<td>
No
</td>
<td>
</td>
</tr>
<tr>
<td>options</td>
<td>
<code><a href="../miscellaneous/typealiases.html#RxapAbstractControlOptions" target="_self" >RxapAbstractControlOptions</a></code>
</td>
<td>
No
</td>
<td>
<code>{}</code>
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>
<label class="dark-mode-switch">
<input type="checkbox">
<span class="slider">
<svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg">
<path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
</svg>
</span>
</label>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'miscellaneous-functions';
var COMPODOC_CURRENT_PAGE_URL = 'functions.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script>
$darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
checkToggle(darkModeState);
if ($darkModeToggleSwitchers.length > 0) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].addEventListener('change', function (event) {
darkModeState = !darkModeState;
toggleDarkMode(darkModeState);
});
}
}
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
<script src="../js/menu-wc.js" defer></script>
<script nomodule src="../js/menu-wc_es5.js" defer></script>
<script src="../js/libs/bootstrap-native.js"></script>
<script src="../js/libs/es6-shim.min.js"></script>
<script src="../js/libs/EventDispatcher.js"></script>
<script src="../js/libs/promise.min.js"></script>
<script src="../js/libs/zepto.min.js"></script>
<script src="../js/compodoc.js"></script>
<script src="../js/tabs.js"></script>
<script src="../js/menu.js"></script>
<script src="../js/libs/clipboard.min.js"></script>
<script src="../js/libs/prism.js"></script>
<script src="../js/sourceCode.js"></script>
<script src="../js/search/search.js"></script>
<script src="../js/search/lunr.min.js"></script>
<script src="../js/search/search-lunr.js"></script>
<script src="../js/search/search_index.js"></script>
<script src="../js/lazy-load-graphs.js"></script>
</body>
</html>