115 |117 |Functions to recursively walk collections which are trees.
116 |
Documentation should use Journo formats and standards.
118 | 119 | _.walk = walk;
122 | postorder: function(obj, visitor, context)
123 | preorder: function(obj, visitor, context)
124 | walk(obj, visitor, null, context)
125 | map: function(obj, strategy, visitor, context)
126 | pluck: function(obj, propertyName)
127 | pluckRec: function(obj, propertyName)
128 | _.walk.collect = _.walk.map;
129 |
130 |
131 | 115 |117 |Functions for working with strings.
116 |
Signature: _.camelCase(string:String)
Converts a dash-separated string to camel case. Opposite of toDash.
121 |_.camelCase("ancient-greece");
122 | // => "ancientGreece"
123 | Signature: _.explode(s:String)
Explodes a string into an array of characters. Opposite of implode.
128 |_.explode("Plato");
129 | // => ["P", "l", "a", "t", "o"]
130 | Signature: _.fromQuery(str:String)
Takes a URL query string and converts it into an equivalent JavaScript object. 135 | Opposite of toQuery
136 |_.fromQuery("forms%5Bperfect%5D=circle&forms%5Bimperfect%5D=square");
137 | // => { forms: { perfect: "circle", imperfect: "square" } }
138 | Signature: _.implode(a:Array)
Implodes an array of strings into a single string. Opposite of explode.
143 |_.implode(["H", "o", "m", "e", "r"]);
144 | // => "Homer"
145 | Signature: _.slugify(str:String)
Slugifies a string, converting spaces and dots to dashes and inserting dashes between words.
150 |_.slugify("ExampleString.that-covers-it.all");
151 | // => "example-string-that-covers-it-all"
152 | Signature: _.strContains(str:String, search:String)
Reports whether a string contains a search string.
157 |_.strContains("Acropolis", "polis");
158 | // => true
159 | Signature: _.toDash(string:String)
Converts a camel case string to a dashed string. Opposite of camelCase.
164 |_.toDash("thisIsSparta");
165 | // => "this-is-sparta"
166 | Signature: _.toQuery(obj:Object)
Takes an object and converts it into an equivalent URL query string. Opposite 171 | of fromQuery.
172 |_.toQuery({ forms: { perfect: "circle", imperfect: "square" } });
173 | // => "forms%5Bperfect%5D=circle&forms%5Bimperfect%5D=square"
174 | 115 |117 |Trampoline functions.
116 |
Signature: _.trampoline(fun:Function[, args:Any...])
Provides a way of creating recursive functions that won’t exceed a JavaScript
150 | engine’s maximum recursion depth. Rather than writing a naive recursive
151 | function, the function’s base cases must return _.done(someValue), and
152 | recursive calls must be wrapped in a returned function.
In order to create a trampolined function that can be used in the same way as
154 | a naive recursive function, use _.partial as illustrated below.
function isEvenNaive (num) {
156 | if (num === 0) return true;
157 | if (num === 1) return false;
158 | return isEvenNaive(num - 2);
159 | }
160 |
161 | isEvenNaive(99999);
162 | // => InternalError: too much recursion
163 |
164 | function isEvenInner (num) {
165 | if (num === 0) return _.done(true);
166 | if (num === 1) return _.done(false);
167 | return function () { return isEvenInner(Math.abs(num) - 2); };
168 | }
169 |
170 | _.trampoline(isEvenInner, 99999);
171 | // => false
172 |
173 | var isEven = _.partial(_.trampoline, isEvenInner);
174 |
175 | isEven(99999);
176 | // => false
177 | 109 |111 |The brass buckles on lodash’s utility belt - a contributors’ library for lodash.
110 |
While lodash provides a bevy of useful tools to support functional programming in JavaScript, it can’t 120 | (and shouldn’t) be everything to everyone. lodash-contrib is intended as a home for functions that, for 121 | various reasons, don’t belong in lodash proper. In particular, it aims to be:
122 |First, you’ll need lodash. Then you can grab the relevant lodash-contrib libraries and simply add 130 | the following to your pages:
131 |<script type="text/javascript" src="lodash.js"></script>
132 | <script type="text/javascript" src="lodash.object.builders.js"></script>
133 | At the moment there are no cross-contrib dependencies (i.e. each sub-library 135 | can stand by itself), but that may change in the future.
136 |lodash-contrib is open sourced under the MIT license.
138 |The lodash-contrib library currently contains a number of related capabilities, aggregated into the following files.
140 |true or false based on some criteriaThe links above are to the annotated source code. Full-blown _.contrib documentation is in the works. Contributors welcomed.
156 | 157 |