roc

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl" href="../../../"> <title data-ice="title">src/validation/validators.js | API Document</title> <link type="text/css" rel="stylesheet" href="css/style.css"> <link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css"> <script src="script/prettify/prettify.js"></script> <script src="script/manual.js"></script> </head> <body class="layout-container" data-ice="rootContainer"> <header> <a href="./">Home</a> <a href="identifiers.html">Reference</a> <a href="source.html">Source</a> <a data-ice="repoURL" href="https://github.com/vgno/roc.git" class="repo-url-github">Repository</a> <div class="search-box"> <img src="./image/search.png"> <input class="search-input"> <ul class="search-result"></ul> </div> </header> <nav class="navigation" data-ice="nav"><div> <ul> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">cli</div>F<a href="function/index.html#static-function-execute">execute</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-buildCompleteConfig">buildCompleteConfig</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-generateCommandDocumentation">generateCommandDocumentation</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-generateCommandsDocumentation">generateCommandsDocumentation</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getMappings">getMappings</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getSuggestions">getSuggestions</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-parseArguments">parseArguments</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-parseOptions">parseOptions</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-runCli">runCli</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">commands</div>F<a href="function/index.html#static-function-init">init</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">commands/helpers</div>F<a href="function/index.html#static-function-validRocProject">validRocProject</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-get">get</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getVersions">getVersions</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-defaultPrompt">defaultPrompt</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">configuration</div>F<a href="function/index.html#static-function-getApplicationConfig">getApplicationConfig</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-appendConfig">appendConfig</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-appendSettings">appendSettings</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getConfig">getConfig</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getSettings">getSettings</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-merge">merge</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">documentation</div>F<a href="function/index.html#static-function-buildDocumentationObject">buildDocumentationObject</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-generateTable">generateTable</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-addPadding">addPadding</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getDefaultValue">getDefaultValue</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-pad">pad</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-toCliFlag">toCliFlag</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-generateMarkdownDocumentation">generateMarkdownDocumentation</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-generateTextDocumentation">generateTextDocumentation</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">helpers</div>F<a href="function/index.html#static-function-fileExists">fileExists</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getAbsolutePath">getAbsolutePath</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getPackageJson">getPackageJson</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getRocDependencies">getRocDependencies</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-error">error</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-errorLabel">errorLabel</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-important">important</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-importantLabel">importantLabel</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-ok">ok</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-okLabel">okLabel</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-warning">warning</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-warningLabel">warningLabel</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">typedef</div>T<a href="typedef/index.html#static-typedef-infoObject">infoObject</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-rocCommandObject">rocCommandObject</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-rocConfig">rocConfig</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-rocDocumentationObject">rocDocumentationObject</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-rocMapObject">rocMapObject</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-rocMetaConfig">rocMetaConfig</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-rocMetaSettings">rocMetaSettings</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-rocMetaSettings">rocMetaSettings</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-rocOptions">rocOptions</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-rocSettings">rocSettings</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-rocTableHeader">rocTableHeader</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-rocTableSettings">rocTableSettings</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">validation</div>F<a href="function/index.html#static-function-isValid">isValid</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-throwError">throwError</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-validate">validate</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-validateMightThrow">validateMightThrow</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-isArray">isArray</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-isArrayOrSingle">isArrayOrSingle</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-isBoolean">isBoolean</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-isInteger">isInteger</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-isObject">isObject</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-isPath">isPath</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-isString">isString</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-oneOf">oneOf</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-required">required</a></li> </ul> </div> </nav> <div class="content" data-ice="content"><h1 data-ice="title">src/validation/validators.js</h1> <pre class="source-code line-number raw-source-code"><code class="prettyprint linenums" data-ice="content">import 'source-map-support/register'; import { isArray as lodashIsArray, isString as lodashIsString, isBoolean as lodashIsBoolean, isPlainObject as lodashIsPlainObject, isFunction as lodashIsFunction } from 'lodash'; import { isValid } from './index.js'; /** * Validates an array using a validator. * * @param {function|RegExp} validator - The validator to use on the elements in the array. * @return {function} - A function that takes a value and that returns true or false if valid or not. */ export function isArray(validator) { return (input, info) => { if (info) { return infoObject(validator, (wrap) => (`[ ${wrap} ]`)); } if (!lodashIsArray(input)) { return 'Was not an array!'; } return isArrayOrSingle(validator)(input); }; } /** * Validates an object using a validator. * * @param {function|RegExp} validator - The validator to use on the elements in the object * @return {function} - A function that takes a value and that returns true or false if valid or not. */ export function isObject(validator) { return (input, info) => { if (info) { return infoObject(validator, (wrap) => `{ ${wrap} }`); } if (!lodashIsPlainObject(input)) { return 'Was not an object!'; } if (!validator) { return true; } return Object.keys(input).map((key) => isValid(input[key], validator)) .reduce((a, b) => a === true && b === true, true); }; } /** * Validates an pontential array using a validator. * * Allows that a single value is given. * * @param {function|RegExp} validator - The validator to use on the elements in the array. * @return {function} - A function that takes a value and that returns true or false if valid or not. */ export function isArrayOrSingle(validator) { return (input, info) => { if (info) { return infoObject(validator, (wrap) => (`${wrap} / [ ${wrap} ]`)); } const array = [].concat(input); for (const value of array) { const result = isValid(value, validator); if (result !== true) { return result; } } return true; }; } /** * Validates an string. * * @param {object} value - Something to validate. * @param {boolean} info - If type information should be returned. * @return {infoObject|boolean|string} - Type information or if it is valid. */ export function isString(value, info) { if (info) { return infoObject('String'); } if (!lodashIsString(value)) { return 'Was not a string!'; } return true; } /** * Validates an string. * * @param {object} value - Something to validate. * @param {boolean} info - If type information should be returned. * @return {infoObject|boolean|string} - Type information or if it is valid. */ export function isBoolean(value, info) { if (info) { return infoObject('Boolean'); } if (!lodashIsBoolean(value)) { return 'Was not a boolean!'; } return true; } /** * Validates an string. * * @param {object} value - Something to validate. * @param {boolean} info - If type information should be returned. * @return {infoObject|boolean|string} - Type information or if it is valid. */ export function isInteger(value, info) { if (info) { return infoObject('Integer'); } if (!Number.isInteger(value)) { return 'Was not an integer!'; } return true; } /** * Validates an string. * * @param {object} value - Something to validate. * @param {boolean} info - If type information should be returned. * @return {infoObject|boolean|string} - Type information or if it is valid. */ export function isPath(value, info) { if (info) { return infoObject('Filepath'); } if (isString(value) !== true) { return 'Was not a filepath!'; } return true; } /** * Validates against a list of validators. * * @param {...function} validators - Validators to validate against. * @return {function} - A function that takes a value and that returns true or false if valid or not. */ export function oneOf(...validators) { if (!validators.length) { throw new Error('You need to use at least one validator.'); } return (input, info) => { if (info) { let types = []; for (const validator of validators) { types.push(infoObject(validator).type); } return infoObject(types.join(' / ')); } const invalid = []; for (const validator of validators) { const result = isValid(input, validator); if (result === true) { return true; } invalid.push(validator(null, true).type); } return 'Was not any of the possible types:\n' + invalid.reduce((prev, next) => prev + '\n' + next, ''); }; } /** * Marks that the value is required * * @param {function} validator - Validator to validate against * @return {function} - A function that takes a value and that returns true or false if valid or not. */ export function required(validator) { return (input, info) => { if (info) { return infoObject(validator, null, true); } if ( !input && input !== false || (lodashIsArray(input) || lodashIsString(input)) && input.length === 0 || lodashIsPlainObject(input) && Object.keys(input).length === 0 ) { return 'A value was required but none was given!'; } if (!validator) { return true; } return validator(input); }; } function infoObject(validator, wrapper, req = false) { const info = lodashIsFunction(validator) ? validator(null, true).type : validator.toString(); const type = wrapper ? wrapper(info) : info; return { type, required: req }; } </code></pre> </div> <footer class="footer"> Generated by <a href="https://esdoc.org">ESDoc(0.4.3)</a> </footer> <script src="script/search_index.js"></script> <script src="script/search.js"></script> <script src="script/pretty-print.js"></script> <script src="script/inherited-summary.js"></script> <script src="script/test-summary.js"></script> <script src="script/inner-link.js"></script> <script src="script/patch-for-local.js"></script> </body> </html>