roc

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl" href="../../../"> <title data-ice="title">src/typedef/index.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/typedef/index.js</h1> <pre class="source-code line-number raw-source-code"><code class="prettyprint linenums" data-ice="content">/** * Validator info object. * * @typedef {Object} infoObject * @property {string} type - The type. * @property {boolean} required - If it is required. */ /** * Validator info object. * * @typedef {Object} rocCommandObject * @property {boolean} debug - If debug mode has been enabled. * @property {rocConfig} configObject - The final configuration object where everything has been merged. * @property {rocMetaConfig} metaObject - The final meta configuration object where everything has been merged. * @property {rocConfig} extensionConfig - The configuration object where all extensions has been merged. * @property {rocOptions} parsedOptions - The parsed options given to the cli. */ /** * Roc config object. * * @typedef {Object} rocConfig * @property {rocSettings} settings * @property {Object} commands * @property {Object} plugins * @property {string[]} extensions */ /** * Roc meta config object. * * @typedef {Object} rocMetaConfig * @property {rocMetaSettings} settings * @property {Object} commands * @property {Object} plugins */ /** * Roc parsed options. * * @typedef {Object} rocOptions * @property {Object} options * @property {Object} rest */ /** * Roc map object. * * @typedef {Object} rocMapObject * @property {string} name * @property {string} path * @property {function} convertor * @property {function} validator */ /** * Roc documentation object. * * @typedef {Object[]} rocDocumentationObject */ /** * Roc table header object. * * @typedef {Object} rocTableHeader */ /** * Roc table settings object. * * See default configuration below: * ``` * { * groupTitleWrapper: (name) => name, * cellDivider: '|', * rowWrapper: (input) => `|${input}|`, * cellWrapper: (input) => ` ${input} `, * header: true, * compact: false * } * ``` * * @typedef {Object} rocTableSettings */ /** * Roc settings object. * * @typedef {Object} rocSettings */ /** * Roc meta settings object. * * @typedef {Object} rocMetaSettings */ /** * Roc meta settings object. * * @typedef {Object} rocMetaSettings * @property {Object} descriptions * @property {Object} groups * @property {Object} validations */ </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>