Lodash 常用API中文參考


lodash和underscore都是現在非常流行的兩個javascript庫,提供了一套函數式編程的實用功能。

而lodash本身最初也是underscore的一個fork,因為和其他(Underscore.js的)貢獻者意見相左。

lodash主要使用了延遲計算,所以也使得lodash的性能遠遠超過了Underscore。
在lodash中使用延遲計算,也就意味着當我們使用鏈式方法時,在直接或間接調用value()之前是不會執行的。

更多方法請自行查看lodash官方文檔

1) _.map(collection, [iteratee=_.identity], [thisArg])

   作用:創建一個經過 iteratee 處理的集合中每一個元素的結果數組. iteratee 會傳入3個參數:(value, index|key, collection). 

   別名(Aliases):_.collect

   參數1): 需要遍歷的集合,可以是數組,對象或者字符串.

   參數2): 迭代器,可以是函數,對象或者字符串.

   參數3): 迭代器中this所綁定的對象.

   返回值(Array): 映射后的新數組.

function timesThree(n) { 2   return n * 3; 3 } 4  5 _.map([1, 2], timesThree); 6 // => [3, 6] 7  8 _.map({ 'a': 1, 'b': 2 }, timesThree); 9 // => [3, 6] (iteration order is not guaranteed)10 11 var users = [12   { 'user': 'barney' },13   { 'user': 'fred' }14 ];15 16 // using the `_.property` callback shorthand17 _.map(users, 'user');18 // => ['barney', 'fred']

2) _.chunk(array, [size=1])

   作用:將 array 拆分成多個 size 長度的塊,把這些塊組成一個新數組。 如果 array 無法被分割成全部等長的塊,那么最后剩余的元素將組成一個塊.

   參數1): 需要被處理的數組.

   參數2): 每個塊的長度.

   返回值(Array): 返回一個包含拆分塊數組的新數組(相當於一個二維數組).

   示例:

_.chunk(['a', 'b', 'c', 'd'], 2);2 // => [['a', 'b'], ['c', 'd']]3 4 _.chunk(['a', 'b', 'c', 'd'], 3);5 // => [['a', 'b', 'c'], ['d']]

3) _.compact(array)

   作用:創建一個新數組並包含原數組中所有的非假值元素。例如 falsenull、 0""undefined 和 NaN 都是“假值”.

   參數: 需要被過濾的數組.

   返回值(Array): 過濾假值后的數組.

   示例:

_.compact([0, 1, false, 2, '', 3]);2 // => [1, 2, 3]

4)_.difference(array, [values])

   作用:創建一個差異化后的數組,不包括使用 SameValueZero 方法提供的數組.

   參數1): 需要處理的數組.

   參數2): 數組需要排除掉的值.

   返回值(Array): 過濾后的數組.

   示例:

_.difference([1, 2, 3], [4, 2]);2 // => [1, 3]3 _.difference([1, '2', 3], [4, 2]);4 // => [1, "2", 3]

5) _.drop(array, [n=1])

   作用:將 array 中的前 n 個元素去掉,然后返回剩余的部分.

   參數1): 被操作的數組.

   參數2): 去掉的元素個數.

   返回值(Array): 數組的剩余部分.

   示例:

_.drop([1, 2, 3]); 2 // => [2, 3] 默認是1開始的 3  4 _.drop([1, 2, 3], 2); 5 // => [3] 6  7 _.drop([1, 2, 3], 5); 8 // => [] 9 10 _.drop([1, 2, 3], 0);11 // => [1, 2, 3]

6)_.dropRight(array, [n=1])

   作用:將 array 尾部的 n 個元素去除,並返回剩余的部分.

   參數1): 需要被處理的數組.

   參數2): 去掉的元素個數.

   返回值(Array): 數組的剩余部分.

   示例:

_.dropRight([1, 2, 3]); 2 // => [1, 2] 3  4 _.dropRight([1, 2, 3], 2); 5 // => [1] 6  7 _.dropRight([1, 2, 3], 5); 8 // => [] 9 10 _.dropRight([1, 2, 3], 0);11 // => [1, 2, 3]

