From 57113b21ed1553c13e2786f49fe21117a7a33c9a Mon Sep 17 00:00:00 2001 From: John-David Dalton Date: Sat, 6 Dec 2014 15:09:11 -0800 Subject: [PATCH] Update readme with new entries and examples. [ci skip] --- README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 354fd0b16..b2ac64845 100644 --- a/README.md +++ b/README.md @@ -60,17 +60,21 @@ var _ = require('lodash-compat'); // or a specific method var clone = require('lodash/lang/clone'); +var keysIn = require('lodash-compat/object/keysIn'); ``` **Note:** -Don’t assign values to the [special variable](http://nodejs.org/api/repl.html#repl_repl_features) `_` when in the REPL +Don’t assign values to the [special variable](http://nodejs.org/api/repl.html#repl_repl_features) `_` when in the REPL. +Install [n_](https://www.npmjs.org/package/n_) for a version of the REPL that includes Lo-Dash by default. ## Features *not* in Underscore * ~100% [code coverage](https://coveralls.io/r/lodash) - * Module bundles for [AMD](https://github.com/lodash/lodash-amd/tree/2.4.1) & [Node.js](https://npmjs.org/package/lodash-node) as well as [npm packages](https://npmjs.org/browse/keyword/lodash-modularized) + * Module bundles for [AMD](https://github.com/lodash/lodash-amd/tree/2.4.1), [ES6](https://github.com/lodash/lodash-es6/tree/2.4.1), & [Node.js](https://npmjs.org/package/lodash-node) as well as [npm packages](https://npmjs.org/browse/keyword/lodash-modularized) * Follows [semantic versioning](http://semver.org/) for releases + * Deferred chaining & [lazy evaluation](http://filimanjaro.com/blog/2014/introducing-lazy-evaluation/) * [_(…)](https://lodash.com/docs#_) supports intuitive chaining + * [_.ary](https://lodash.com/docs#ary) & [_.rearg](https://lodash.com/docs#rearg) to change function argument limits & order * [_.at](https://lodash.com/docs#at) for cherry-picking collection values * [_.attempt](https://lodash.com/docs#attempt) to execute functions which may error without a try-catch * [_.before](https://lodash.com/docs#before) to complement [_.after](https://lodash.com/docs#after) @@ -78,7 +82,6 @@ Don’t assign values to the [special variable](http://nodejs.org/api/repl.html# * [_.chunk](https://lodash.com/docs#chunk) for splitting an array into chunks of a given size * [_.clone](https://lodash.com/docs#clone) supports shallow cloning of `Date` & `RegExp` objects * [_.cloneDeep](https://lodash.com/docs#cloneDeep) for deep cloning arrays & objects - * [_.contains](https://lodash.com/docs#contains) accepts a `fromIndex` * [_.create](https://lodash.com/docs#create) for easier object inheritance * [_.curry](https://lodash.com/docs#curry) & [_.curryRight](https://lodash.com/docs#curryRight) for creating [curried](http://hughfdjackson.com/javascript/why-curry-helps/) functions * [_.debounce](https://lodash.com/docs#debounce) & [_.throttle](https://lodash.com/docs#throttle) are cancelable & accept options for more control @@ -87,10 +90,11 @@ Don’t assign values to the [special variable](http://nodejs.org/api/repl.html# * [_.forEach](https://lodash.com/docs#forEach) supports exiting early * [_.forIn](https://lodash.com/docs#forIn) for iterating all enumerable properties * [_.forOwn](https://lodash.com/docs#forOwn) for iterating own properties + * [_.includes](https://lodash.com/docs#includes) accepts a `fromIndex` * [_.isError](https://lodash.com/docs#isError) to check for error objects * [_.isNative](https://lodash.com/docs#isNative) to check for native functions * [_.isPlainObject](https://lodash.com/docs#isPlainObject) to check for objects created by `Object` - * [_.keysIn](https://lodash.com/docs#keysIn) & [_.valuesIn](https://lodash.com/docs#valuesIn) for getting keys and values of all enumerable properties + * [_.keysIn](https://lodash.com/docs#keysIn) & [_.valuesIn](https://lodash.com/docs#valuesIn) for getting keys & values of all enumerable properties * [_.mapValues](https://lodash.com/docs#mapValues) for [mapping](https://lodash.com/docs#map) values to an object * [_.merge](https://lodash.com/docs#merge) for a deep [_.extend](https://lodash.com/docs#extend) * [_.parseInt](https://lodash.com/docs#parseInt) for consistent behavior @@ -111,16 +115,16 @@ Don’t assign values to the [special variable](http://nodejs.org/api/repl.html# [more](https://lodash.com/docs "_.camelCase, _.deburr, _.endsWith, _.escapeRegExp, _.kebabCase, _.pad, _.padLeft, _.padRight, _.repeat, _.snakeCase, _.startsWith, _.trimLeft, _.trimRight, _.trunc, _.words") string methods * [_.clone](https://lodash.com/docs#clone), [_.isEqual](https://lodash.com/docs#isEqual), & [more](https://lodash.com/docs "_.assign, _.cloneDeep, _.merge") accept callbacks - * [_.contains](https://lodash.com/docs#contains), [_.toArray](https://lodash.com/docs#toArray), & - [more](https://lodash.com/docs "_.at, _.countBy, _.every, _.filter, _.find, _.findLast, _.forEach, _.forEachRight, _.groupBy, _.indexBy, _.invoke, _.map, _.max, _.min, _.partition, _.pluck, _.reduce, _.reduceRight, _.reject, _.shuffle, _.size, _.some, _.sortBy") accept strings * [_.dropWhile](https://lodash.com/docs#dropWhile), [_.takeWhile](https://lodash.com/docs#takeWhile), & [more](https://lodash.com/docs "_.drop, _.dropRightWhile, _.take, _.takeRightWhile") to complement [_.first](https://lodash.com/docs#first), [_.initial](https://lodash.com/docs#initial), [_.last](https://lodash.com/docs#last), & [_.rest](https://lodash.com/docs#rest) * [_.findLast](https://lodash.com/docs#findLast), [_.findLastIndex](https://lodash.com/docs#findLastIndex), & [more](https://lodash.com/docs "_.findLastKey, _.flowRight, _.forEachRight, _.forInRight, _.forOwnRight, _.partialRight") right-associative methods + * [_.includes](https://lodash.com/docs#includes), [_.toArray](https://lodash.com/docs#toArray), & + [more](https://lodash.com/docs "_.at, _.countBy, _.every, _.filter, _.find, _.findLast, _.forEach, _.forEachRight, _.groupBy, _.indexBy, _.invoke, _.map, _.max, _.min, _.partition, _.pluck, _.reduce, _.reduceRight, _.reject, _.shuffle, _.size, _.some, _.sortBy") accept strings ## Support -Tested in Chrome (19, 37-38), Firefox (3, 20, 31-32), IE 6-11, Opera 24-25, Safari 5-7, Node.js 0.8.26~0.10.32, PhantomJS 1.9.7, RingoJS 0.9, & Rhino 1.7RC5. +Tested in Chrome (19, 38-39), Firefox (3, 20, 33-34), IE 6-11, Opera 25-26, Safari 5-8, Node.js 0.8.26~0.10.33, PhantomJS 1.9.7, RingoJS 0.9, & Rhino 1.7RC5. Automated browser test runs [are available](https://saucelabs.com/u/lodash) as well as CI runs for [lodash](https://travis-ci.org/lodash/lodash/), [lodash-cli](https://travis-ci.org/lodash/lodash-cli/), [lodash-amd](https://travis-ci.org/lodash/lodash-amd/), [lodash-node](https://travis-ci.org/lodash/lodash-node/), & [grunt-lodash](https://travis-ci.org/lodash/grunt-lodash). Special thanks to [Sauce Labs](https://saucelabs.com/) for providing automated browser testing.