mongoose-data-seed

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl" href="../../../../"> <title data-ice="title">src/lib/utils/helpers.js | mongoose-data-seed</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> <meta name="description" content="Seed mongodb with data using mongoose models"><meta property="twitter:card" content="summary"><meta property="twitter:title" content="mongoose-data-seed"><meta property="twitter:description" content="Seed mongodb with data using mongoose models"></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 href="test.html" data-ice="testLink">Test</a> <div class="search-box"> <img src="./image/search.png"> <input class="search-input"> <ul class="search-result"></ul> </div> <a style="position:relative; top:3px;" href="https://github.com/sharvit/mongoose-data-seed"><img width="20px" src="./image/github.png"></a></header> <nav class="navigation" data-ice="nav"><div> <ul> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#lib">lib</a>V<a href="variable/index.html#static-variable-config">config</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-configFilename">configFilename</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-defaultUserGeneratorConfig">defaultUserGeneratorConfig</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-systemConfigTemplate">systemConfigTemplate</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-systemSeederTemplate">systemSeederTemplate</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#lib-commands">lib/commands</a>F<a href="function/index.html#static-function-aliasToCommand">aliasToCommand</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-commandToFunction">commandToFunction</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getCommandAndArgvFromCli">getCommandAndArgvFromCli</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-isAlias">isAlias</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-runCommand">runCommand</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-aliases">aliases</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-availableCommandsList">availableCommandsList</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-commands">commands</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-commandsMap">commandsMap</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-defaultCommand">defaultCommand</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#lib-commands-generate">lib/commands/generate</a>F<a href="function/index.html#static-function-generateSeeder">generateSeeder</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-help">help</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-index">index</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getOptions">getOptions</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-validateOptions">validateOptions</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-optionDefinitions">optionDefinitions</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#lib-commands-help">lib/commands/help</a>F<a href="function/index.html#static-function-help">help</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-usageGuide">usageGuide</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#lib-commands-init">lib/commands/init</a>C<a href="class/src/lib/commands/init/installer-logger.js~InstallerLogger.html">InstallerLogger</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-help">help</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-index">index</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getOptions">getOptions</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-promptMissingOptions">promptMissingOptions</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-runinstaller">runinstaller</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-optionDefinitions">optionDefinitions</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#lib-commands-run">lib/commands/run</a>C<a href="class/src/lib/commands/run/run-logger.js~RunLogger.html">RunLogger</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-help">help</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-index">index</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getOptions">getOptions</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-run">run</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-optionDefinitions">optionDefinitions</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-usageGuide">usageGuide</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#lib-core">lib/core</a>C<a href="class/src/lib/core/installer-error.js~InstallerError.html">InstallerError</a></li> <li data-ice="doc">C<a href="class/src/lib/core/installer.js~Installer.html">Installer</a></li> <li data-ice="doc">C<a href="class/src/lib/core/md-seed-runner-error.js~MdSeedRunnerError.html">MdSeedRunnerError</a></li> <li data-ice="doc">C<a href="class/src/lib/core/md-seed-runner.js~MdSeedRunner.html">MdSeedRunner</a></li> <li data-ice="doc">C<a href="class/src/lib/core/seeder-generator.js~SeederGenerator.html">SeederGenerator</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-InstallerConfig">InstallerConfig</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#lib-utils">lib/utils</a>C<a href="class/src/lib/utils/base-logger.js~BaseLogger.html">BaseLogger</a></li> <li data-ice="doc">C<a href="class/src/lib/utils/seeder.js~Seeder.html">Seeder</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-exit">exit</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getFolderNameFromPath">getFolderNameFromPath</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getObjectWithSelectedKeys">getObjectWithSelectedKeys</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-normalizeSeederFileName">normalizeSeederFileName</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-normalizeSeederName">normalizeSeederName</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-validateSeederTemplatePath">validateSeederTemplatePath</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-validateSeedersFolderName">validateSeedersFolderName</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-validateUserConfig">validateUserConfig</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-ExitCodes">ExitCodes</a></li> </ul> </div> </nav> <div class="content" data-ice="content"><h1 data-ice="title">src/lib/utils/helpers.js</h1> <pre class="source-code line-number raw-source-code"><code class="prettyprint linenums" data-ice="content">import { trim, upperFirst, camelCase, kebabCase } from 'lodash'; import config from '../config'; import { ExitCodes } from './constants'; /** * Normalize seeder name. * @param {string} name seeder name * @return {string} normalized seeder name */ export const normalizeSeederName = name => upperFirst(camelCase(name)); /** * Normalize seeder filename. * @param {string} name seeder name * @return {string} normalized seeder filename */ export const normalizeSeederFileName = name => `${kebabCase(name)}.seeder.js`; /** * Get folder name from given path. * @param {string} path path * @return {string} folder name */ export const getFolderNameFromPath = path => path.substring(path.lastIndexOf('/') + 1); /** * Get object with selected keys from a given object. * @param {Object} obj Object * @param {string[]} keys Keys to get from the given object. * @return {Object} new object with the selected keys. */ export const getObjectWithSelectedKeys = (obj, keys) => { const newObj = {}; Object.keys(obj).forEach(k => { if (keys.includes(k)) { newObj[k] = obj[k]; } }); return newObj; }; /** * Validate seeders folder name. * @param {string} name folder name * @return {boolean} */ export const validateSeedersFolderName = name => typeof name === 'string' && trim(name).length >= 3; /** * Validate seeder template path. * @param {string} name path * @return {boolean} */ export const validateSeederTemplatePath = name => typeof name === 'string' && trim(name).length >= 6; /** * Validate user config. * @throws {Error} throw error when user config is not valid. */ export const validateUserConfig = () => { const { userConfigExists } = config; if (!userConfigExists) { throw new Error( 'Must contain md-seed-config.js at the project root. run `md-seed init` to create the config file.' ); } }; /** * Exit mongoose-data-seed. * @param {Error} [error] Exit with error when supplied. */ export const exit = error => { if (error && error.message && error.message !== 'exit') { console.error(error); process.exit(ExitCodes.Error); } else { process.exit(ExitCodes.Success); } }; </code></pre> </div> <footer class="footer"> Generated by <a href="https://esdoc.org">ESDoc(1.1.0)<img src="./image/esdoc-logo-mini-black.png"></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>