/node_modules/grunt/node_modules/findup-sync/node_modules/lodash/README.md
Markdown | 276 lines | 207 code | 69 blank | 0 comment | 0 complexity | 2d2608d069773e4e3487463f26f8f78b MD5 | raw file
Possible License(s): MIT, JSON, BSD-2-Clause, Unlicense, GPL-2.0, WTFPL, LGPL-3.0, Apache-2.0, 0BSD, BSD-3-Clause, CC-BY-SA-3.0
- # Lo-Dash <sup>v1.0.1</sup>
- [![build status](https://secure.travis-ci.org/bestiejs/lodash.png)](http://travis-ci.org/bestiejs/lodash)
- An alternative to Underscore.js, delivering consistency, [customization](https://github.com/bestiejs/lodash#custom-builds), [performance](http://lodash.com/benchmarks), and [extra features](https://github.com/bestiejs/lodash#features).
- ## Download
- * Lo-Dash builds (for modern environments):<br>
- [Development](https://raw.github.com/bestiejs/lodash/v1.0.1/dist/lodash.js) and
- [Production](https://raw.github.com/bestiejs/lodash/v1.0.1/dist/lodash.min.js)
- * Lo-Dash compatibility builds (for legacy and modern environments):<br>
- [Development](https://raw.github.com/bestiejs/lodash/v1.0.1/dist/lodash.compat.js) and
- [Production](https://raw.github.com/bestiejs/lodash/v1.0.1/dist/lodash.compat.min.js)
- * Underscore compatibility builds:<br>
- [Development](https://raw.github.com/bestiejs/lodash/v1.0.1/dist/lodash.underscore.js) and
- [Production](https://raw.github.com/bestiejs/lodash/v1.0.1/dist/lodash.underscore.min.js)
- * CDN copies of ≤ v1.0.1’s builds are available on [cdnjs](http://cdnjs.com/) thanks to [CloudFlare](http://www.cloudflare.com/):<br>
- [Lo-Dash dev](http://cdnjs.cloudflare.com/ajax/libs/lodash.js/1.0.1/lodash.js),
- [Lo-Dash prod](http://cdnjs.cloudflare.com/ajax/libs/lodash.js/1.0.1/lodash.min.js),<br>
- [Lo-Dash compat-dev](http://cdnjs.cloudflare.com/ajax/libs/lodash.js/1.0.1/lodash.compat.js),
- [Lo-Dash compat-prod](http://cdnjs.cloudflare.com/ajax/libs/lodash.js/1.0.1/lodash.compat.min.js),<br>
- [Underscore compat-dev](http://cdnjs.cloudflare.com/ajax/libs/lodash.js/1.0.1/lodash.underscore.js), and
- [Underscore compat-prod](http://cdnjs.cloudflare.com/ajax/libs/lodash.js/1.0.1/lodash.underscore.min.js)
- * For optimal file size, [create a custom build](https://github.com/bestiejs/lodash#custom-builds) with only the features you need
- ## Dive in
- We’ve got [API docs](http://lodash.com/docs), [benchmarks](http://lodash.com/benchmarks), and [unit tests](http://lodash.com/tests).
- For a list of upcoming features, check out our [roadmap](https://github.com/bestiejs/lodash/wiki/Roadmap).
- ## Resources
- For more information check out these articles, screencasts, and other videos over Lo-Dash:
- * Posts
- - [Say “Hello” to Lo-Dash](http://kitcambridge.be/blog/say-hello-to-lo-dash/)
- * Videos
- - [Introducing Lo-Dash](https://vimeo.com/44154599)
- - [Lo-Dash optimizations and custom builds](https://vimeo.com/44154601)
- - [Lo-Dash’s origin and why it’s a better utility belt](https://vimeo.com/44154600)
- - [Unit testing in Lo-Dash](https://vimeo.com/45865290)
- - [Lo-Dash’s approach to native method use](https://vimeo.com/48576012)
- - [CascadiaJS: Lo-Dash for a better utility belt](http://www.youtube.com/watch?v=dpPy4f_SeEk)
- ## Features
- * AMD loader support ([RequireJS](http://requirejs.org/), [curl.js](https://github.com/cujojs/curl), etc.)
- * [_(…)](http://lodash.com/docs#_) supports intuitive chaining
- * [_.at](http://lodash.com/docs#at) for cherry-picking collection values
- * [_.bindKey](http://lodash.com/docs#bindKey) for binding [*“lazy”* defined](http://michaux.ca/articles/lazy-function-definition-pattern) methods
- * [_.cloneDeep](http://lodash.com/docs#cloneDeep) for deep cloning arrays and objects
- * [_.contains](http://lodash.com/docs#contains) accepts a `fromIndex` argument
- * [_.forEach](http://lodash.com/docs#forEach) is chainable and supports exiting iteration early
- * [_.forIn](http://lodash.com/docs#forIn) for iterating over an object’s own and inherited properties
- * [_.forOwn](http://lodash.com/docs#forOwn) for iterating over an object’s own properties
- * [_.isPlainObject](http://lodash.com/docs#isPlainObject) checks if values are created by the `Object` constructor
- * [_.merge](http://lodash.com/docs#merge) for a deep [_.extend](http://lodash.com/docs#extend)
- * [_.partial](http://lodash.com/docs#partial) and [_.partialRight](http://lodash.com/docs#partialRight) for partial application without `this` binding
- * [_.template](http://lodash.com/docs#template) supports [*“imports”* options](http://lodash.com/docs#templateSettings_imports), [ES6 template delimiters](http://people.mozilla.org/~jorendorff/es6-draft.html#sec-7.8.6), and [sourceURLs](http://www.html5rocks.com/en/tutorials/developertools/sourcemaps/#toc-sourceurl)
- * [_.where](http://lodash.com/docs#where) supports deep object comparisons
- * [_.clone](http://lodash.com/docs#clone), [_.omit](http://lodash.com/docs#omit), [_.pick](http://lodash.com/docs#pick),
- [and more…](http://lodash.com/docs "_.assign, _.cloneDeep, _.first, _.initial, _.isEqual, _.last, _.merge, _.rest") accept `callback` and `thisArg` arguments
- * [_.contains](http://lodash.com/docs#contains), [_.size](http://lodash.com/docs#size), [_.toArray](http://lodash.com/docs#toArray),
- [and more…](http://lodash.com/docs "_.at, _.countBy, _.every, _.filter, _.find, _.forEach, _.groupBy, _.invoke, _.map, _.max, _.min, _.pluck, _.reduce, _.reduceRight, _.reject, _.shuffle, _.some, _.sortBy, _.where") accept strings
- * [_.filter](http://lodash.com/docs#filter), [_.find](http://lodash.com/docs#find), [_.map](http://lodash.com/docs#map),
- [and more…](http://lodash.com/docs "_.countBy, _.every, _.first, _.groupBy, _.initial, _.last, _.max, _.min, _.reject, _.rest, _.some, _.sortBy, _.sortedIndex, _.uniq") support *“_.pluck”* and *“_.where”* `callback` shorthands
- ## Support
- Lo-Dash has been tested in at least Chrome 5~24, Firefox 1~18, IE 6-10, Opera 9.25-12, Safari 3-6, Node.js 0.4.8-0.8.20, Narwhal 0.3.2, PhantomJS 1.8.1, RingoJS 0.9, and Rhino 1.7RC5.
- ## Custom builds
- Custom builds make it easy to create lightweight versions of Lo-Dash containing only the methods you need.
- To top it off, we handle all method dependency and alias mapping for you.
- * Backbone builds, with only methods required by Backbone, may be created using the `backbone` modifier argument.
- ```bash
- lodash backbone
- ```
- * CSP builds, supporting default [Content Security Policy](https://dvcs.w3.org/hg/content-security-policy/raw-file/tip/csp-specification.dev.html) restrictions, may be created using the `csp` modifier argument.
- The `csp` modifier is an alais of the `mobile` modifier. Lo-Dash may be used in Chrome extensions by using either the `csp`, `mobile`, or `underscore` build and using precompiled templates, or loading Lo-Dash in a [sandbox](http://developer.chrome.com/stable/extensions/sandboxingEval.html).
- ```bash
- lodash csp
- ```
- * Legacy builds, tailored for older environments without [ES5 support](http://es5.github.com/), may be created using the `legacy` modifier argument.
- ```bash
- lodash legacy
- ```
- * Modern builds, tailored for newer environments with ES5 support, may be created using the `modern` modifier argument.
- ```bash
- lodash modern
- ```
- * Mobile builds, without method compilation and most bug fixes for old browsers, may be created using the `mobile` modifier argument.
- ```bash
- lodash mobile
- ```
- * Strict builds, with `_.bindAll`, `_.defaults`, and `_.extend` in [strict mode](http://es5.github.com/#C), may be created using the `strict` modifier argument.
- ```bash
- lodash strict
- ```
- * Underscore builds, tailored for projects already using Underscore, may be created using the `underscore` modifier argument.
- ```bash
- lodash underscore
- ```
- Custom builds may be created using the following commands:
- * Use the `category` argument to pass comma separated categories of methods to include in the build.<br>
- Valid categories (case-insensitive) are *“arrays”*, *“chaining”*, *“collections”*, *“functions”*, *“objects”*, and *“utilities”*.
- ```bash
- lodash category=collections,functions
- lodash category="collections, functions"
- ```
- * Use the `exports` argument to pass comma separated names of ways to export the `LoDash` function.<br>
- Valid exports are *“amd”*, *“commonjs”*, *“global”*, *“node”*, and *“none”*.
- ```bash
- lodash exports=amd,commonjs,node
- lodash exports="amd, commonjs, node"
- ```
- * Use the `iife` argument to specify code to replace the immediately-invoked function expression that wraps Lo-Dash.
- ```bash
- lodash iife="!function(window,undefined){%output%}(this)"
- ```
- * Use the `include` argument to pass comma separated method/category names to include in the build.
- ```bash
- lodash include=each,filter,map
- lodash include="each, filter, map"
- ```
- * Use the `minus` argument to pass comma separated method/category names to remove from those included in the build.
- ```bash
- lodash underscore minus=result,shuffle
- lodash underscore minus="result, shuffle"
- ```
- * Use the `plus` argument to pass comma separated method/category names to add to those included in the build.
- ```bash
- lodash backbone plus=random,template
- lodash backbone plus="random, template"
- ```
- * Use the `template` argument to pass the file path pattern used to match template files to precompile.
- ```bash
- lodash template="./*.jst"
- ```
- * Use the `settings` argument to pass the template settings used when precompiling templates.
- ```bash
- lodash settings="{interpolate:/\{\{([\s\S]+?)\}\}/g}"
- ```
- * Use the `moduleId` argument to specify the AMD module ID of Lo-Dash, which defaults to “lodash”, used by precompiled templates.
- ```bash
- lodash moduleId="underscore"
- ```
- All arguments, except `legacy` with `csp`, `mobile`, `modern`, or `underscore`, may be combined.<br>
- Unless specified by `-o` or `--output`, all files created are saved to the current working directory.
- The following options are also supported:
- * `-c`, `--stdout` ......... Write output to standard output
- * `-d`, `--debug` ........... Write only the non-minified development output
- * `-h`, `--help` ............. Display help information
- * `-m`, `--minify` ......... Write only the minified production output
- * `-o`, `--output` ......... Write output to a given path/filename
- * `-p`, `--source-map` .. Generate a source map for the minified output, using an optional source map URL
- * `-s`, `--silent` ......... Skip status updates normally logged to the console
- * `-V`, `--version` ....... Output current version of Lo-Dash
- The `lodash` command-line utility is available when Lo-Dash is installed as a global package (i.e. `npm install -g lodash`).
- ## Installation and usage
- In browsers:
- ```html
- <script src="lodash.js"></script>
- ```
- Using [`npm`](http://npmjs.org/):
- ```bash
- npm install lodash
- npm install -g lodash
- npm link lodash
- ```
- To avoid potential issues, update `npm` before installing Lo-Dash:
- ```bash
- npm install npm -g
- ```
- In [Node.js](http://nodejs.org/) and [RingoJS v0.8.0+](http://ringojs.org/):
- ```js
- var _ = require('lodash');
- // or as a drop-in replacement for Underscore
- var _ = require('lodash/lodash.underscore');
- ```
- **Note:** If Lo-Dash is installed globally, run [`npm link lodash`](http://blog.nodejs.org/2011/03/23/npm-1-0-global-vs-local-installation/) in your project’s root directory before requiring it.
- In [RingoJS v0.7.0-](http://ringojs.org/):
- ```js
- var _ = require('lodash')._;
- ```
- In [Rhino](http://www.mozilla.org/rhino/):
- ```js
- load('lodash.js');
- ```
- In an AMD loader like [RequireJS](http://requirejs.org/):
- ```js
- require({
- 'paths': {
- 'underscore': 'path/to/lodash'
- }
- },
- ['underscore'], function(_) {
- console.log(_.VERSION);
- });
- ```
- ## Release Notes
- ### <sup>v1.0.1</sup>
- * Add support for specifying source map URLs in `-p`/`--source-map` build options
- * Ensured the second argument passed to `_.assign` is not treated as a `callback`
- * Ensured `-p`/`--source-map` build options correctly set the `sourceMappingURL`
- * Made `-p`/`--source-map` build options set source map *“sources”* keys based on the builds performed
- * Made `_.defer` use `setImmediate`, in Node.js, when available
- * Made `_.where` search arrays for values regardless of their index position
- * Removed dead code from `_.template`
- The full changelog is available [here](https://github.com/bestiejs/lodash/wiki/Changelog).
- ## BestieJS
- Lo-Dash is part of the BestieJS *“Best in Class”* module collection. This means we promote solid browser/environment support, ES5 precedents, unit testing, and plenty of documentation.
- ## Author
- * [John-David Dalton](http://allyoucanleet.com/)
- [![twitter/jdalton](http://gravatar.com/avatar/299a3d891ff1920b69c364d061007043?s=70)](https://twitter.com/jdalton "Follow @jdalton on Twitter")
- ## Contributors
- * [Kit Cambridge](http://kitcambridge.github.com/)
- [![twitter/kitcambridge](http://gravatar.com/avatar/6662a1d02f351b5ef2f8b4d815804661?s=70)](https://twitter.com/kitcambridge "Follow @kitcambridge on Twitter")
- * [Mathias Bynens](http://mathiasbynens.be/)
- [![twitter/mathias](http://gravatar.com/avatar/24e08a9ea84deb17ae121074d0f17125?s=70)](https://twitter.com/mathias "Follow @mathias on Twitter")