flavor-js

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Home - Documentation</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script>  <link type="text/css" rel="stylesheet" href="styles/prettify.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc.css"> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger" /> <label for="nav-trigger" class="navicon-button x"> <div class="navicon"></div> </label> <label for="nav-trigger" class="overlay"></label> <nav> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FlavorJS.html">FlavorJS</a><ul class='methods'><li data-type='method'><a href="FlavorJS.html#delay">delay</a></li><li data-type='method'><a href="FlavorJS.html#extendArray">extendArray</a></li><li data-type='method'><a href="FlavorJS.html#extendBoolean">extendBoolean</a></li><li data-type='method'><a href="FlavorJS.html#extendDate">extendDate</a></li><li data-type='method'><a href="FlavorJS.html#extendFunction">extendFunction</a></li><li data-type='method'><a href="FlavorJS.html#extendLodash">extendLodash</a></li><li data-type='method'><a href="FlavorJS.html#extendNumber">extendNumber</a></li><li data-type='method'><a href="FlavorJS.html#extendObject">extendObject</a></li><li data-type='method'><a href="FlavorJS.html#extendPrototype">extendPrototype</a></li><li data-type='method'><a href="FlavorJS.html#extendPrototypeProperty">extendPrototypeProperty</a></li><li data-type='method'><a href="FlavorJS.html#extendString">extendString</a></li><li data-type='method'><a href="FlavorJS.html#init">init</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="array.html">array</a><ul class='methods'><li data-type='method'><a href="array.html#clone">clone</a></li><li data-type='method'><a href="array.html#concat">concat</a></li><li data-type='method'><a href="array.html#contains">contains</a></li><li data-type='method'><a href="array.html#containsBy">containsBy</a></li><li data-type='method'><a href="array.html#countBy">countBy</a></li><li data-type='method'><a href="array.html#cut">cut</a></li><li data-type='method'><a href="array.html#deepFindBy">deepFindBy</a></li><li data-type='method'><a href="array.html#deepMap">deepMap</a></li><li data-type='method'><a href="array.html#deepSortBy">deepSortBy</a></li><li data-type='method'><a href="array.html#diff">diff</a></li><li data-type='method'><a href="array.html#diffBy">diffBy</a></li><li data-type='method'><a href="array.html#distinct">distinct</a></li><li data-type='method'><a href="array.html#each">each</a></li><li data-type='method'><a href="array.html#filterBy">filterBy</a></li><li data-type='method'><a href="array.html#findBy">findBy</a></li><li data-type='method'><a href="array.html#first">first</a></li><li data-type='method'><a href="array.html#flatten">flatten</a></li><li data-type='method'><a href="array.html#indexBy">indexBy</a></li><li data-type='method'><a href="array.html#intersection">intersection</a></li><li data-type='method'><a href="array.html#isArray">isArray</a></li><li data-type='method'><a href="array.html#last">last</a></li><li data-type='method'><a href="array.html#lorem">lorem</a></li><li data-type='method'><a href="array.html#maxBy">maxBy</a></li><li data-type='method'><a href="array.html#pull">pull</a></li><li data-type='method'><a href="array.html#pullBy">pullBy</a></li><li data-type='method'><a href="array.html#random">random</a></li><li data-type='method'><a href="array.html#removeBy">removeBy</a></li><li data-type='method'><a href="array.html#shuffle">shuffle</a></li><li data-type='method'><a href="array.html#sortBy">sortBy</a></li><li data-type='method'><a href="array.html#split">split</a></li><li data-type='method'><a href="array.html#sum">sum</a></li><li data-type='method'><a href="array.html#tail">tail</a></li><li data-type='method'><a href="array.html#tail">tail</a></li><li data-type='method'><a href="array.html#union">union</a></li></ul></li><li><a href="boolean.html">boolean</a><ul class='methods'><li data-type='method'><a href="boolean.html#isBoolean">isBoolean</a></li><li data-type='method'><a href="boolean.html#random">random</a></li></ul></li><li><a href="date.html">date</a><ul class='methods'><li data-type='method'><a href="date.html#isDate">isDate</a></li><li data-type='method'><a href="date.html#random">random</a></li><li data-type='method'><a href="date.html#toTimestamp">toTimestamp</a></li></ul></li><li><a href="function.html">function</a><ul class='methods'><li data-type='method'><a href="function.html#isFunction">isFunction</a></li><li data-type='method'><a href="function.html#proxy">proxy</a></li></ul></li><li><a href="lodash.html">lodash</a><ul class='methods'><li data-type='method'><a href="lodash.html#deepFindBy">deepFindBy</a></li><li data-type='method'><a href="lodash.html#deepMap">deepMap</a></li><li data-type='method'><a href="lodash.html#deepOrderBy">deepOrderBy</a></li><li data-type='method'><a href="lodash.html#filterByValues">filterByValues</a></li><li data-type='method'><a href="lodash.html#isPercentage">isPercentage</a></li><li data-type='method'><a href="lodash.html#parsePercentage">parsePercentage</a></li><li data-type='method'><a href="lodash.html#pullAllByComparator">pullAllByComparator</a></li><li data-type='method'><a href="lodash.html#timesRange">timesRange</a></li><li data-type='method'><a href="lodash.html#timesReverse">timesReverse</a></li></ul></li><li><a href="number.html">number</a><ul class='methods'><li data-type='method'><a href="number.html#between">between</a></li><li data-type='method'><a href="number.html#degreeDiff">degreeDiff</a></li><li data-type='method'><a href="number.html#degreeDir">degreeDir</a></li><li data-type='method'><a href="number.html#degreeWrap">degreeWrap</a></li><li data-type='method'><a href="number.html#floor">floor</a></li><li data-type='method'><a href="number.html#fromRoman">fromRoman</a></li><li data-type='method'><a href="number.html#isNumber">isNumber</a></li><li data-type='method'><a href="number.html#parse">parse</a></li><li data-type='method'><a href="number.html#random">random</a></li><li data-type='method'><a href="number.html#range">range</a></li><li data-type='method'><a href="number.html#round">round</a></li><li data-type='method'><a href="number.html#round">round</a></li><li data-type='method'><a href="number.html#times">times</a></li><li data-type='method'><a href="number.html#toAbsolute">toAbsolute</a></li><li data-type='method'><a href="number.html#toCurrency">toCurrency</a></li><li data-type='method'><a href="number.html#toFileSize">toFileSize</a></li><li data-type='method'><a href="number.html#toRoman">toRoman</a></li><li data-type='method'><a href="number.html#toSymbolString">toSymbolString</a></li></ul></li><li><a href="object.html">object</a><ul class='methods'><li data-type='method'><a href="object.html#clone">clone</a></li><li data-type='method'><a href="object.html#each">each</a></li><li data-type='method'><a href="object.html#inherit">inherit</a></li><li data-type='method'><a href="object.html#isObject">isObject</a></li><li data-type='method'><a href="object.html#omit">omit</a></li><li data-type='method'><a href="object.html#path">path</a></li><li data-type='method'><a href="object.html#pick">pick</a></li></ul></li><li><a href="string.html">string</a><ul class='methods'><li data-type='method'><a href="string.html#camelCase">camelCase</a></li><li data-type='method'><a href="string.html#capitalize">capitalize</a></li><li data-type='method'><a href="string.html#contains">contains</a></li><li data-type='method'><a href="string.html#decodeURI">decodeURI</a></li><li data-type='method'><a href="string.html#encodeURI">encodeURI</a></li><li data-type='method'><a href="string.html#endsWith">endsWith</a></li><li data-type='method'><a href="string.html#escapeHTML">escapeHTML</a></li><li data-type='method'><a href="string.html#escapeHTML">escapeHTML</a></li><li data-type='method'><a href="string.html#extractDomain">extractDomain</a></li><li data-type='method'><a href="string.html#extractFileExtension">extractFileExtension</a></li><li data-type='method'><a href="string.html#extractQueryString">extractQueryString</a></li><li data-type='method'><a href="string.html#guid">guid</a></li><li data-type='method'><a href="string.html#isRoman">isRoman</a></li><li data-type='method'><a href="string.html#isString">isString</a></li><li data-type='method'><a href="string.html#isUrl">isUrl</a></li><li data-type='method'><a href="string.html#pad">pad</a></li><li data-type='method'><a href="string.html#padLeft">padLeft</a></li><li data-type='method'><a href="string.html#padRight">padRight</a></li><li data-type='method'><a href="string.html#parsePercentage">parsePercentage</a></li><li data-type='method'><a href="string.html#parsePercentage">parsePercentage</a></li><li data-type='method'><a href="string.html#replaceAll">replaceAll</a></li><li data-type='method'><a href="string.html#slugify">slugify</a></li><li data-type='method'><a href="string.html#startsWith">startsWith</a></li><li data-type='method'><a href="string.html#stripTags">stripTags</a></li><li data-type='method'><a href="string.html#toArray">toArray</a></li><li data-type='method'><a href="string.html#toInt">toInt</a></li></ul></li></ul><h3><a href="global.html">Global</a></h3> </nav> <div id="main"> <section class="readme"> <article><h1>flavor-js</h1> <h2>Author</h2> <p>Black Mirror</p> <h2>Version</h2> <p>v0.4.11</p> <h2>Badges</h2> <p><a href="https://nodei.co/npm/flavor-js/"><img src="https://nodei.co/npm/flavor-js.png" alt="NPM"></a></p> <p><a href="https://github.com/blackmirror1980/flavor-js/stargazers"><img src="https://img.shields.io/github/stars/blackmirror1980/flavor-js.svg?style=plastic" alt="GitHub stars"></a> <a href="https://github.com/blackmirror1980/flavor-js/network"><img src="https://img.shields.io/github/forks/blackmirror1980/flavor-js.svg?style=plastic" alt="GitHub forks"></a> <a href="https://github.com/blackmirror1980/flavor-js/issues"><img src="https://img.shields.io/github/issues/blackmirror1980/flavor-js.svg?style=plastic" alt="GitHub issues"></a> <a href="https://github.com/blackmirror1980/flavor-js/blob/master/LICENSE"><img src="https://img.shields.io/github/license/blackmirror1980/flavor-js.svg?style=plastic" alt="GitHub license"></a> <a href="https://travis-ci.org/blackmirror1980/flavor-js"><img src="https://travis-ci.org/blackmirror1980/flavor-js.svg?branch=master" alt="Build Status"></a> <a href="https://coveralls.io/github/blackmirror1980/flavor-js?branch=master"><img src="https://coveralls.io/repos/github/blackmirror1980/flavor-js/badge.svg?branch=master" alt="Coverage Status"></a></p> <h2>Documentation</h2> <p>Check out the <a href="https://blackmirror1980.github.io/flavor-js/docs/index.html">Latest Documentation</a> here</p> <h2>Description</h2> <p>FlavorJS the definitive JS natives chainable extensions methods (based on lodash & ES6)</p> <h2>Example</h2> <p>Check out this <a href="">Codepen</a> example</p> <h2>Installation</h2> <p>This is a <a href="https://nodejs.org/">Node.js</a> module available through the <a href="https://www.npmjs.com/">npm registry</a>. It can be installed using the <a href="https://docs.npmjs.com/getting-started/installing-npm-packages-locally"><code>npm</code></a> or <a href="https://yarnpkg.com/en/"><code>yarn</code></a> command line tools.</p> <pre class="prettyprint source lang-sh"><code>npm install flavor-js --save </code></pre> <h2>Dependencies</h2> <ul> <li><a href="https://ghub.io/js-yaml">js-yaml</a>: YAML 1.2 parser and serializer</li> <li><a href="https://ghub.io/lodash">lodash</a>: Lodash modular utilities.</li> <li><a href="https://ghub.io/marked">marked</a>: A markdown parser built for speed</li> </ul> <h2>Dev Dependencies</h2> <ul> <li><a href="https://ghub.io/babel-core">babel-core</a>: Babel compiler core.</li> <li><a href="https://ghub.io/babel-eslint">babel-eslint</a>: Custom parser for ESLint</li> <li><a href="https://ghub.io/babel-loader">babel-loader</a>: babel module loader for webpack</li> <li><a href="https://ghub.io/babel-preset-env">babel-preset-env</a>: A Babel preset for each environment.</li> <li><a href="https://ghub.io/clean-webpack-plugin">clean-webpack-plugin</a>: A webpack plugin to remove your build folder(s) before building</li> <li><a href="https://ghub.io/docdash">docdash</a>: A clean, responsive documentation template theme for JSDoc 3 inspired by lodash and minami</li> <li><a href="https://ghub.io/eslint">eslint</a>: An AST-based pattern checker for JavaScript.</li> <li><a href="https://ghub.io/eslint-config-airbnb">eslint-config-airbnb</a>: Airbnb's ESLint config, following our styleguide</li> <li><a href="https://ghub.io/eslint-loader">eslint-loader</a>: eslint loader (for webpack)</li> <li><a href="https://ghub.io/eslint-plugin-import">eslint-plugin-import</a>: Import with sanity.</li> <li><a href="https://ghub.io/eslint-plugin-jsx-a11y">eslint-plugin-jsx-a11y</a>: Static AST checker for accessibility rules on JSX elements.</li> <li><a href="https://ghub.io/eslint-plugin-react">eslint-plugin-react</a>: React specific linting rules for ESLint</li> <li><a href="https://ghub.io/hoek">hoek</a>: General purpose node utilities</li> <li><a href="https://ghub.io/ink-docstrap">ink-docstrap</a>: <a href="https://nodei.co/npm/ink-docstrap/"><img src="https://nodei.co/npm/ink-docstrap.png?downloads=true" alt="NPM"></a></li> <li><a href="https://ghub.io/jsdoc">jsdoc</a>: An API documentation generator for JavaScript.</li> <li><a href="https://ghub.io/lodash-webpack-plugin">lodash-webpack-plugin</a>: Smaller modular Lodash builds.</li> <li><a href="https://ghub.io/ssri">ssri</a>: Standard Subresource Integrity library -- parses, serializes, generates, and verifies integrity metadata according to the SRI spec.</li> <li><a href="https://ghub.io/uglifyjs-webpack-plugin">uglifyjs-webpack-plugin</a>: UglifyJS plugin for webpack</li> <li><a href="https://ghub.io/webpack">webpack</a>: Packs CommonJs/AMD modules for the browser. Allows to split your codebase into multiple bundles, which can be loaded on demand. Support loaders to preprocess files, i.e. json, jsx, es7, css, less, ... and your custom stuff.</li> <li><a href="https://ghub.io/webpack-cli">webpack-cli</a>: CLI for webpack & friends</li> <li><a href="https://ghub.io/webpack-ver-plugin">webpack-ver-plugin</a>: Generates a file with your app's package.json information and build date</li> </ul> <h2>Tests</h2> <pre class="prettyprint source lang-sh"><code>npm install npm test </code></pre> <h2>License</h2> <p>MIT</p> <h2>Powered By</h2> <a href="http://js.org" target="_blank" title="JS.ORG | JavaScript Community"> <img src="http://logo.js.org/dark_horz.png" width="102" alt="JS.ORG Logo"/></a> </article> </section> </div> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> on Fri Jun 14 2019 15:20:48 GMT+0200 (CEST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme. </footer> <script>prettyPrint();</script> <script src="scripts/linenumber.js"></script> </body> </html>