From 5b0b78041abaeb2d567ff215c6ffd49cd57ae7ee Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Romel=20P=C3=A9rez?= <ronelprhone@gmail.com>
Date: Fri, 28 Oct 2016 23:58:56 -0500
Subject: [PATCH] docs: api

---
 doc/js/external-_jQuery.fn_.html | 2 +-
 doc/js/external-jQuery.html      | 2 +-
 doc/js/external-window.html      | 2 +-
 doc/js/externals.list.html       | 2 +-
 doc/js/fieldSettings.html        | 2 +-
 doc/js/fieldsetSettings.html     | 2 +-
 doc/js/index.html                | 2 +-
 doc/js/map.html                  | 2 +-
 doc/js/module-vulcanval.html     | 2 +-
 doc/js/modules.list.html         | 2 +-
 doc/js/namespaces.list.html      | 2 +-
 doc/js/quicksearch.html          | 2 +-
 doc/js/settings.html             | 2 +-
 doc/js/settings.validators.html  | 2 +-
 doc/js/utilityContext.html       | 2 +-
 doc/js/validator.html            | 2 +-
 16 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/doc/js/external-_jQuery.fn_.html b/doc/js/external-_jQuery.fn_.html
index b723c7b..0157925 100644
--- a/doc/js/external-_jQuery.fn_.html
+++ b/doc/js/external-_jQuery.fn_.html
@@ -2108,7 +2108,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
 	
-		on 2016-10-28T23:46:55-05:00
+		on 2016-10-28T23:58:56-05:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>
diff --git a/doc/js/external-jQuery.html b/doc/js/external-jQuery.html
index 61b8f49..d0f764f 100644
--- a/doc/js/external-jQuery.html
+++ b/doc/js/external-jQuery.html
@@ -213,7 +213,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
 	
-		on 2016-10-28T23:46:55-05:00
+		on 2016-10-28T23:58:56-05:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>
diff --git a/doc/js/external-window.html b/doc/js/external-window.html
index f2f6682..df0247f 100644
--- a/doc/js/external-window.html
+++ b/doc/js/external-window.html
@@ -295,7 +295,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
 	
-		on 2016-10-28T23:46:55-05:00
+		on 2016-10-28T23:58:56-05:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>
diff --git a/doc/js/externals.list.html b/doc/js/externals.list.html
index 1fe4d4e..abe9e4f 100644
--- a/doc/js/externals.list.html
+++ b/doc/js/externals.list.html
@@ -229,7 +229,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
 	
-		on 2016-10-28T23:46:55-05:00
+		on 2016-10-28T23:58:56-05:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>
diff --git a/doc/js/fieldSettings.html b/doc/js/fieldSettings.html
index 017e78c..93399e0 100644
--- a/doc/js/fieldSettings.html
+++ b/doc/js/fieldSettings.html
@@ -1265,7 +1265,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
 	
-		on 2016-10-28T23:46:55-05:00
+		on 2016-10-28T23:58:56-05:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>
diff --git a/doc/js/fieldsetSettings.html b/doc/js/fieldsetSettings.html
index dfada23..6afc205 100644
--- a/doc/js/fieldsetSettings.html
+++ b/doc/js/fieldsetSettings.html
@@ -1068,7 +1068,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
 	
-		on 2016-10-28T23:46:55-05:00
+		on 2016-10-28T23:58:56-05:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>
diff --git a/doc/js/index.html b/doc/js/index.html
index f295dd4..3ecb69d 100644
--- a/doc/js/index.html
+++ b/doc/js/index.html
@@ -158,7 +158,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
 	
-		on 2016-10-28T23:46:55-05:00
+		on 2016-10-28T23:58:56-05:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>
diff --git a/doc/js/map.html b/doc/js/map.html
index f1fc31c..1a30046 100644
--- a/doc/js/map.html
+++ b/doc/js/map.html
@@ -256,7 +256,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
 	
-		on 2016-10-28T23:46:55-05:00
+		on 2016-10-28T23:58:56-05:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>
diff --git a/doc/js/module-vulcanval.html b/doc/js/module-vulcanval.html
index 93e46c5..0396717 100644
--- a/doc/js/module-vulcanval.html
+++ b/doc/js/module-vulcanval.html
@@ -1141,7 +1141,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
 	
-		on 2016-10-28T23:46:55-05:00
+		on 2016-10-28T23:58:56-05:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>
diff --git a/doc/js/modules.list.html b/doc/js/modules.list.html
index 19223a2..ae0a9e2 100644
--- a/doc/js/modules.list.html
+++ b/doc/js/modules.list.html
@@ -229,7 +229,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
 	
-		on 2016-10-28T23:46:55-05:00
+		on 2016-10-28T23:58:56-05:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>
diff --git a/doc/js/namespaces.list.html b/doc/js/namespaces.list.html
index 36d510c..27fdfcf 100644
--- a/doc/js/namespaces.list.html
+++ b/doc/js/namespaces.list.html
@@ -229,7 +229,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
 	
-		on 2016-10-28T23:46:55-05:00
+		on 2016-10-28T23:58:56-05:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>
diff --git a/doc/js/quicksearch.html b/doc/js/quicksearch.html
index fa345e0..1062f4a 100644
--- a/doc/js/quicksearch.html
+++ b/doc/js/quicksearch.html
@@ -7,7 +7,7 @@
     <script src="scripts/fulltext-search.js"></script>
 
     <script type="text/x-docstrap-searchdb">