7)_.dropRightWhile(array, [predicate=_.identity], [thisArg])

   作用:從尾端查詢(右數)數組 array ,第一個不滿足predicate 條件的元素開始截取數組.

   參數1): 需要查詢的數組.

   參數2): 迭代器,可以是函數,對象或者字符串.

   參數3): 對應 predicate 屬性的值.

   返回值(Array): 截取元素后的數組.

   示例:

 _.dropRightWhile([1, 2, 3], function(n) { 2   return n > 1; 3 }); 4 // => [1] 5  6 var users = [ 7   { 'user': 'barney',  'active': true }, 8   { 'user': 'fred',    'active': false }, 9   { 'user': 'pebbles', 'active': false }10 ];11 12 // using the `_.matches` callback shorthand13 _.pluck(_.dropRightWhile(users, { 'user': 'pebbles', 'active': false }), 'user');14 // => ['barney', 'fred']15 16 // using the `_.matchesProperty` callback shorthand17 _.pluck(_.dropRightWhile(users, 'active', false), 'user');18 // => ['barney']19 20 // using the `_.property` callback shorthand21 _.pluck(_.dropRightWhile(users, 'active'), 'user');22 // => ['barney', 'fred', 'pebbles']

8)_.pluck(collection, path)

   作用:抽取集合中path所指定的路徑的屬性值.

   參數1): 需要抽取的數組.

   參數2): 需要抽取的屬性所對應的路徑.

   返回值(Array): 抽取的屬性值所組成的數組.

   示例:

 1 var users = [ 2   { 'user': 'barney', 'age': 36 }, 3   { 'user': 'fred',   'age': 40 } 4 ]; 5  6 _.pluck(users, 'user'); 7 // => ['barney', 'fred'] 8  9 var userIndex = _.indexBy(users, 'user');10 _.pluck(userIndex, 'age');11 // => [36, 40] (iteration order is not guaranteed)

9)_.fill(array, value, [start=0], [end=array.length])

   作用:使用 value 值來填充(也就是替換) array,從start位置開始, 到end位置結束(但不包含end位置).

   參數1): 需要填充的數組.

   參數2): 填充 array 元素的值.

   參數3): 起始位置(包含).

   參數4): 結束位置(不含).

   返回值(Array): 填充后的數組.

   示例:

var array = [1, 2, 3]; 2  3 _.fill(array, 'a'); 4 console.log(array); 5 // => ['a', 'a', 'a'] 6  7 _.fill(Array(3), 2); 8 // => [2, 2, 2] 9 10 _.fill([4, 6, 8], '*', 1, 2);11 // => [4, '*', 8]

10)_.findIndex(array, [predicate=_.identity], [thisArg])

   作用:該方法類似 _.find,區別是該方法返回的是符合 predicate條件的第一個元素的索引,而不是返回元素本身. 

   參數1): 需要搜索的數組.

   參數2): 迭代器,可以是函數,對象或者字符串.

   參數3): 對應 predicate 屬性的值.

   返回值(Number): 符合查詢條件的元素的索引值, 未找到則返回 -1.

   示例:

var users = [ 2   { 'user': 'barney',  'active': false }, 3   { 'user': 'fred',    'active': false }, 4   { 'user': 'pebbles', 'active': true } 5 ]; 6  7 _.findIndex(users, function(chr) { 8   return chr.user == 'barney'; 9 });10 // => 011 12 // using the `_.matches` callback shorthand13 _.findIndex(users, { 'user': 'fred', 'active': false });14 // => 115 16 // using the `_.matchesProperty` callback shorthand17 _.findIndex(users, 'active', false);18 // => 019 20 // using the `_.property` callback shorthand21 _.findIndex(users, 'active');22 // => 2

11)_.find(collection, [predicate=_.identity], [thisArg])

   作用:遍歷集合中的元素,返回最先經 predicate 檢查為真值的元素. predicate 會傳入3個元素:(value, index|key, collection).

   參數1): 要檢索的集合,可以是數組,對象或者字符串.

   參數2): 迭代器,可以是函數,對象或者字符串.

   參數3): 迭代器中this所綁定的對象.

   返回值: 匹配元素,否則返回 undefined.

   示例:

