lodash-object

The lastest version of this document is available on Github > lodash-object

Wrapper for lodash for work with objects

lodash-object takes lodash functions on tables, strings and mathematical calculations but allows to work in object..

If you work with objects and manipulate tables, take a look at linq-to-objects.

Instead of writing

    var myArray = [1, 2, 3, 4];
    _.remove(myArray,function(n) { return n % 2 == 0; });
    var three = _.filter(myArray,function(x) {return x==3});

you will write

    var myArray = [1, 2, 3, 4];
    myArray.remove(function(n) { return n % 2 == 0; });
    var three = myArray.filter(function(x) {return x==3});

OR

  with ES6
   var myArray = [1, 2, 3, 4];
    myArray.remove(n => n%2 == 0);
    var three = myArray.filter(x => x == 3);

Installation

npm install lodash-object --save

OR

yarn add lodash-object --save

References in Node.js

    require("lodash-object");

References in browser

   <script src="./node_modules/lodash/lodash.min.js"></script>

to extend the functionality of tables

  <script src="./node_modules/lodash-object/distrib/Array.min.js"></script>

to extend the functionality of strings

  <script src="./node_modules/lodash-object/distrib/String.min.js"></script>

to extend the functionality of strings with rare functions

  <script src="./node_modules/lodash-object/distrib/StringExtension.min.js"></script>

to extend the mathematical features

  <script  src="./node_modules/lodash-object/distrib/Math.min.js"></script>

These APIs have the same function names as those of Lodash. See Lodash documentation for Lodash features.

Table Of Contents

Note See the complete documentation on github

Array Extension

• chunk
• clear
• compact
• concat
• difference
• differenceBy
• differenceWith
• drop
• dropRight
• dropRightWhile
• dropWhile
• equals
• every
• fill
• findIndex
• findLastIndex
• first
• flatten
• flattenDeep
• flattenDepth
• fromPairs
• head
• includes
• includesAll
• indexOf
• initial
• intersection
• intersectionBy
• intersectionWith
• join
• last
• lastIndexOf
• nth
• pull
• pullAll
• pullAllBy
• pullAllWith
• pullAt
• remove
• replace
• reverse
• slice
• sortedIndex
• sortedIndexBy
• sortedIndexOf
• sortedLastIndex
• sortedLastIndexBy
• sortedLastIndexOf
• sortedUniq
• sortedUniqBy
• tail
• take
• takeRight
• takeRightWhile
• takeWhile
• union
• unionBy
• unionWith
• uniq
• uniqBy
• uniqWith
• unzip
• unzipWith
• without
• xor
• xorBy
• xorWith
• zip
• zipObject
• zipObjectDeep
• zipWith
• countBy
• every
• filter
• find
• findLast
• flatMap
• flatMapDeep
• flatMapDepth
• forEach
• forEachRight
• groupBy
• includes
• invokeMap
• keyBy
• map
• orderBy
• partition
• reduce
• reduceRight
• reject
• sample
• sampleSize
• shuffle
• some
• sortBy
• toJson

String Extension

• between
• capitalize
• chompLeft
• chompRight
• collapseWhitespace
• count
• endsWith
• equalsIgnoreCase
• escape
• escapeRegExp
• includes
• indexOfAny
• isNullOrEmpty
• isNullOrWhiteSpace
• latinize
• lines
• lowerFirst
• pad
• padEnd
• padStart
• repeat
• replace
• reverse
• split
• strip
• startsWith
• toCharArray
• toLowerCase
• toUpperCase
• trim
• trimEnd
• trimStart
• truncate
• unescape
• upperFirst
• words

functions on character strings rarely used

• camelCase
• kebabCase
• snakeCase
• startCase

Math Extension

• add
• ceil
• divide
• floor
• max
• maxBy
• mean
• meanBy
• min
• minBy
• multiply
• round
• subtract
• sum
• sumBy
• clamp
• inRange
• random