grassrootseconomics/cic-staff-client
5
0
Fork 0
Code Issues 26 Pull Requests Projects Releases Wiki Activity
4ed3d108cb
cic-staff-client/docs/compodoc/classes/CustomValidator.html

406 lines
14 KiB
HTML
Raw Normal View History

Add docs.
2021-05-10 20:56:20 +02:00
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>CICADA</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">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top visible-xs">
<a href="../" class="navbar-brand">CICADA</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</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="hidden-xs menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content class">
<div class="content-data">
<ol class="breadcrumb">
<li>Classes</li>
<li>CustomValidator</li>
</ol>
<ul class="nav nav-tabs" role="tablist">
<li class="active">
<a href="#info" role="tab" id="info-tab" data-toggle="tab" data-link="info">Info</a>
</li>
<li >
<a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a>
</li>
</ul>
<div class="tab-content">
<div class="tab-pane fade active in" id="c-info">
<p class="comment">
<h3>File</h3>
</p>
<p class="comment">
<code>src/app/_helpers/custom.validator.ts</code>
</p>
Add documentation to the helpers module.
2021-05-11 13:34:23 +02:00
<p class="comment">
<h3>Description</h3>
</p>
<p class="comment">
<p>Provides methods to perform custom validation to form inputs.</p>
</p>
Add docs.
2021-05-10 20:56:20 +02:00
<section>
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<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">Static</span>
<a href="#passwordMatchValidator">passwordMatchValidator</a>
</li>
<li>
<span class="modifier">Static</span>
<a href="#patternValidator">patternValidator</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h3 id="methods">
Methods
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="passwordMatchValidator"></a>
<span class="name">
<b>
<span class="modifier">Static</span>
passwordMatchValidator
</b>
<a href="#passwordMatchValidator"><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>passwordMatchValidator(control: <a href="https://angular.io/api/forms/AbstractControl" target="_blank">AbstractControl</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Add documentation to the helpers module.
2021-05-11 13:34:23 +02:00
<div class="io-line">Defined in <a href="" data-line="13"
class="link-to-prism">src/app/_helpers/custom.validator.ts:13</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Add documentation to the helpers module.
2021-05-11 13:34:23 +02:00
<div class="io-description"><p>Sets errors to the confirm password input field if it does not match with the value in the password input field.</p>
</div>
Add docs.
2021-05-10 20:56:20 +02:00
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
Add documentation to the helpers module.
2021-05-11 13:34:23 +02:00
<td>Description</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</thead>
<tbody>
<tr>
<td>control</td>
<td>
<code><a href="https://angular.io/api/forms/AbstractControl" target="_blank" >AbstractControl</a></code>
</td>
<td>
No
</td>
Add documentation to the helpers module.
2021-05-11 13:34:23 +02:00
<td>
<ul>
<li>The control object of the form being validated.</li>
</ul>
</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</tbody>
</table>
</div>
<div>
</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="patternValidator"></a>
<span class="name">
<b>
<span class="modifier">Static</span>
patternValidator
</b>
<a href="#patternValidator"><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>patternValidator(regex: RegExp, error: <a href="https://angular.io/api/forms/ValidationErrors" target="_blank">ValidationErrors</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
Add documentation to the helpers module.
2021-05-11 13:34:23 +02:00
<div class="io-line">Defined in <a href="" data-line="28"
class="link-to-prism">src/app/_helpers/custom.validator.ts:28</a></div>
Add docs.
2021-05-10 20:56:20 +02:00
</td>
</tr>
<tr>
<td class="col-md-4">
Add documentation to the helpers module.
2021-05-11 13:34:23 +02:00
<div class="io-description"><p>Sets errors to a form field if it does not match with the regular expression given.</p>
</div>
Add docs.
2021-05-10 20:56:20 +02:00
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
Add documentation to the helpers module.
2021-05-11 13:34:23 +02:00
<td>Description</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</thead>
<tbody>
<tr>
<td>regex</td>
<td>
<code>RegExp</code>
</td>
<td>
No
</td>
Add documentation to the helpers module.
2021-05-11 13:34:23 +02:00
<td>
<ul>
<li>The regular expression to match with the form field.</li>
</ul>
</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
<tr>
<td>error</td>
<td>
<code><a href="https://angular.io/api/forms/ValidationErrors" target="_blank" >ValidationErrors</a></code>
</td>
<td>
No
</td>
Add documentation to the helpers module.
2021-05-11 13:34:23 +02:00
<td>
<ul>
<li>Defines the map of errors to return from failed validation checks.</li>
</ul>
</td>
Add docs.
2021-05-10 20:56:20 +02:00
</tr>
</tbody>
</table>
</div>
<div>
</div>
<div class="io-description">
<b>Returns : </b> <code>ValidationErrors | null</code>
</div>
<div class="io-description">
Add documentation to the helpers module.
2021-05-11 13:34:23 +02:00
<p>The map of errors returned from failed validation checks.</p>
Add docs.
2021-05-10 20:56:20 +02:00
</div>
</td>
</tr>
</tbody>
</table>
</section>
</div>
<div class="tab-pane fade tab-source-code" id="c-source">
Format docs using linter and prettier.
2021-05-11 19:51:48 +02:00
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { AbstractControl, ValidationErrors } from &#x27;@angular/forms&#x27;;
Add docs.
2021-05-10 20:56:20 +02:00
Add documentation to the helpers module.
2021-05-11 13:34:23 +02:00
/**
* Provides methods to perform custom validation to form inputs.
*/
Add docs.
2021-05-10 20:56:20 +02:00
export class CustomValidator {
Add documentation to the helpers module.
2021-05-11 13:34:23 +02:00
/**
* Sets errors to the confirm password input field if it does not match with the value in the password input field.
*
* @param control - The control object of the form being validated.
*/
Add docs.
2021-05-10 20:56:20 +02:00
static passwordMatchValidator(control: AbstractControl): void {
const password: string &#x3D; control.get(&#x27;password&#x27;).value;
const confirmPassword: string &#x3D; control.get(&#x27;confirmPassword&#x27;).value;
if (password !&#x3D;&#x3D; confirmPassword) {
control.get(&#x27;confirmPassword&#x27;).setErrors({ NoPasswordMatch: true });
}
}
Add documentation to the helpers module.
2021-05-11 13:34:23 +02:00
/**
* Sets errors to a form field if it does not match with the regular expression given.
*
* @param regex - The regular expression to match with the form field.
* @param error - Defines the map of errors to return from failed validation checks.
* @returns The map of errors returned from failed validation checks.
*/
Add docs.
2021-05-10 20:56:20 +02:00
static patternValidator(regex: RegExp, error: ValidationErrors): ValidationErrors | null {
return (control: AbstractControl): { [key: string]: any } &#x3D;&gt; {
if (!control.value) {
return null;
}
const valid: boolean &#x3D; regex.test(control.value);
return valid ? null : error;
};
}
}
</code></pre>
</div>
</div>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> result-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>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'class';
var COMPODOC_CURRENT_PAGE_URL = 'CustomValidator.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
<!-- Required to polyfill modern browsers as code is ES5 for IE... -->
<script src="../js/libs/custom-elements-es5-adapter.js" charset="utf-8" defer></script>
<script src="../js/menu-wc.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>
Reference in New Issue Copy Permalink