PageRenderTime 47ms CodeModel.GetById 18ms RepoModel.GetById 1ms app.codeStats 0ms

/node_modules/grunt/node_modules/findup-sync/node_modules/lodash/README.md

https://bitbucket.org/biojazzard/gantry-eboracast
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
  1. # Lo-Dash <sup>v1.0.1</sup>
  2. [![build status](https://secure.travis-ci.org/bestiejs/lodash.png)](http://travis-ci.org/bestiejs/lodash)
  3. 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).
  4. ## Download
  5. * Lo-Dash builds (for modern environments):<br>
  6. [Development](https://raw.github.com/bestiejs/lodash/v1.0.1/dist/lodash.js) and
  7. [Production](https://raw.github.com/bestiejs/lodash/v1.0.1/dist/lodash.min.js)
  8. * Lo-Dash compatibility builds (for legacy and modern environments):<br>
  9. [Development](https://raw.github.com/bestiejs/lodash/v1.0.1/dist/lodash.compat.js) and
  10. [Production](https://raw.github.com/bestiejs/lodash/v1.0.1/dist/lodash.compat.min.js)
  11. * Underscore compatibility builds:<br>
  12. [Development](https://raw.github.com/bestiejs/lodash/v1.0.1/dist/lodash.underscore.js) and
  13. [Production](https://raw.github.com/bestiejs/lodash/v1.0.1/dist/lodash.underscore.min.js)
  14. * CDN copies of v1.0.1s builds are available on [cdnjs](http://cdnjs.com/) thanks to [CloudFlare](http://www.cloudflare.com/):<br>
  15. [Lo-Dash dev](http://cdnjs.cloudflare.com/ajax/libs/lodash.js/1.0.1/lodash.js),
  16. [Lo-Dash prod](http://cdnjs.cloudflare.com/ajax/libs/lodash.js/1.0.1/lodash.min.js),<br>
  17. [Lo-Dash compat-dev](http://cdnjs.cloudflare.com/ajax/libs/lodash.js/1.0.1/lodash.compat.js),
  18. [Lo-Dash compat-prod](http://cdnjs.cloudflare.com/ajax/libs/lodash.js/1.0.1/lodash.compat.min.js),<br>
  19. [Underscore compat-dev](http://cdnjs.cloudflare.com/ajax/libs/lodash.js/1.0.1/lodash.underscore.js), and
  20. [Underscore compat-prod](http://cdnjs.cloudflare.com/ajax/libs/lodash.js/1.0.1/lodash.underscore.min.js)
  21. * For optimal file size, [create a custom build](https://github.com/bestiejs/lodash#custom-builds) with only the features you need
  22. ## Dive in
  23. Weve got [API docs](http://lodash.com/docs), [benchmarks](http://lodash.com/benchmarks), and [unit tests](http://lodash.com/tests).
  24. For a list of upcoming features, check out our [roadmap](https://github.com/bestiejs/lodash/wiki/Roadmap).
  25. ## Resources
  26. For more information check out these articles, screencasts, and other videos over Lo-Dash:
  27. * Posts
  28. - [Say Hello to Lo-Dash](http://kitcambridge.be/blog/say-hello-to-lo-dash/)
  29. * Videos
  30. - [Introducing Lo-Dash](https://vimeo.com/44154599)
  31. - [Lo-Dash optimizations and custom builds](https://vimeo.com/44154601)
  32. - [Lo-Dashs origin and why its a better utility belt](https://vimeo.com/44154600)
  33. - [Unit testing in Lo-Dash](https://vimeo.com/45865290)
  34. - [Lo-Dashs approach to native method use](https://vimeo.com/48576012)
  35. - [CascadiaJS: Lo-Dash for a better utility belt](http://www.youtube.com/watch?v=dpPy4f_SeEk)
  36. ## Features
  37. * AMD loader support ([RequireJS](http://requirejs.org/), [curl.js](https://github.com/cujojs/curl), etc.)
  38. * [_()](http://lodash.com/docs#_) supports intuitive chaining
  39. * [_.at](http://lodash.com/docs#at) for cherry-picking collection values
  40. * [_.bindKey](http://lodash.com/docs#bindKey) for binding [*“lazy”* defined](http://michaux.ca/articles/lazy-function-definition-pattern) methods
  41. * [_.cloneDeep](http://lodash.com/docs#cloneDeep) for deep cloning arrays and objects
  42. * [_.contains](http://lodash.com/docs#contains) accepts a `fromIndex` argument
  43. * [_.forEach](http://lodash.com/docs#forEach) is chainable and supports exiting iteration early
  44. * [_.forIn](http://lodash.com/docs#forIn) for iterating over an object’s own and inherited properties
  45. * [_.forOwn](http://lodash.com/docs#forOwn) for iterating over an object’s own properties
  46. * [_.isPlainObject](http://lodash.com/docs#isPlainObject) checks if values are created by the `Object` constructor
  47. * [_.merge](http://lodash.com/docs#merge) for a deep [_.extend](http://lodash.com/docs#extend)
  48. * [_.partial](http://lodash.com/docs#partial) and [_.partialRight](http://lodash.com/docs#partialRight) for partial application without `this` binding
  49. * [_.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)
  50. * [_.where](http://lodash.com/docs#where) supports deep object comparisons
  51. * [_.clone](http://lodash.com/docs#clone), [_.omit](http://lodash.com/docs#omit), [_.pick](http://lodash.com/docs#pick),
  52. [and more](http://lodash.com/docs "_.assign, _.cloneDeep, _.first, _.initial, _.isEqual, _.last, _.merge, _.rest") accept `callback` and `thisArg` arguments
  53. * [_.contains](http://lodash.com/docs#contains), [_.size](http://lodash.com/docs#size), [_.toArray](http://lodash.com/docs#toArray),
  54. [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
  55. * [_.filter](http://lodash.com/docs#filter), [_.find](http://lodash.com/docs#find), [_.map](http://lodash.com/docs#map),
  56. [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
  57. ## Support
  58. 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.
  59. ## Custom builds
  60. Custom builds make it easy to create lightweight versions of Lo-Dash containing only the methods you need.
  61. To top it off, we handle all method dependency and alias mapping for you.
  62. * Backbone builds, with only methods required by Backbone, may be created using the `backbone` modifier argument.
  63. ```bash
  64. lodash backbone
  65. ```
  66. * 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.
  67. 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).
  68. ```bash
  69. lodash csp
  70. ```
  71. * Legacy builds, tailored for older environments without [ES5 support](http://es5.github.com/), may be created using the `legacy` modifier argument.
  72. ```bash
  73. lodash legacy
  74. ```
  75. * Modern builds, tailored for newer environments with ES5 support, may be created using the `modern` modifier argument.
  76. ```bash
  77. lodash modern
  78. ```
  79. * Mobile builds, without method compilation and most bug fixes for old browsers, may be created using the `mobile` modifier argument.
  80. ```bash
  81. lodash mobile
  82. ```
  83. * Strict builds, with `_.bindAll`, `_.defaults`, and `_.extend` in [strict mode](http://es5.github.com/#C), may be created using the `strict` modifier argument.
  84. ```bash
  85. lodash strict
  86. ```
  87. * Underscore builds, tailored for projects already using Underscore, may be created using the `underscore` modifier argument.
  88. ```bash
  89. lodash underscore
  90. ```
  91. Custom builds may be created using the following commands:
  92. * Use the `category` argument to pass comma separated categories of methods to include in the build.<br>
  93. Valid categories (case-insensitive) are *arrays*, *chaining*, *collections*, *functions*, *objects*, and *utilities*.
  94. ```bash
  95. lodash category=collections,functions
  96. lodash category="collections, functions"
  97. ```
  98. * Use the `exports` argument to pass comma separated names of ways to export the `LoDash` function.<br>
  99. Valid exports are *amd*, *commonjs*, *global*, *node*, and *none*.
  100. ```bash
  101. lodash exports=amd,commonjs,node
  102. lodash exports="amd, commonjs, node"
  103. ```
  104. * Use the `iife` argument to specify code to replace the immediately-invoked function expression that wraps Lo-Dash.
  105. ```bash
  106. lodash iife="!function(window,undefined){%output%}(this)"
  107. ```
  108. * Use the `include` argument to pass comma separated method/category names to include in the build.
  109. ```bash
  110. lodash include=each,filter,map
  111. lodash include="each, filter, map"
  112. ```
  113. * Use the `minus` argument to pass comma separated method/category names to remove from those included in the build.
  114. ```bash
  115. lodash underscore minus=result,shuffle
  116. lodash underscore minus="result, shuffle"
  117. ```
  118. * Use the `plus` argument to pass comma separated method/category names to add to those included in the build.
  119. ```bash
  120. lodash backbone plus=random,template
  121. lodash backbone plus="random, template"
  122. ```
  123. * Use the `template` argument to pass the file path pattern used to match template files to precompile.
  124. ```bash
  125. lodash template="./*.jst"
  126. ```
  127. * Use the `settings` argument to pass the template settings used when precompiling templates.
  128. ```bash
  129. lodash settings="{interpolate:/\{\{([\s\S]+?)\}\}/g}"
  130. ```
  131. * Use the `moduleId` argument to specify the AMD module ID of Lo-Dash, which defaults to lodash, used by precompiled templates.
  132. ```bash
  133. lodash moduleId="underscore"
  134. ```
  135. All arguments, except `legacy` with `csp`, `mobile`, `modern`, or `underscore`, may be combined.<br>
  136. Unless specified by `-o` or `--output`, all files created are saved to the current working directory.
  137. The following options are also supported:
  138. * `-c`, `--stdout` ......... Write output to standard output
  139. * `-d`, `--debug` ........... Write only the non-minified development output
  140. * `-h`, `--help` ............. Display help information
  141. * `-m`, `--minify` ......... Write only the minified production output
  142. * `-o`, `--output` ......... Write output to a given path/filename
  143. * `-p`, `--source-map` .. Generate a source map for the minified output, using an optional source map URL
  144. * `-s`, `--silent` ......... Skip status updates normally logged to the console
  145. * `-V`, `--version` ....... Output current version of Lo-Dash
  146. The `lodash` command-line utility is available when Lo-Dash is installed as a global package (i.e. `npm install -g lodash`).
  147. ## Installation and usage
  148. In browsers:
  149. ```html
  150. <script src="lodash.js"></script>
  151. ```
  152. Using [`npm`](http://npmjs.org/):
  153. ```bash
  154. npm install lodash
  155. npm install -g lodash
  156. npm link lodash
  157. ```
  158. To avoid potential issues, update `npm` before installing Lo-Dash:
  159. ```bash
  160. npm install npm -g
  161. ```
  162. In [Node.js](http://nodejs.org/) and [RingoJS v0.8.0+](http://ringojs.org/):
  163. ```js
  164. var _ = require('lodash');
  165. // or as a drop-in replacement for Underscore
  166. var _ = require('lodash/lodash.underscore');
  167. ```
  168. **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.
  169. In [RingoJS v0.7.0-](http://ringojs.org/):
  170. ```js
  171. var _ = require('lodash')._;
  172. ```
  173. In [Rhino](http://www.mozilla.org/rhino/):
  174. ```js
  175. load('lodash.js');
  176. ```
  177. In an AMD loader like [RequireJS](http://requirejs.org/):
  178. ```js
  179. require({
  180. 'paths': {
  181. 'underscore': 'path/to/lodash'
  182. }
  183. },
  184. ['underscore'], function(_) {
  185. console.log(_.VERSION);
  186. });
  187. ```
  188. ## Release Notes
  189. ### <sup>v1.0.1</sup>
  190. * Add support for specifying source map URLs in `-p`/`--source-map` build options
  191. * Ensured the second argument passed to `_.assign` is not treated as a `callback`
  192. * Ensured `-p`/`--source-map` build options correctly set the `sourceMappingURL`
  193. * Made `-p`/`--source-map` build options set source map *sources* keys based on the builds performed
  194. * Made `_.defer` use `setImmediate`, in Node.js, when available
  195. * Made `_.where` search arrays for values regardless of their index position
  196. * Removed dead code from `_.template`
  197. The full changelog is available [here](https://github.com/bestiejs/lodash/wiki/Changelog).
  198. ## BestieJS
  199. 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.
  200. ## Author
  201. * [John-David Dalton](http://allyoucanleet.com/)
  202. [![twitter/jdalton](http://gravatar.com/avatar/299a3d891ff1920b69c364d061007043?s=70)](https://twitter.com/jdalton "Follow @jdalton on Twitter")
  203. ## Contributors
  204. * [Kit Cambridge](http://kitcambridge.github.com/)
  205. [![twitter/kitcambridge](http://gravatar.com/avatar/6662a1d02f351b5ef2f8b4d815804661?s=70)](https://twitter.com/kitcambridge "Follow @kitcambridge on Twitter")
  206. * [Mathias Bynens](http://mathiasbynens.be/)
  207. [![twitter/mathias](http://gravatar.com/avatar/24e08a9ea84deb17ae121074d0f17125?s=70)](https://twitter.com/mathias "Follow @mathias on Twitter")