-    {"modules.list.html":{"id":"modules.list.html","title":"Modules","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow Modules Namespaces fieldsetSettings fieldSettings map settings validators utilityContext validator × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:46:55-05:00 using the DocStrap template. "},"namespaces.list.html":{"id":"namespaces.list.html","title":"Namespaces","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow Namespaces Namespaces fieldsetSettings fieldSettings map settings validators utilityContext validator × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:46:55-05:00 using the DocStrap template. "},"externals.list.html":{"id":"externals.list.html","title":"Externals","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow Externals Namespaces fieldsetSettings fieldSettings map settings validators utilityContext validator × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:46:55-05:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow VulcanVal Vulcan Validator, validate HTML form data universally seamlessly. A package to validate maps of data extracted from HTML forms in the client and server sides and a customizable jQuery plugin to validate forms as you type with ease. This is the JavaScript API documentation. Here you will find information in detail about the use of the VulcanVal package for global use, client and server side, and the jQuery plugin to validate HTML forms in realtime. In short, you can use the module vulcanval and all its methods in node.js with: const vulcanval = require('vulcanval');When you have installed the module in client side, you can make use of the module by accessing the global variable: window.vulcanval;And when you install the plugin, the jQuery plugin namespace is: jQuery().vulcanval();You can see the global configurations used by the module, the fieldset configurations and the field configurations used by default and change some of them to apply among all instances. More info at Documentation | Demos | JS API | SASS Config LicenseMIT × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:46:55-05:00 using the DocStrap template. "},"external-_jQuery.fn_.html":{"id":"external-_jQuery.fn_.html","title":"External: jQuery.fn","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow External: jQuery.fn jQuery.fn The jQuery plugin namespace. See: The jQuery Plugin Guide Methods &lt;static&gt; vulcanval(getMap) Get the data map extracted from the &lt;form&gt;. If the instance was configured with the setting settings.enableNestedMaps as true, the map returned will be nested. Otherwise it will be plain. This method can also be used over &lt;form&gt; elements without being instantiated and will return a plain data map with all its inputs, selects and textareas values. Parameters: Name Type Description getMap String With value 'getMap'. Returns: The data map. Type map &lt;static&gt; vulcanval(validateFieldset, fieldsetName) Invoke over instantiated elements. Validate visually all fields of an specific fieldset in &lt;form&gt;. Parameters: Name Type Description validateFieldset String With value 'validateFieldset'. fieldsetName String The fieldset name to validate. Returns: The same jQuery object. Type external:jQuery &lt;static&gt; vulcanval(validateField, fieldName) Invoke over instantiated elements. Validate visually an specific field in &lt;form&gt;. Parameters: Name Type Description validateField String With value 'validateField'. fieldName String The field name to validate. Returns: The same jQuery object. Type external:jQuery &lt;static&gt; vulcanval(inspectField [, fieldName]) Invoke over instantiated elements. Inspect the validation status of an specific field in &lt;form&gt;. Parameters: Name Type Argument Description inspectField String With value 'inspectField'. fieldName String &lt;optional&gt; The field name to inspect. Returns: It will return an error message if field is invalid, otherwise false. Type String | Boolean &lt;static&gt; vulcanval(validate) Invoke over instantiated elements. Validate visually all fields in &lt;form&gt;. Parameters: Name Type Description validate String With value 'validate'. Returns: The same jQuery object. Type external:jQuery &lt;static&gt; vulcanval(resetFieldset, fieldsetName) Invoke over instantiated elements. Reset all fields in fieldset validation state. This removes all current error states in those fields. Parameters: Name Type Description resetFieldset String With value 'resetFieldset'. fieldsetName String Fieldset name to reset. Returns: The same jQuery object. Type external:jQuery &lt;static&gt; vulcanval(resetField, fieldName) Invoke over instantiated elements. Reset specific field validation state. This removes all current error states from field. Parameters: Name Type Description resetField String With value 'resetField'. fieldName String The name of the field. Returns: The same jQuery object. Type external:jQuery &lt;static&gt; vulcanval(reset) Invoke over instantiated elements. Reset the &lt;form&gt; validation state. This removes all current error states. Parameters: Name Type Description reset String With value 'reset'. Returns: The same jQuery object. Type external:jQuery &lt;static&gt; vulcanval(inspectFieldset, fieldsetName) Invoke over instantiated elements. Inspect the validation status of all fields in fieldset in the &lt;form&gt;. Parameters: Name Type Description inspectFieldset String With value 'inspectFieldset'. fieldsetName String The fieldset name to inspect. Returns: A plain object with keys as field names and values with error messages if they have. If fieldset is valid, false will be returned. Type Object | String | Boolean &lt;static&gt; vulcanval(inspect) Invoke over instantiated elements. Inspect the validation status of the &lt;form&gt;. Parameters: Name Type Description inspect String With value 'inspect'. Returns: A plain object with keys as field names and values with error messages if they have. If form is valid, false will be returned. Type Object | String | Boolean &lt;static&gt; vulcanval(settings) jQuery plugin to instantiate the validators in forms. Defines validation functionalities over form elements. This can be instantiated on forms or any form elements with a valid attribute name: &lt;form&gt; &lt;input&gt; with type different than file, submit, image, button and reset &lt;textarea&gt; &lt;select&gt; Also, the plugin can be instantiated on any element with a valid input name in attribute data-vv-name which will be treated as a normal &lt;input&gt;. This is useful to create custom fields/entries. Parameters: Name Type Description settings settings Instance settings. This is used to configure the whole validation process. See: Also see the demos to learn how to implement this method. Returns: The same jQuery object. Type external:jQuery × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:46:55-05:00 using the DocStrap template. "},"external-jQuery.html":{"id":"external-jQuery.html","title":"External: jQuery","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow External: jQuery jQuery jQuery object. See: http://api.jquery.com/jQuery/ × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:46:55-05:00 using the DocStrap template. "},"external-window.html":{"id":"external-window.html","title":"External: window","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow External: window window window object. See: https://developer.mozilla.org/en-US/docs/Web/API/Window Members &lt;static&gt; vulcanval :Object This is a reference to the vulcanval. Type: Object See: module:vulcanval × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:46:55-05:00 using the DocStrap template. "},"fieldsetSettings.html":{"id":"fieldsetSettings.html","title":"Namespace: fieldsetSettings","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow Namespace: fieldsetSettings fieldsetSettings These properties and methods will affect the fields settings. This is configured in settings.fieldsets array property. Important: one field can be affected by more than one fieldset so if you set two fieldsets that match the same field, it will have the configuration of both of them, being priority the last one. Members &lt;static&gt; autostart :Boolean Default fieldSettings.autostart value in fieldset. Type: Boolean Default Value: false &lt;static&gt; disabled :Boolean Default fieldSettings.disabled value in fieldset. Type: Boolean Default Value: false &lt;static&gt; fields :RegExp|String|Array The fields this fieldset covers. This is required. This can be a RegExp to match against the fields names, a string that is the starting string of fields names or an array with the names of the fields. Type: RegExp | String | Array &lt;static&gt; firstValidationEvent :Boolean Default fieldSettings.firstValidationEvent value in fieldset. Type: Boolean Default Value: false &lt;static&gt; intern :Boolean Default fieldSettings.intern value in fieldset. Type: Boolean Default Value: false &lt;static&gt; name :String Fieldset name. This will be used to identify this fieldset and it is required. Type: String &lt;static&gt; onlyIf :Boolean Middleware fieldSettings.onlyIf value in fieldset. This function will be used in the fields to determine if they will be validated or not. Type: Boolean Default Value: false &lt;static&gt; onlyUI :Boolean Default fieldSettings.onlyUI value in fieldset. Type: Boolean Default Value: false &lt;static&gt; required :Boolean Default fieldSettings.required value in fieldset. Type: Boolean Default Value: false &lt;static&gt; validationEvents :Boolean Default fieldSettings.validationEvents value in fieldset. Type: Boolean Default Value: false &lt;static&gt; validators :Boolean Extends fieldSettings.validators value in fieldset so all fields that this fieldset covers will extend their validators with this object. Type: Boolean Default Value: false × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:46:55-05:00 using the DocStrap template. "},"fieldSettings.html":{"id":"fieldSettings.html","title":"Namespace: fieldSettings","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow Namespace: fieldSettings fieldSettings The default properties and methods for a field. This is configured in settings.fields array property. Each field settings can be affected by the main settings and by the fieldsetSettings. Members &lt;static&gt; autostart :Boolean Only client-side. Validate field elements on instance time. Type: Boolean Default Value: false &lt;static&gt; disabled :Boolean Field will be ignored in validation if true. Type: Boolean Default Value: false &lt;static&gt; display :external:jQuery Only client-side. The element where to set the current field message error. If not specified, the messages won't be shown on UI. When configured by HTML attribute data-vv-display, the value expected should be a jQuery selector. Otherwise this can be anything to select with the jQuery selector method. Type: external:jQuery &lt;static&gt; firstValidationEvent :String Only client-side. What event to listen to trigger the first validation on field. Type: String Default Value: Inherited from settings &lt;static&gt; intern :Boolean Only client-side. When a field is validated, don't show changes visually nor show messages. This is used to know whether they are valid or not, update the fields elements states and trigger events. Type: Boolean Default Value: false &lt;static&gt; name :String The field name. This property is required. Type: String &lt;static&gt; onlyUI :Boolean Only client-side. Ignore field in validation in server side. Type: Boolean Default Value: false &lt;static&gt; required :Boolean Field is required and cannot be undefined nor empty string. If the field is not required but it does NOT have a truthy value, then this will pass over all validators. Type: Boolean Default Value: false &lt;static&gt; validationEvents :String Only client-side. After first validation, what events to listen to re-validate field. Type: String Default Value: Inherited from settings &lt;static&gt; validators :Object The validators list. This is an object with keys as the validators names and values as their configuration. If the value is simply a boolean true, the validator will be invoked without options. It it is string, number or object it will be send as validator options. If value is false, the validator will not be used. These won't be used if the field value is boolean. You can use all validators from the validator package. This object will be merged with the fieldsets validators this field is in. Type: Object Methods &lt;static&gt; onlyIf() A condition gate to verify if the field will be validated. Receives the field value as first parameter and has to return a boolean, if true the validation will procced as normal, otherwise the validation will halt. This is a function with the utility context as function context so don't use arrow functions. Returns: Type Boolean &lt;static&gt; value($field) Only client-side. Method to get the value of the field. This will have the utilty context so don't use arrow functions. By default this can retrieve the value of &lt;input&gt;s of any kind except image, submit, reset, file and button, &lt;textarea&gt;s and &lt;select&gt;s. You can overwrite this to create your own custom field value getter. Otherwise leave this property as default. The first paramter $field will be binded to the function and it is the jQuery element the fields belongs to. Parameters: Name Type Description $field external:jQuery The field element. Returns: The value returned will depend on the type of element or what you configure if you overwrite this method. Type * × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:46:55-05:00 using the DocStrap template. "},"map.html":{"id":"map.html","title":"Namespace: map","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow Namespace: map map A plain object as a data map extracted from a &lt;form&gt;. This is basically a plain object with keys as form fields names and values as their respective values. The values can be strings, numbers or booleans. Currently there is no support for arrays. The keys can be simple alphanumeric values but can be used to describe a nested or deep map if they have dots in the string in plain maps. The dots are to describe &lt;fieldset&gt;s in the form and improve the structure of complex forms. If the map is plain and its keys have dots in the strings, it can be converted to a nested map. The inverse is the same, if the map is nested and has possibly many levels of deep objects, it can be converted to a plain map with dots in the keys describing the deep fields. See: The settings.enableNestedMaps which is used in the validation methods to determine how to treat the data map. Mainly used in server-side. The jQuery.fn.vulcanval `getMap` method which extracts a data map from the form or fields used in validation. Used in client-side. Example // Plain map. const plainMap = { normal: 'value0', another: true, 'using.dots.inside': 100 }; // Nested map. const nestedMap = { name: 'Romel Pérez', age: 22, like: { apple: true, watermelon: true, pumpkin: false }, favourite: { fruit: 'Cantaloupe', book: 'Spice and Wolf', game: 'World of Warcraft' } }; × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:46:55-05:00 using the DocStrap template. "},"module-vulcanval.html":{"id":"module-vulcanval.html","title":"Module: vulcanval","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow Module: vulcanval The vulcan validator (vulcanval) creator. This module is a function which receives a settings object and returns a validator object to validate data maps. Also this has some properties and methods to configure the validations globally. In Node.js environments use like: const vulcanval = require('vulcanval');In browser environments this object is available in window.vulcanval. See: validator Example // Changing a global configuration in settings. vulcanval.settings.locale = 'pt'; // Addind a new validator method. vulcanval.addValidator('valName', function () { ... }); // Extending/creating a new locale/language. vulcanval.extendLocale({ ... }); // A form configuration to create a validator. const settings = { fields: [{ name: 'fieldName', validators: {} }] }; // Creating a validator from settings. const validator = vulcanval(settings); // A data map to validate. const map = { fieldName: 'field value' }; // Validating the map with the validator. const result = validator.validate(map); Members &lt;static&gt; log :Object This is a reference to the prhone-log package instance used to log messages. Type: Object &lt;static&gt; settings :Object This is a reference to the settings global configuration. Type: Object &lt;static&gt; utilityContext :Object This is a reference to the utilityContext global configuration. This can be mutated to use your own custom properties and methods in any method/function that make use of this context. Type: Object &lt;static&gt; validator :Object This is a reference to the validator package. Type: Object Methods &lt;static&gt; addValidator(name, validator) Add a custom validator globally. All validators in the package validator are installed and ready to use. Parameters: Name Type Description name String An alphanumeric validator name. validator function The validator function. Receives as a first parameter the value of the field and has to return a truthy value. This function will have the utility context as function context. Don't pass arrow functions. See: In the example is used the validator.validateField static method to test the new validator. Example vulcanval.addValidator('isGreat', function (value) { return value.length &gt; 4 &amp;&amp; value.indexOf('great') &gt;= 0; }); const map = { field0: 'normal value' }; const settings = { msgs: { isGreat: 'This field needs to be great!' }, fields: [{ name: 'field0', validators: { isGreat: true } }] }; const vv = vulcanval(settings); const field0Valid = vv.validateField('field0', map); console.log(field0Valid); // 'This field needs to be great!' &lt;static&gt; convertMapTo(to, map) Convert a map from nested to plain and viceversa. Parameters: Name Type Description to String It can have two values: plain or nested. map map The object to convert. Returns: The converted object map. Type map &lt;static&gt; extendLocale(locale) Extend validators messages in an specific localization globally. If it does not exist it will be created. Parameters: Name Type Description locale Object A plain object describing the locale. Properties Name Type Description id String The identifier of the locale. It should be like: 'en', 'es', 'jp' or similar. msgs Object A plain object with validators names as keys and messages formats as values. It should have a default value with the key general, which will be used when there is no message for an specific validator on error. Example const locale = { id: 'jp', msgs: { // Default error message: &quot;Invalid form field error&quot;. general: '無効なフォームフィールド。', // Message: &quot;Form field has to be alphanumeric error message.&quot; isAlphanumeric: 'フォームフィールドは、英数字である必要があります。' } }; vulcanval.extendLocale(locale); // To set it as default, use: vulcanval.settings.locale = 'jp'; // The identifier × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:46:55-05:00 using the DocStrap template. "},"settings.html":{"id":"settings.html","title":"Namespace: settings","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow Namespace: settings settings vulcanval validation settings by default. When using validation methods you have to pass an object settings to configure the validation process which will overwrite this settings used by default. Namespaces validators Members &lt;static&gt; autostart :Boolean Only client-side. Validate field elements on instance time. Type: Boolean Default Value: false &lt;static&gt; classes :Object Only client-side. HTML tag classes to add to specific elements in form on default and on error. Type: Object Properties: Name Type Argument Description defaults Object &lt;optional&gt; Static classes. Properties Name Type Argument Description form String &lt;optional&gt; Form classes. field String &lt;optional&gt; Field classes. label String &lt;optional&gt; Field related label classes. display String &lt;optional&gt; Display classes. error Object &lt;optional&gt; On error classes. Properties Name Type Argument Description form String &lt;optional&gt; Form classes. field String &lt;optional&gt; Field classes. label String &lt;optional&gt; Field related label classes. display String &lt;optional&gt; Display classes. &lt;static&gt; disabled :Boolean Form will not be instantiated. In client side, if &lt;form&gt; has the attribute disabled, this will be enabled. Type: Boolean Default Value: false &lt;static&gt; disableHTML5Validation :Boolean Only client-side. Disable HTML5 validation with novalidate attribute when instanced on &lt;form&gt;. This is enabled if attribute &quot;novalidate&quot; is present. Type: Boolean Default Value: false &lt;static&gt; enableNestedMaps :Boolean When a map of fields is created out of a form, should it be converted to a map of nested fields or only plain fields? Validation methods use this property to convert data maps from nested maps to plain maps when this property is enabled. Type: Boolean Default Value: false See: external:&quot;jQuery.fn&quot;.vulcanval Example // Using a form like this: // &lt;form&gt; // &lt;input name=&quot;field1&quot; /&gt; // &lt;input name=&quot;map1.field2&quot; /&gt; // &lt;input name=&quot;map1.field3&quot; /&gt; // &lt;input name=&quot;map2.field4&quot; /&gt; // &lt;/form&gt; const map = $('form').vulcanval('getMap'); // If nested maps are enabled, the map object will have this value: // { field1: '', map1: { field2: '', field3: '' }, map2: { field4: '' } } // Otherwise: // { field1: '', 'map1.field2': '', 'map1.field3': '', 'map2.field4': '' } &lt;static&gt; fields :Array The form fields to configure. Type: Array Default Value: [ ] See: See fieldSettings for more info about its configuration. &lt;static&gt; fieldsets :Array The form fieldsets to configure. Type: Array Default Value: [ ] See: See fieldsetSettings for more info about its configuration. &lt;static&gt; firstValidationEvent :String Only client-side. What event to listen to trigger the first validation on fields. Type: String Default Value: 'blur change' &lt;static&gt; intern :Boolean Only client-side. When a field is validated, don't show changes visually nor show messages. This is used to know whether they are valid or not, update the fields elements states and trigger events. Type: Boolean Default Value: false &lt;static&gt; locale :String Default messages locale. Type: String Default Value: 'en' &lt;static&gt; msgs :Object Validators messages formats. This is an a plain object with keys as validator names and values as messages formats. The messages can be configured by locale otherwise the messages will be for the validator regardless the locale configured. If a validator does not have a message for a locale, it will use the message general in the locale. The formats can have some variables expressed as {{var}} where var is the variable name. The variable {{value}} is always present to use and it's the value of the field validating. The variable {{option}} can be used when the validator is configured with an string. Ex: in validator isAlphanumeric: 'de-DE', the variable will have the de-DE value. This also applies to numbers. If the validator is configured with an object, then its properties are available as variables. Ex: in isInt: {min:4, max:8}, {{min}} and {{max}} will be available as variables in the message. There is one exception, the validator isLength can have an specific message for its two properties to configure, min and max values. Other validators only have messages regardless the properties passes to it. See examples. Also, the order of validator messages on errors can vary. Type: Object Default Value: {} Example const map = { username: 'Romel Pérez', age: 720 }; const settings = { locale: 'es', msgs: { // Used regardless the locale. isAlphanumeric: 'Debe ser alfanumérico en local &quot;{{option}}&quot;.', // Configured by locale. isInt: { en: 'Value &quot;{{value}}&quot; must be a integer number.', es: 'Valor &quot;{{value}}&quot; debe ser número entero.' }, // This is an special case. We can configure by properties only in this validator. isLength: { // We can configure a global message when the validator fails in this property. min: 'Mínimo valor: {{min}}.', // And we can configure by locale too. max: { en: 'Maximum value: {{max}}.', es: 'Máximo valor: {{max}}.' } } }, fields: [{ name: 'username', validators: { isAlphanumeric: 'en-GB', isLength: { min: 4, max: 16 }, // If this fails, the default message will be used because the package // does not have a message for this validator by default isMongoId: true } }, { name: 'age', validators: { isInt: { max: 500 } } }] }; const vv = vulcanval(settings); let usernameValid = vv.validateField('username', map); console.log(usernameValid); // 'Debe ser alfanumérico en local &quot;en-GB&quot;.' map.username = 'rp'; usernameValid = vv.validateField('username', map); console.log(usernameValid); // 'Mínimo valor: 4.' let ageValid = vv.validateField('age', map); console.log(ageValid); // 'Valor &quot;720&quot; debe ser número entero.' &lt;static&gt; validationEvents :String Only client-side. After first validation, what events to listen to re-validate fields. Type: String Default Value: 'input blur change' × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:46:55-05:00 using the DocStrap template. "},"settings.validators.html":{"id":"settings.validators.html","title":"Namespace: validators","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow Namespace: validators settings. validators List of custom validators. All of them recieve two parameters, the first one is the field value and the second one the options gave to it when configured. Only if the user configured a validator with an string, number or object value, it is received. The context of the validators is utilityContext so don't use arrow functions. See: vulcanval.addValidator() to see how to add new ones. fieldSettings.validators to see how to implement them. Methods &lt;static&gt; isAlphanumericText() This is the same as the validator isAlphanumeric except that this cleans spaces and line endings before validating so the field needs to have valid alphanumeric strings. &lt;static&gt; isEqualToField() This field value has to be the same as another field the form. The name of the comparing field should be set as a string parameter. × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:46:55-05:00 using the DocStrap template. "},"utilityContext.html":{"id":"utilityContext.html","title":"Namespace: utilityContext","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow Namespace: utilityContext utilityContext This is the function context used in some methods/functions in validations processes. Also, this object has all the methods in the validator package. So you can shortcut them easily. Members &lt;static&gt; get :function A method used to get another field value in the data map used in the validation. You need to pass the name of the field as a first parameter and will return its value in the data map. If the map was nested when used in a validation method, you need to reference it as it were plain, ex: { person: { age: 22 } } will be gotten with .get('person.age'). If the field was not found, undefined will be returned. Type: function &lt;static&gt; validator :Object Reference to the validator package. Type: Object × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:46:55-05:00 using the DocStrap template. "},"validator.html":{"id":"validator.html","title":"Namespace: validator","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow Namespace: validator validator This is an object created by the module vulcanval by specified settings to validate data maps. This object has some methods to help you validate data possibly extracted from forms through a configuration that can be used in client side and server side. See: vulcanval to see how to create this object. Methods &lt;static&gt; cleanMap(isPlain, map) Clean a map from properties outside the validation process. This is done by removing all properties which are not present in the fields list of validation and the fields which are disabled or intented to be only used in client side. Parameters: Name Type Description isPlain Boolean If the map is plain. false for nested. map map The map to clean. See: An example of this method is in the demo server. Returns: The cleaned map. Type map &lt;static&gt; validate(map) Validate provided data map and get an object describing each field error if there are. Parameters: Name Type Description map map The data map. Returns: If the map is valid, false will be returned. Otherwise there will be an object describing each field error as a plain map with its keys as the fields names even if the property settings.enableNestedMaps is enabled. Use the vulcanval.convertMapTo method if needed. Type Boolean | Object Example const map = { name: 'Romel', age: 22, likesPumpkin: false }; const settings = { fields: [{ name: 'name', required: true, validators: { isAlphanumeric: 'en-US', isLowercase: true } }, { name: 'age', validators: { isInt: { min: 1, max: 500 } } }, { name: 'likesPumpkin', required: true }] }; const vv = vulcanval(settings); const result = vv.validate(map); console.log(result); // { // name: 'This field should only contain lowercase text.', // likesPumpkin: 'Please fill out this field.' // } map.name = 'romel'; map.likesPumpkin = true; const result2 = vv.validate(map); console.log(result2); // false &lt;static&gt; validateField(fieldName, map) Validate a field in provided data map. Parameters: Name Type Description fieldName String The field name to validate. If the map is nested, the field name should be set as in plain map. Ex: {user: {name: 'romel'}} will be 'user.name'. map map The data map (plain or nested). Returns: If it is valid, false will be returned. Otherwise there will be an string message describing the error. Type Boolean | String Example const map = { name: 'Romel', age: 22, likesPumpkin: false }; const settings = { fields: [{ name: 'name', required: true, validators: { isAlphanumeric: 'en-US', isLowercase: true } }, { name: 'age', validators: { isInt: { min: 1, max: 500 } } }] }; const vv = vulcanval(settings); const nameResult = vv.validateField('name', map); console.log(nameResult); // 'This field should only contain lowercase text.' const ageResult = vv.validateField('age', map); console.log(ageResult); // false &lt;static&gt; validateFieldset(fieldsetName, map) Validate all fields of fieldset in map provided. Parameters: Name Type Description fieldsetName String The fieldset name to validate. map map The data map (plain or nested). Returns: If the fieldset fields are valid, false will be returned. Otherwise there will be an object describing each field error as a plain map with its keys as the fields names even if the property settings.enableNestedMaps is enabled. Use the vulcanval.convertMapTo method if needed. Type Boolean | Object Example const map = { user: { name: 'Romel', age: 22 }, course: { id: '4cdfb11e1f3c000000007822', register: 'wrong value' } }; const settings = { // Usually you would use nested maps with fieldsets. enableNestedMaps: true, fieldsets: [{ name: 'user', fields: ['user.name', 'user.age'], required: true }, { name: 'course', fields: ['course.id', 'course.register'], required: true }], fields: [{ name: 'user.name', validators: { isAlphanumeric: true, isLowercase: true } }, { name: 'user.age', validators: { isInt: { min: 1, max: 500 } } }, { name: 'course.id', validators: { isMongoId: true } }, { name: 'course.register', validators: { isISO8601: true } }] }; const vv = vulcanval(settings); const nameResult = vv.validateFieldset('user', map); console.log(nameResult); // { 'user.name': 'This field should only contain lowercase text.' } const ageResult = vv.validateFieldset('course', map); console.log(ageResult); // { 'course.register': 'Please type a valid date.' } × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:46:55-05:00 using the DocStrap template. "}}
+    {"modules.list.html":{"id":"modules.list.html","title":"Modules","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow Modules Namespaces fieldsetSettings fieldSettings map settings validators utilityContext validator × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:58:56-05:00 using the DocStrap template. "},"namespaces.list.html":{"id":"namespaces.list.html","title":"Namespaces","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow Namespaces Namespaces fieldsetSettings fieldSettings map settings validators utilityContext validator × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:58:56-05:00 using the DocStrap template. "},"externals.list.html":{"id":"externals.list.html","title":"Externals","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow Externals Namespaces fieldsetSettings fieldSettings map settings validators utilityContext validator × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:58:56-05:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow VulcanVal Vulcan Validator, validate HTML form data universally seamlessly. A package to validate maps of data extracted from HTML forms in the client and server sides and a customizable jQuery plugin to validate forms as you type with ease. This is the JavaScript API documentation. Here you will find information in detail about the use of the VulcanVal package for global use, client and server side, and the jQuery plugin to validate HTML forms in realtime. In short, you can use the module vulcanval and all its methods in node.js with: const vulcanval = require('vulcanval');When you have installed the module in client side, you can make use of the module by accessing the global variable: window.vulcanval;And when you install the plugin, the jQuery plugin namespace is: jQuery().vulcanval();You can see the global configurations used by the module, the fieldset configurations and the field configurations used by default and change some of them to apply among all instances. More info at Documentation | Demos | JS API | SASS Config LicenseMIT × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:58:56-05:00 using the DocStrap template. "},"external-_jQuery.fn_.html":{"id":"external-_jQuery.fn_.html","title":"External: jQuery.fn","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow External: jQuery.fn jQuery.fn The jQuery plugin namespace. See: The jQuery Plugin Guide Methods &lt;static&gt; vulcanval(getMap) Get the data map extracted from the &lt;form&gt;. If the instance was configured with the setting settings.enableNestedMaps as true, the map returned will be nested. Otherwise it will be plain. This method can also be used over &lt;form&gt; elements without being instantiated and will return a plain data map with all its inputs, selects and textareas values. Parameters: Name Type Description getMap String With value 'getMap'. Returns: The data map. Type map &lt;static&gt; vulcanval(validateFieldset, fieldsetName) Invoke over instantiated elements. Validate visually all fields of an specific fieldset in &lt;form&gt;. Parameters: Name Type Description validateFieldset String With value 'validateFieldset'. fieldsetName String The fieldset name to validate. Returns: The same jQuery object. Type external:jQuery &lt;static&gt; vulcanval(validateField, fieldName) Invoke over instantiated elements. Validate visually an specific field in &lt;form&gt;. Parameters: Name Type Description validateField String With value 'validateField'. fieldName String The field name to validate. Returns: The same jQuery object. Type external:jQuery &lt;static&gt; vulcanval(inspectField [, fieldName]) Invoke over instantiated elements. Inspect the validation status of an specific field in &lt;form&gt;. Parameters: Name Type Argument Description inspectField String With value 'inspectField'. fieldName String &lt;optional&gt; The field name to inspect. Returns: It will return an error message if field is invalid, otherwise false. Type String | Boolean &lt;static&gt; vulcanval(validate) Invoke over instantiated elements. Validate visually all fields in &lt;form&gt;. Parameters: Name Type Description validate String With value 'validate'. Returns: The same jQuery object. Type external:jQuery &lt;static&gt; vulcanval(resetFieldset, fieldsetName) Invoke over instantiated elements. Reset all fields in fieldset validation state. This removes all current error states in those fields. Parameters: Name Type Description resetFieldset String With value 'resetFieldset'. fieldsetName String Fieldset name to reset. Returns: The same jQuery object. Type external:jQuery &lt;static&gt; vulcanval(resetField, fieldName) Invoke over instantiated elements. Reset specific field validation state. This removes all current error states from field. Parameters: Name Type Description resetField String With value 'resetField'. fieldName String The name of the field. Returns: The same jQuery object. Type external:jQuery &lt;static&gt; vulcanval(reset) Invoke over instantiated elements. Reset the &lt;form&gt; validation state. This removes all current error states. Parameters: Name Type Description reset String With value 'reset'. Returns: The same jQuery object. Type external:jQuery &lt;static&gt; vulcanval(inspectFieldset, fieldsetName) Invoke over instantiated elements. Inspect the validation status of all fields in fieldset in the &lt;form&gt;. Parameters: Name Type Description inspectFieldset String With value 'inspectFieldset'. fieldsetName String The fieldset name to inspect. Returns: A plain object with keys as field names and values with error messages if they have. If fieldset is valid, false will be returned. Type Object | String | Boolean &lt;static&gt; vulcanval(inspect) Invoke over instantiated elements. Inspect the validation status of the &lt;form&gt;. Parameters: Name Type Description inspect String With value 'inspect'. Returns: A plain object with keys as field names and values with error messages if they have. If form is valid, false will be returned. Type Object | String | Boolean &lt;static&gt; vulcanval(settings) jQuery plugin to instantiate the validators in forms. Defines validation functionalities over form elements. This can be instantiated on forms or any form elements with a valid attribute name: &lt;form&gt; &lt;input&gt; with type different than file, submit, image, button and reset &lt;textarea&gt; &lt;select&gt; Also, the plugin can be instantiated on any element with a valid input name in attribute data-vv-name which will be treated as a normal &lt;input&gt;. This is useful to create custom fields/entries. Parameters: Name Type Description settings settings Instance settings. This is used to configure the whole validation process. See: Also see the demos to learn how to implement this method. Returns: The same jQuery object. Type external:jQuery × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:58:56-05:00 using the DocStrap template. "},"external-jQuery.html":{"id":"external-jQuery.html","title":"External: jQuery","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow External: jQuery jQuery jQuery object. See: http://api.jquery.com/jQuery/ × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:58:56-05:00 using the DocStrap template. "},"external-window.html":{"id":"external-window.html","title":"External: window","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow External: window window window object. See: https://developer.mozilla.org/en-US/docs/Web/API/Window Members &lt;static&gt; vulcanval :Object This is a reference to the vulcanval. Type: Object See: module:vulcanval × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:58:56-05:00 using the DocStrap template. "},"fieldsetSettings.html":{"id":"fieldsetSettings.html","title":"Namespace: fieldsetSettings","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow Namespace: fieldsetSettings fieldsetSettings These properties and methods will affect the fields settings. This is configured in settings.fieldsets array property. Important: one field can be affected by more than one fieldset so if you set two fieldsets that match the same field, it will have the configuration of both of them, being priority the last one. Members &lt;static&gt; autostart :Boolean Default fieldSettings.autostart value in fieldset. Type: Boolean Default Value: false &lt;static&gt; disabled :Boolean Default fieldSettings.disabled value in fieldset. Type: Boolean Default Value: false &lt;static&gt; fields :RegExp|String|Array The fields this fieldset covers. This is required. This can be a RegExp to match against the fields names, a string that is the starting string of fields names or an array with the names of the fields. Type: RegExp | String | Array &lt;static&gt; firstValidationEvent :Boolean Default fieldSettings.firstValidationEvent value in fieldset. Type: Boolean Default Value: false &lt;static&gt; intern :Boolean Default fieldSettings.intern value in fieldset. Type: Boolean Default Value: false &lt;static&gt; name :String Fieldset name. This will be used to identify this fieldset and it is required. Type: String &lt;static&gt; onlyIf :Boolean Middleware fieldSettings.onlyIf value in fieldset. This function will be used in the fields to determine if they will be validated or not. Type: Boolean Default Value: false &lt;static&gt; onlyUI :Boolean Default fieldSettings.onlyUI value in fieldset. Type: Boolean Default Value: false &lt;static&gt; required :Boolean Default fieldSettings.required value in fieldset. Type: Boolean Default Value: false &lt;static&gt; validationEvents :Boolean Default fieldSettings.validationEvents value in fieldset. Type: Boolean Default Value: false &lt;static&gt; validators :Boolean Extends fieldSettings.validators value in fieldset so all fields that this fieldset covers will extend their validators with this object. Type: Boolean Default Value: false × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:58:56-05:00 using the DocStrap template. "},"fieldSettings.html":{"id":"fieldSettings.html","title":"Namespace: fieldSettings","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow Namespace: fieldSettings fieldSettings The default properties and methods for a field. This is configured in settings.fields array property. Each field settings can be affected by the main settings and by the fieldsetSettings. Members &lt;static&gt; autostart :Boolean Only client-side. Validate field elements on instance time. Type: Boolean Default Value: false &lt;static&gt; disabled :Boolean Field will be ignored in validation if true. Type: Boolean Default Value: false &lt;static&gt; display :external:jQuery Only client-side. The element where to set the current field message error. If not specified, the messages won't be shown on UI. When configured by HTML attribute data-vv-display, the value expected should be a jQuery selector. Otherwise this can be anything to select with the jQuery selector method. Type: external:jQuery &lt;static&gt; firstValidationEvent :String Only client-side. What event to listen to trigger the first validation on field. Type: String Default Value: Inherited from settings &lt;static&gt; intern :Boolean Only client-side. When a field is validated, don't show changes visually nor show messages. This is used to know whether they are valid or not, update the fields elements states and trigger events. Type: Boolean Default Value: false &lt;static&gt; name :String The field name. This property is required. Type: String &lt;static&gt; onlyUI :Boolean Only client-side. Ignore field in validation in server side. Type: Boolean Default Value: false &lt;static&gt; required :Boolean Field is required and cannot be undefined nor empty string. If the field is not required but it does NOT have a truthy value, then this will pass over all validators. Type: Boolean Default Value: false &lt;static&gt; validationEvents :String Only client-side. After first validation, what events to listen to re-validate field. Type: String Default Value: Inherited from settings &lt;static&gt; validators :Object The validators list. This is an object with keys as the validators names and values as their configuration. If the value is simply a boolean true, the validator will be invoked without options. It it is string, number or object it will be send as validator options. If value is false, the validator will not be used. These won't be used if the field value is boolean. You can use all validators from the validator package. This object will be merged with the fieldsets validators this field is in. Type: Object Methods &lt;static&gt; onlyIf() A condition gate to verify if the field will be validated. Receives the field value as first parameter and has to return a boolean, if true the validation will procced as normal, otherwise the validation will halt. This is a function with the utility context as function context so don't use arrow functions. Returns: Type Boolean &lt;static&gt; value($field) Only client-side. Method to get the value of the field. This will have the utilty context so don't use arrow functions. By default this can retrieve the value of &lt;input&gt;s of any kind except image, submit, reset, file and button, &lt;textarea&gt;s and &lt;select&gt;s. You can overwrite this to create your own custom field value getter. Otherwise leave this property as default. The first paramter $field will be binded to the function and it is the jQuery element the fields belongs to. Parameters: Name Type Description $field external:jQuery The field element. Returns: The value returned will depend on the type of element or what you configure if you overwrite this method. Type * × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:58:56-05:00 using the DocStrap template. "},"map.html":{"id":"map.html","title":"Namespace: map","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow Namespace: map map A plain object as a data map extracted from a &lt;form&gt;. This is basically a plain object with keys as form fields names and values as their respective values. The values can be strings, numbers or booleans. Currently there is no support for arrays. The keys can be simple alphanumeric values but can be used to describe a nested or deep map if they have dots in the string in plain maps. The dots are to describe &lt;fieldset&gt;s in the form and improve the structure of complex forms. If the map is plain and its keys have dots in the strings, it can be converted to a nested map. The inverse is the same, if the map is nested and has possibly many levels of deep objects, it can be converted to a plain map with dots in the keys describing the deep fields. See: The settings.enableNestedMaps which is used in the validation methods to determine how to treat the data map. Mainly used in server-side. The jQuery.fn.vulcanval `getMap` method which extracts a data map from the form or fields used in validation. Used in client-side. Example // Plain map. const plainMap = { normal: 'value0', another: true, 'using.dots.inside': 100 }; // Nested map. const nestedMap = { name: 'Romel Pérez', age: 22, like: { apple: true, watermelon: true, pumpkin: false }, favourite: { fruit: 'Cantaloupe', book: 'Spice and Wolf', game: 'World of Warcraft' } }; × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:58:56-05:00 using the DocStrap template. "},"module-vulcanval.html":{"id":"module-vulcanval.html","title":"Module: vulcanval","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow Module: vulcanval The vulcan validator (vulcanval) creator. This module is a function which receives a settings object and returns a validator object to validate data maps. Also this has some properties and methods to configure the validations globally. In Node.js environments use like: const vulcanval = require('vulcanval');In browser environments this object is available in window.vulcanval. See: validator Example // Changing a global configuration in settings. vulcanval.settings.locale = 'pt'; // Addind a new validator method. vulcanval.addValidator('valName', function () { ... }); // Extending/creating a new locale/language. vulcanval.extendLocale({ ... }); // A form configuration to create a validator. const settings = { fields: [{ name: 'fieldName', validators: {} }] }; // Creating a validator from settings. const validator = vulcanval(settings); // A data map to validate. const map = { fieldName: 'field value' }; // Validating the map with the validator. const result = validator.validate(map); Members &lt;static&gt; log :Object This is a reference to the prhone-log package instance used to log messages. Type: Object &lt;static&gt; settings :Object This is a reference to the settings global configuration. Type: Object &lt;static&gt; utilityContext :Object This is a reference to the utilityContext global configuration. This can be mutated to use your own custom properties and methods in any method/function that make use of this context. Type: Object &lt;static&gt; validator :Object This is a reference to the validator package. Type: Object Methods &lt;static&gt; addValidator(name, validator) Add a custom validator globally. All validators in the package validator are installed and ready to use. Parameters: Name Type Description name String An alphanumeric validator name. validator function The validator function. Receives as a first parameter the value of the field and has to return a truthy value. This function will have the utility context as function context. Don't pass arrow functions. See: In the example is used the validator.validateField static method to test the new validator. Example vulcanval.addValidator('isGreat', function (value) { return value.length &gt; 4 &amp;&amp; value.indexOf('great') &gt;= 0; }); const map = { field0: 'normal value' }; const settings = { msgs: { isGreat: 'This field needs to be great!' }, fields: [{ name: 'field0', validators: { isGreat: true } }] }; const vv = vulcanval(settings); const field0Valid = vv.validateField('field0', map); console.log(field0Valid); // 'This field needs to be great!' &lt;static&gt; convertMapTo(to, map) Convert a map from nested to plain and viceversa. Parameters: Name Type Description to String It can have two values: plain or nested. map map The object to convert. Returns: The converted object map. Type map &lt;static&gt; extendLocale(locale) Extend validators messages in an specific localization globally. If it does not exist it will be created. Parameters: Name Type Description locale Object A plain object describing the locale. Properties Name Type Description id String The identifier of the locale. It should be like: 'en', 'es', 'jp' or similar. msgs Object A plain object with validators names as keys and messages formats as values. It should have a default value with the key general, which will be used when there is no message for an specific validator on error. Example const locale = { id: 'jp', msgs: { // Default error message: &quot;Invalid form field error&quot;. general: '無効なフォームフィールド。', // Message: &quot;Form field has to be alphanumeric error message.&quot; isAlphanumeric: 'フォームフィールドは、英数字である必要があります。' } }; vulcanval.extendLocale(locale); // To set it as default, use: vulcanval.settings.locale = 'jp'; // The identifier × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:58:56-05:00 using the DocStrap template. "},"settings.html":{"id":"settings.html","title":"Namespace: settings","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow Namespace: settings settings vulcanval validation settings by default. When using validation methods you have to pass an object settings to configure the validation process which will overwrite this settings used by default. Namespaces validators Members &lt;static&gt; autostart :Boolean Only client-side. Validate field elements on instance time. Type: Boolean Default Value: false &lt;static&gt; classes :Object Only client-side. HTML tag classes to add to specific elements in form on default and on error. Type: Object Properties: Name Type Argument Description defaults Object &lt;optional&gt; Static classes. Properties Name Type Argument Description form String &lt;optional&gt; Form classes. field String &lt;optional&gt; Field classes. label String &lt;optional&gt; Field related label classes. display String &lt;optional&gt; Display classes. error Object &lt;optional&gt; On error classes. Properties Name Type Argument Description form String &lt;optional&gt; Form classes. field String &lt;optional&gt; Field classes. label String &lt;optional&gt; Field related label classes. display String &lt;optional&gt; Display classes. &lt;static&gt; disabled :Boolean Form will not be instantiated. In client side, if &lt;form&gt; has the attribute disabled, this will be enabled. Type: Boolean Default Value: false &lt;static&gt; disableHTML5Validation :Boolean Only client-side. Disable HTML5 validation with novalidate attribute when instanced on &lt;form&gt;. This is enabled if attribute &quot;novalidate&quot; is present. Type: Boolean Default Value: false &lt;static&gt; enableNestedMaps :Boolean When a map of fields is created out of a form, should it be converted to a map of nested fields or only plain fields? Validation methods use this property to convert data maps from nested maps to plain maps when this property is enabled. Type: Boolean Default Value: false See: external:&quot;jQuery.fn&quot;.vulcanval Example // Using a form like this: // &lt;form&gt; // &lt;input name=&quot;field1&quot; /&gt; // &lt;input name=&quot;map1.field2&quot; /&gt; // &lt;input name=&quot;map1.field3&quot; /&gt; // &lt;input name=&quot;map2.field4&quot; /&gt; // &lt;/form&gt; const map = $('form').vulcanval('getMap'); // If nested maps are enabled, the map object will have this value: // { field1: '', map1: { field2: '', field3: '' }, map2: { field4: '' } } // Otherwise: // { field1: '', 'map1.field2': '', 'map1.field3': '', 'map2.field4': '' } &lt;static&gt; fields :Array The form fields to configure. Type: Array Default Value: [ ] See: See fieldSettings for more info about its configuration. &lt;static&gt; fieldsets :Array The form fieldsets to configure. Type: Array Default Value: [ ] See: See fieldsetSettings for more info about its configuration. &lt;static&gt; firstValidationEvent :String Only client-side. What event to listen to trigger the first validation on fields. Type: String Default Value: 'blur change' &lt;static&gt; intern :Boolean Only client-side. When a field is validated, don't show changes visually nor show messages. This is used to know whether they are valid or not, update the fields elements states and trigger events. Type: Boolean Default Value: false &lt;static&gt; locale :String Default messages locale. Type: String Default Value: 'en' &lt;static&gt; msgs :Object Validators messages formats. This is an a plain object with keys as validator names and values as messages formats. The messages can be configured by locale otherwise the messages will be for the validator regardless the locale configured. If a validator does not have a message for a locale, it will use the message general in the locale. The formats can have some variables expressed as {{var}} where var is the variable name. The variable {{value}} is always present to use and it's the value of the field validating. The variable {{option}} can be used when the validator is configured with an string. Ex: in validator isAlphanumeric: 'de-DE', the variable will have the de-DE value. This also applies to numbers. If the validator is configured with an object, then its properties are available as variables. Ex: in isInt: {min:4, max:8}, {{min}} and {{max}} will be available as variables in the message. There is one exception, the validator isLength can have an specific message for its two properties to configure, min and max values. Other validators only have messages regardless the properties passes to it. See examples. Also, the order of validator messages on errors can vary. Type: Object Default Value: {} Example const map = { username: 'Romel Pérez', age: 720 }; const settings = { locale: 'es', msgs: { // Used regardless the locale. isAlphanumeric: 'Debe ser alfanumérico en local &quot;{{option}}&quot;.', // Configured by locale. isInt: { en: 'Value &quot;{{value}}&quot; must be a integer number.', es: 'Valor &quot;{{value}}&quot; debe ser número entero.' }, // This is an special case. We can configure by properties only in this validator. isLength: { // We can configure a global message when the validator fails in this property. min: 'Mínimo valor: {{min}}.', // And we can configure by locale too. max: { en: 'Maximum value: {{max}}.', es: 'Máximo valor: {{max}}.' } } }, fields: [{ name: 'username', validators: { isAlphanumeric: 'en-GB', isLength: { min: 4, max: 16 }, // If this fails, the default message will be used because the package // does not have a message for this validator by default isMongoId: true } }, { name: 'age', validators: { isInt: { max: 500 } } }] }; const vv = vulcanval(settings); let usernameValid = vv.validateField('username', map); console.log(usernameValid); // 'Debe ser alfanumérico en local &quot;en-GB&quot;.' map.username = 'rp'; usernameValid = vv.validateField('username', map); console.log(usernameValid); // 'Mínimo valor: 4.' let ageValid = vv.validateField('age', map); console.log(ageValid); // 'Valor &quot;720&quot; debe ser número entero.' &lt;static&gt; validationEvents :String Only client-side. After first validation, what events to listen to re-validate fields. Type: String Default Value: 'input blur change' × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:58:56-05:00 using the DocStrap template. "},"settings.validators.html":{"id":"settings.validators.html","title":"Namespace: validators","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow Namespace: validators settings. validators List of custom validators. All of them recieve two parameters, the first one is the field value and the second one the options gave to it when configured. Only if the user configured a validator with an string, number or object value, it is received. The context of the validators is utilityContext so don't use arrow functions. See: vulcanval.addValidator() to see how to add new ones. fieldSettings.validators to see how to implement them. Methods &lt;static&gt; isAlphanumericText() This is the same as the validator isAlphanumeric except that this cleans spaces and line endings before validating so the field needs to have valid alphanumeric strings. &lt;static&gt; isEqualToField() This field value has to be the same as another field the form. The name of the comparing field should be set as a string parameter. × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:58:56-05:00 using the DocStrap template. "},"utilityContext.html":{"id":"utilityContext.html","title":"Namespace: utilityContext","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow Namespace: utilityContext utilityContext This is the function context used in some methods/functions in validations processes. Also, this object has all the methods in the validator package. So you can shortcut them easily. Members &lt;static&gt; get :function A method used to get another field value in the data map used in the validation. You need to pass the name of the field as a first parameter and will return its value in the data map. If the map was nested when used in a validation method, you need to reference it as it were plain, ex: { person: { age: 22 } } will be gotten with .get('person.age'). If the field was not found, undefined will be returned. Type: function &lt;static&gt; validator :Object Reference to the validator package. Type: Object × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:58:56-05:00 using the DocStrap template. "},"validator.html":{"id":"validator.html","title":"Namespace: validator","body":" VulcanVal Namespaces fieldsetSettingsfieldSettingsmapsettingssettings.validatorsutilityContextvalidator Modules vulcanval Externals jQuery.fnjQuerywindow Namespace: validator validator This is an object created by the module vulcanval by specified settings to validate data maps. This object has some methods to help you validate data possibly extracted from forms through a configuration that can be used in client side and server side. See: vulcanval to see how to create this object. Methods &lt;static&gt; cleanMap(isPlain, map) Clean a map from properties outside the validation process. This is done by removing all properties which are not present in the fields list of validation and the fields which are disabled or intented to be only used in client side. Parameters: Name Type Description isPlain Boolean If the map is plain. false for nested. map map The map to clean. See: An example of this method is in the demo server. Returns: The cleaned map. Type map &lt;static&gt; validate(map) Validate provided data map and get an object describing each field error if there are. Parameters: Name Type Description map map The data map. Returns: If the map is valid, false will be returned. Otherwise there will be an object describing each field error as a plain map with its keys as the fields names even if the property settings.enableNestedMaps is enabled. Use the vulcanval.convertMapTo method if needed. Type Boolean | Object Example const map = { name: 'Romel', age: 22, likesPumpkin: false }; const settings = { fields: [{ name: 'name', required: true, validators: { isAlphanumeric: 'en-US', isLowercase: true } }, { name: 'age', validators: { isInt: { min: 1, max: 500 } } }, { name: 'likesPumpkin', required: true }] }; const vv = vulcanval(settings); const result = vv.validate(map); console.log(result); // { // name: 'This field should only contain lowercase text.', // likesPumpkin: 'Please fill out this field.' // } map.name = 'romel'; map.likesPumpkin = true; const result2 = vv.validate(map); console.log(result2); // false &lt;static&gt; validateField(fieldName, map) Validate a field in provided data map. Parameters: Name Type Description fieldName String The field name to validate. If the map is nested, the field name should be set as in plain map. Ex: {user: {name: 'romel'}} will be 'user.name'. map map The data map (plain or nested). Returns: If it is valid, false will be returned. Otherwise there will be an string message describing the error. Type Boolean | String Example const map = { name: 'Romel', age: 22, likesPumpkin: false }; const settings = { fields: [{ name: 'name', required: true, validators: { isAlphanumeric: 'en-US', isLowercase: true } }, { name: 'age', validators: { isInt: { min: 1, max: 500 } } }] }; const vv = vulcanval(settings); const nameResult = vv.validateField('name', map); console.log(nameResult); // 'This field should only contain lowercase text.' const ageResult = vv.validateField('age', map); console.log(ageResult); // false &lt;static&gt; validateFieldset(fieldsetName, map) Validate all fields of fieldset in map provided. Parameters: Name Type Description fieldsetName String The fieldset name to validate. map map The data map (plain or nested). Returns: If the fieldset fields are valid, false will be returned. Otherwise there will be an object describing each field error as a plain map with its keys as the fields names even if the property settings.enableNestedMaps is enabled. Use the vulcanval.convertMapTo method if needed. Type Boolean | Object Example const map = { user: { name: 'Romel', age: 22 }, course: { id: '4cdfb11e1f3c000000007822', register: 'wrong value' } }; const settings = { // Usually you would use nested maps with fieldsets. enableNestedMaps: true, fieldsets: [{ name: 'user', fields: ['user.name', 'user.age'], required: true }, { name: 'course', fields: ['course.id', 'course.register'], required: true }], fields: [{ name: 'user.name', validators: { isAlphanumeric: true, isLowercase: true } }, { name: 'user.age', validators: { isInt: { min: 1, max: 500 } } }, { name: 'course.id', validators: { isMongoId: true } }, { name: 'course.register', validators: { isISO8601: true } }] }; const vv = vulcanval(settings); const nameResult = vv.validateFieldset('user', map); console.log(nameResult); // { 'user.name': 'This field should only contain lowercase text.' } const ageResult = vv.validateFieldset('course', map); console.log(ageResult); // { 'course.register': 'Please type a valid date.' } × Search results Close © 2016 Romel Pérez Documentation generated by JSDoc 3.4.0 on 2016-10-28T23:58:56-05:00 using the DocStrap template. "}}
     </script>
 
     <script type="text/javascript">
