docs/index.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Home</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Home</h1>
<h3> </h3>
<section>
<article><p><a href="https://travis-ci.org/on3iro/functionstein"><img src="https://travis-ci.org/on3iro/functionstein.svg?branch=master" alt="Build Status"></a>
<a href="https://coveralls.io/github/on3iro/functionstein?branch=master"><img src="https://coveralls.io/repos/github/on3iro/functionstein/badge.svg?branch=master" alt="Coverage Status"></a>
<a href="https://codeclimate.com/github/on3iro/functionstein/maintainability"><img src="https://api.codeclimate.com/v1/badges/704d27c79031519e33cb/maintainability" alt="Maintainability"></a>
<a href="https://badge.fury.io/js/functionstein"><img src="https://badge.fury.io/js/functionstein.svg" alt="npm version"></a></p>
<p><a href="https://github.com/standard/standard"><img src="https://cdn.rawgit.com/standard/standard/master/badge.svg" alt="JavaScript Style Guide"></a></p>
<!-- vim-markdown-toc GFM -->
<ul>
<li><a href="#functionstein">functionstein</a><ul>
<li><a href="#installation">Installation</a></li>
<li><a href="#usage">Usage</a></li>
<li><a href="#api">API</a></li>
<li><a href="#faq">FAQ</a><ul>
<li><a href="#what-is-functionstein">What is functionstein?</a></li>
<li><a href="#should-i-use-this">Should I use this?</a></li>
<li><a href="#isnt-there-anything-better-that-we-could-do-with-this-name">Isn't there anything better that we could do with this name?</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<!-- vim-markdown-toc -->
<h1>functionstein</h1><p>Small toolbelt of functions (personal alternative for lodash/ramda inside small projects)</p>
<h2>Installation</h2><p><code>npm i --save functionstein</code></p>
<h2>Usage</h2><p>Simply import the functions you need like this:</p>
<pre class="prettyprint source lang-js"><code>import { first } from 'functionstein'</code></pre><h2>API</h2><p><a href="https://on3iro.github.io/functionstein">API</a></p>
<p><a href="https://github.com/on3iro/functionstein">GitHub</a></p>
<h2>FAQ</h2><h3>What is functionstein?</h3><p>Functionstein is a collection of functions tailored to my needs. I use it
inside quite a few projects, where I need some helper functions, but don't want
to add the footprint of <em>lodash</em> or similar libraries.</p>
<h3>Should I use this?</h3><p><strong>Short Answer:</strong> Probably not!</p>
<p><strong>Long Answer:</strong> You technically could, but it is pretty likely that <em>functionstein</em>
wont fit your needs and you are better off with another library like <a href="https://lodash.com/">Lodash</a>
or <a href="http://ramdajs.com/">Ramda</a>. <strong>functionsteins</strong> collection of functions might seem rather random at
times and I don't give any guarantees about the implementation of each function.</p>
<p>However if you are working on a small project and <em>functionstein</em> fits you can use it ofcourse.
For anything that goes to production I would recommend one of the aforementioned libraries or
to create a personal fork of <em>functionstein</em>.</p>
<h3>Isn't there anything better that we could do with this name?</h3><p>Absolutely. I really liked the name when it came to my mind and it still seems to fit
the purpose of this library. Nothing is set in stone, though. If you have a great library idea that would fit the name
better and would be more useful to others I would definitely be open to switch the purpose of the lib.
Just hit me up and open an issue where we could discuss this.</p></article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#compactArray">compactArray</a></li><li><a href="global.html#debounce">debounce</a></li><li><a href="global.html#first">first</a></li><li><a href="global.html#generateMarkup">generateMarkup</a></li><li><a href="global.html#immutablyDeleteProperty">immutablyDeleteProperty</a></li><li><a href="global.html#insertInArrIf">insertInArrIf</a></li><li><a href="global.html#insertInObjIf">insertInObjIf</a></li><li><a href="global.html#last">last</a></li><li><a href="global.html#objArrayToKeyedObj">objArrayToKeyedObj</a></li><li><a href="global.html#objToArray">objToArray</a></li><li><a href="global.html#partial">partial</a></li><li><a href="global.html#pipe">pipe</a></li><li><a href="global.html#range">range</a></li><li><a href="global.html#sortByProperty">sortByProperty</a></li><li><a href="global.html#throttle">throttle</a></li><li><a href="global.html#toggleClass">toggleClass</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 10 2018 15:04:34 GMT+0100 (CET)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>