lodash-contrib
Version:
The brass buckles on lodash's utility belt
165 lines (125 loc) • 7.93 kB
HTML
<html>
<head>
<title>lodash-contrib</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<link rel="stylesheet" media="all" href="docco.css" />
</head>
<body>
<div id="container">
<div id="background"></div>
<ul id="jump_to">
<li>
<a class="large" href="javascript:void(0);">Jump To …</a>
<a class="small" href="javascript:void(0);">+</a>
<div id="jump_wrapper">
<div id="jump_page_wrapper">
<div id="jump_page">
<a class="source" href="_.array.builders.js.html">
_.array.builders.js.md
</a>
<a class="source" href="_.array.selectors.js.html">
_.array.selectors.js.md
</a>
<a class="source" href="_.collections.walk.js.html">
_.collections.walk.js.md
</a>
<a class="source" href="_.function.arity.js.html">
_.function.arity.js.md
</a>
<a class="source" href="_.function.combinators.js.html">
_.function.combinators.js.md
</a>
<a class="source" href="_.function.iterators.js.html">
_.function.iterators.js.md
</a>
<a class="source" href="_.function.predicates.js.html">
_.function.predicates.js.md
</a>
<a class="source" href="_.object.builders.js.html">
_.object.builders.js.md
</a>
<a class="source" href="_.object.selectors.js.html">
_.object.selectors.js.md
</a>
<a class="source" href="_.util.existential.js.html">
_.util.existential.js.md
</a>
<a class="source" href="_.util.operators.js.html">
_.util.operators.js.md
</a>
<a class="source" href="_.util.strings.js.html">
_.util.strings.js.md
</a>
<a class="source" href="_.util.trampolines.js.html">
_.util.trampolines.js.md
</a>
<a class="source" href="index.html">
index.md
</a>
</div>
</div>
</li>
</ul>
<ul class="sections">
<li id="section-1">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-1">¶</a>
</div>
<h1 id="lodash-contrib">lodash-contrib</h1>
<blockquote>
<p>The brass buckles on lodash’s utility belt - a contributors’ library for <a href="http://lodash.com/">lodash</a>.</p>
</blockquote>
<h2 id="introduction">Introduction</h2>
<h3 id="places">Places</h3>
<ul>
<li><a href="#sub-libraries">Documentation</a></li>
<li><a href="https://github.com/empeeric/lodash-contrib">Source repository</a></li>
<li><a href="https://github.com/empeeric/lodash-contrib/issues?state=open">Tickets and bug reports</a></li>
</ul>
<h3 id="why-lodash-contrib-">Why lodash-contrib?</h3>
<p>While lodash provides a bevy of useful tools to support functional programming in JavaScript, it can’t
(and shouldn’t) be everything to everyone. lodash-contrib is intended as a home for functions that, for
various reasons, don’t belong in lodash proper. In particular, it aims to be:</p>
<ul>
<li>a home for functions that are limited in scope, but solve certain point problems, and</li>
<li>a proving ground for features that belong in lodash proper, but need some advocacy and/or evolution
(or devolution) to get them there.</li>
</ul>
<h3 id="use">Use</h3>
<h4 id="in-the-browser">In the Browser</h4>
<p>First, you’ll need lodash. Then you can grab the relevant lodash-contrib libraries and simply add
the following to your pages:</p>
<pre><code class="lang-html"><span class="hljs-tag"><<span class="hljs-title">script</span> <span class="hljs-attribute">type</span>=<span class="hljs-value">"text/javascript"</span> <span class="hljs-attribute">src</span>=<span class="hljs-value">"lodash.js"</span>></span><span class="undefined"></span><span class="hljs-tag"></<span class="hljs-title">script</span>></span>
<span class="hljs-tag"><<span class="hljs-title">script</span> <span class="hljs-attribute">type</span>=<span class="hljs-value">"text/javascript"</span> <span class="hljs-attribute">src</span>=<span class="hljs-value">"lodash.object.builders.js"</span>></span><span class="undefined"></span><span class="hljs-tag"></<span class="hljs-title">script</span>></span>
</code></pre>
<p>At the moment there are no cross-contrib dependencies (i.e. each sub-library
can stand by itself), but that may change in the future.</p>
<h3 id="license">License</h3>
<p>lodash-contrib is open sourced under the <a href="https://github.com/Empeeric/lodash-contrib/blob/master/LICENSE">MIT license</a>.</p>
<h2 id="sub-libraries">Sub-libraries</h2>
<p>The lodash-contrib library currently contains a number of related capabilities, aggregated into the following files.</p>
<ul>
<li><a href="_.array.builders.js.md#arraybuilders">_.array.builders</a> - functions to build arrays</li>
<li><a href="_.array.selectors.js.md#arrayselectors">_.array.selectors</a> - functions to take things from arrays</li>
<li><a href="_.collections.walk.js.md#collectionswalk">_.collections.walk</a> - functions to walk and transform nested JavaScript objects</li>
<li><a href="_.function.arity.js.md#functionarity">_.function.arity</a> - functions to manipulate and fix function argument arity</li>
<li><a href="_.function.combinators.js.md#functioncombinators">_.function.combinators</a> - functions to combine functions to make new functions</li>
<li><a href="_.function.iterators.js.md#functioniterators">_.function.iterators</a> - functions to lazily produce, manipulate and consume sequence iterators</li>
<li><a href="_.function.predicates.js.md#functionpredicates">_.function.predicates</a> - functions that return <code>true</code> or <code>false</code> based on some criteria</li>
<li><a href="_.object.builders.js.md#objectbuilders">_.object.builders</a> - functions to build JavaScript objects</li>
<li><a href="_.object.selectors.js.md#objectselectors">_.object.selectors</a> - functions to pick things from JavaScript objects</li>
<li><a href="_.util.existential.js.md#utilexistential">_.util.existential</a> - functions that check for the existence or truthiness of JavaScript data types</li>
<li><a href="_.util.operators.js.md#utiloperators">_.util.operators</a> - functions that wrap common (or missing) JavaScript operators</li>
<li><a href="_.util.strings.js.md#utilstrings">_.util.strings</a> - functions to work with strings</li>
<li><a href="_.util.trampolines.js.md#utiltrampolines">_.util.trampolines</a> - functions to facilitate calling functions recursively without blowing the stack</li>
</ul>
<p>The links above are to the annotated source code. Full-blown _.contrib documentation is in the works. Contributors welcomed.</p>
</div>
</li>
</ul>
</div>
</body>
</html>