diff --git a/doc/js/settings.html b/doc/js/settings.html
index d985620..c193885 100644
--- a/doc/js/settings.html
+++ b/doc/js/settings.html
@@ -1696,7 +1696,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
 	
-		on 2016-10-28T23:46:55-05:00
+		on 2016-10-28T23:58:56-05:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>
diff --git a/doc/js/settings.validators.html b/doc/js/settings.validators.html
index 09cf547..ddcfd9c 100644
--- a/doc/js/settings.validators.html
+++ b/doc/js/settings.validators.html
@@ -384,7 +384,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
 	
-		on 2016-10-28T23:46:55-05:00
+		on 2016-10-28T23:58:56-05:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>
diff --git a/doc/js/utilityContext.html b/doc/js/utilityContext.html
index c52a3ab..a541f19 100644
--- a/doc/js/utilityContext.html
+++ b/doc/js/utilityContext.html
@@ -362,7 +362,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
 	
-		on 2016-10-28T23:46:55-05:00
+		on 2016-10-28T23:58:56-05:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>
diff --git a/doc/js/validator.html b/doc/js/validator.html
index 227a38c..81b1ae3 100644
--- a/doc/js/validator.html
+++ b/doc/js/validator.html
@@ -1063,7 +1063,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
 	
-		on 2016-10-28T23:46:55-05:00
+		on 2016-10-28T23:58:56-05:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>