var users = [ 2   { 'user': 'barney',  'age': 36, 'active': true }, 3   { 'user': 'fred',    'age': 40, 'active': false }, 4   { 'user': 'pebbles', 'age': 1,  'active': true } 5 ]; 6  7 _.find(users, function(o) { return o.age < 40; }); 8 // =>  'barney' 9 10 // 使用了 `_.matches` 的回調結果11 _.find(users, { 'age': 1, 'active': true });12 // =>  'pebbles'13 14 // 使用了 `_.matchesProperty` 的回調結果15 _.find(users, ['active', false]);16 // =>  'fred'17 18 // 使用了 `_.property` 的回調結果19 _.find(users, 'active');20 // =>  'barney'

 12)_.forEach(collection, [iteratee=_.identity], [thisArg])

   作用:調用 iteratee 遍歷集合中的元素, iteratee 會傳入3個參數:(value, index|key, collection)。 如果顯式的返回 false ,iteratee 會提前退出.

   參數1): 需要遍歷的集合,可以是數組,對象或者字符串.

   參數2): 迭代器,只能是函數.

   參數3): 迭代器中this所綁定的對象.

   返回值: 遍歷后的集合.

   示例:

_([1, 2]).forEach(function(value) {2   console.log(value);3 });4 // => 輸出 `1` 和 `2`5 6 _.forEach({ 'a': 1, 'b': 2 }, function(value, key) {7   console.log(key);8 });9 // => 輸出 'a' 和 'b' (不保證遍歷的順序)

13)_.reduce(collection, [iteratee=_.identity], [accumulator], [thisArg])

   作用:通過 iteratee 遍歷集合中的每個元素. 每次返回的值會作為下一次 iteratee 使用。如果沒有提供accumulator,則集合中的第一個元素作為 accumulator. iteratee 會傳入4個參數:(accumulator, value, index|key, collection).

   參數1): 需要遍歷的集合,可以是數組,對象或者字符串.

   參數2): 迭代器,只能是函數.

   參數3): 累加器的初始化值.

   參數4): 迭代器中this所綁定的對象.

   返回值: 累加后的值.

   示例:

_.reduce([1, 2], function(total, n) { 2   return total + n; 3 }); 4 // => 3 5  6 _.reduce({ 'a': 1, 'b': 2 }, function(result, n, key) { 7   result[key] = n * 3; 8   return result; 9 }, {});10 // => { 'a': 3, 'b': 6 } (iteration order is not guaranteed)

14)_.some(collection, [predicate=_.identity], [thisArg])

   作用:通過 predicate 檢查集合中的元素是否存在任意真值的元素,只要 predicate返回一次真值,遍歷就停止,並返回 true. predicate 會傳入3個參數:(value, index|key, collection).

   參數1): 需要遍歷的集合,可以是數組,對象或者字符串.

   參數2): 迭代器,可以是函數,對象或字符串.

   參數3): 迭代器中this所綁定的對象.

   返回值: 如果任意元素經 predicate 檢查都為真值,則返回true,否則返回 false.

_.some([null, 0, 'yes', false], Boolean); 2 // => true 3  4 var users = [ 5   { 'user': 'barney', 'active': true }, 6   { 'user': 'fred',   'active': false } 7 ]; 8  9 // using the `_.matches` callback shorthand10 _.some(users, { 'user': 'barney', 'active': false });11 // => false12 13 // using the `_.matchesProperty` callback shorthand14 _.some(users, 'active', false);15 // => true16 17 // using the `_.property` callback shorthand18 _.some(users, 'active');19 // => true

15)_.chain(value)

   作用:創建一個包含 value 的 lodash 對象以開啟內置的方法鏈.方法鏈對返回數組、集合或函數的方法產生作用,並且方法可以被鏈式調用.

   參數: 需要被包裹成lodash對象的值.

   返回值: 新的lodash對象的實例.

   示例:

var users = [ 2   { 'user': 'barney',  'age': 36 }, 3   { 'user': 'fred',    'age': 40 }, 4   { 'user': 'pebbles', 'age': 1 } 5 ]; 6  7 var youngest = _.chain(users) 8   .sortBy('age') 9   .map(function(chr) {10     return chr.user + ' is ' + chr.age;11   })12   .first()13   .value();14 // => 'pebbles is 1'

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM