摘要：中文文檔方法方法創(chuàng)建一個包含的對象以開啟內(nèi)置的方法鏈。注意該方法會修改包裝數(shù)組。返回返回強制轉(zhuǎn)為字符串的值示例執(zhí)行方法鏈隊列并提取未包裝的值別名返回返回已處理的未包裝的值示例

Translated by PeckZeg
Original Docs: Lodash v3.10.1 Docs

創(chuàng)建一個包含 value 的 lodash 對象以開啟內(nèi)置的方法鏈。方法鏈對返回數(shù)組、集合或函數(shù)的方法產(chǎn)生作用，并且方法可以被鏈?zhǔn)秸{(diào)用。那些獲取單值或可能返回一個原始值的方法將自動結(jié)束方法鏈并且返回一個未包裹成 lodash 對象的值。如果明確需要鏈?zhǔn)秸{(diào)用可以使用 _.chain。鏈?zhǔn)秸{(diào)用的加載將是延遲加載，這表明調(diào)用將延遲到間接或直接調(diào)用 _#value 方法。

延遲計算支持一些方法快速合并。快速合并是一個最優(yōu)合并迭代器調(diào)用的策略。這樣做可以幫助避免一些計算中間生成的數(shù)據(jù)結(jié)構(gòu)，并且能夠大大降低迭代器的執(zhí)行次數(shù)。

鏈?zhǔn)秸{(diào)用支持自定義生成結(jié)果。只要在生成的時候直接或間接的包含 _#value 方法。

此外，對于 lodash 的方法，包裝集擁有 Array 和 String 的方法。

Array 包裝集的方法有：

concat, join, pop, push, reverse, shift, slice, sort, splice 和 unshift

String 包裝集的方法有：

replace 和 split

支持快速合并的包裝集方法有：

compact, drop, dropRight, dropRightWhile, dropWhile, filter, first, initial, last, map, pluck, reject, rest, reverse, slice, take, takeRight, takeRightWhile, takeWhile, toArray 和 where

可鏈?zhǔn)秸{(diào)用的包裝集方法有：

after, ary, assign, at, before, bind, bindAll, bindKey, callback, chain, chunk, commit, compact, concat, constant, countBy, create, curry, debounce, defaults, defaultsDeep, defer, delay, difference, drop, dropRight, dropRightWhile, dropWhile, fill, filter, flatten, flattenDeep, flow, flowRight, forEach, forEachRight, forIn, forInRight, forOwn, forOwnRight, functions, groupBy, indexBy, initial, intersection, invert, invoke, keys, keysIn, map, mapKeys, mapValues, matches, matchesProperty, memoize, merge, method, methodOf, mixin, modArgs, negate, omit, once, pairs, partial, partialRight, partition, pick, plant, pluck, property, propertyOf, pull, pullAt, push, range, rearg, reject, remove, rest, restParam, reverse, set, shuffle, slice, sort, sortBy, sortByAll, sortByOrder, splice, spread, take, takeRight, takeRightWhile, takeWhile, tap, throttle, thru, times, toArray, toPlainObject, transform, union, uniq, unshift, unzip, unzipWith, values, valuesIn, where, without, wrap, xor, zip, zipObject, zipWith

默認不能被鏈?zhǔn)秸{(diào)用的包裝集方法有：

add, attempt, camelCase, capitalize, ceil, clone, cloneDeep, deburr, endsWith, escape, escapeRegExp, every, find, findIndex, findKey, findLast, findLastIndex, findLastKey, findWhere, first, floor, get, gt, gte, has, identity, includes, indexOf, inRange, isArguments, isArray, isBoolean, isDate, isElement, isEmpty, isEqual, isError, isFinite isFunction, isMatch, isNative, isNaN, isNull, isNumber, isObject, isPlainObject, isRegExp, isString, isUndefined, isTypedArray, join, kebabCase, last, lastIndexOf, lt, lte, max, min, noConflict, noop, now, pad, padLeft, padRight, parseInt, pop, random, reduce, reduceRight, repeat, result, round, runInContext, shift, size, snakeCase, some, sortedIndex, sortedLastIndex, startCase, startsWith, sum, template, trim, trimLeft, trimRight, trunc, unescape, uniqueId, value 和 words

包裝集函數(shù) sample 在參數(shù)提供 n 的情況下將返回包裝集，其他情況下將返回未經(jīng)包裝過的值。

參數(shù)

value (*) : 待包裝至 lodash 實例的值

返回

(Object) : 返回一個新的 lodash 包裝集實例

示例

var wrapped = _([1, 2, 3]);

// 返回一個未包裝的值
wrapped.reduce(function(total, n) {
  return total + n;
});
// → 6

// 返回一個包裝值
var squares = wrapped.map(function(n) {
  return n * n;
});

_.isArray(squares);
// → false

_.isArray(squares.value());
// → true

創(chuàng)建一個明確能夠被鏈?zhǔn)秸{(diào)用的 lodash 對象

參數(shù)

value (*) : 待包裝的值

返回

(Object) : 返回一個新的 lodash 包裝實例

示例

var users = [
  { "user": "barney",  "age": 36 },
  { "user": "fred",    "age": 40 },
  { "user": "pebbles", "age": 1 }
];

var youngest = _.chain(users)
  .sortBy("age")
  .map(function(chr) {
    return chr.user + " is " + chr.age;
  })
  .first()
  .value();
// → "pebbles is 1"

該方法執(zhí)行 interceptor 并返回 value。該攔截器將綁定 thisArg 并在執(zhí)行時傳入一個參數(shù)：value。該方法的目的是“利用”方法鏈去操作鏈中的中間結(jié)果。

參數(shù)

value (*) : 提供給攔截器的值

interceptor (Function) : 待執(zhí)行的函數(shù)

[thisArg] (*) : interceptor 綁定的 this

返回

(*) : 返回值

示例

_([1, 2, 3])
 .tap(function(array) {
   array.pop();
 })
 .reverse()
 .value();
// → [2, 1]

This method is like _.tap except that it returns the result of interceptor.

該方法類似 _.tap，但其返回攔截器的值。

參數(shù)

value (*) : 提供給攔截器的值

interceptor (Function) : 待執(zhí)行的函數(shù)

[thisArg] (*) : interceptor 綁定的 this

返回

(*) : 返回 interceptor 的結(jié)果

示例

_("  abc  ")
 .chain()
 .trim()
 .thru(function(value) {
   return [value];
 })
 .value();
// → ["abc"]

在包裝對象上顯式開啟鏈?zhǔn)秸{(diào)用

返回

(Object) : 返回一個新的 lodash 包裝實例

示例

var users = [
  { "user": "barney", "age": 36 },
  { "user": "fred",   "age": 40 }
];

// 不使用顯式調(diào)用鏈
_(users).first();
// → { "user": "barney", "age": 36 }

// 使用顯式調(diào)用鏈
_(users).chain()
  .first()
  .pick("user")
  .value();
// → { "user": "barney" }

執(zhí)行調(diào)用鏈隊列并返回包裝集結(jié)果

返回

(Object) : 返回新的 lodash 包裝集實例

示例

var array = [1, 2];
var wrapped = _(array).push(3);

console.log(array);
// → [1, 2]

wrapped = wrapped.commit();
console.log(array);
// → [1, 2, 3]

wrapped.last();
// → 3

console.log(array);
// → [1, 2, 3]

Creates a new array joining a wrapped array with any additional arrays and/or values.

創(chuàng)建一個含有連接其他數(shù)組和（或）值的新數(shù)組包裝集。

參數(shù)

[values] (…*) : 帶連接的值

返回

(Array) : 返回一個已連接的新數(shù)組

示例

var array = [1];
var wrapped = _(array).concat(2, [3], [[4]]);

console.log(wrapped.value());
// → [1, 2, 3, [4]]

console.log(array);
// → [1]

創(chuàng)建一個鏈?zhǔn)秸{(diào)用隊列的克隆（會將 value 替換為克隆后的鏈?zhǔn)秸{(diào)用鏈中）。

返回

(Object) : 返回一個新的 lodash 包裝實例

示例

var array = [1, 2];
var wrapped = _(array).map(function(value) {
  return Math.pow(value, 2);
});

var other = [3, 4];
var otherWrapped = wrapped.plant(other);

otherWrapped.value();
// → [9, 16]

wrapped.value();
// → [1, 4]

翻轉(zhuǎn)包裝數(shù)組，將第一個元素和最后一個元素對換，第二個元素和倒數(shù)第二個元素對換，以此類推。

注意：該方法會修改包裝數(shù)組。

返回

(Object) : 返回一個已經(jīng)翻轉(zhuǎn)過的數(shù)組的 lodash 包裝實例

示例

var array = [1, 2, 3];

_(array).reverse().value()
// → [3, 2, 1]

console.log(array);
// → [3, 2, 1]

Produces the result of coercing the unwrapped value to a string.

產(chǎn)生強制將值轉(zhuǎn)為未包裝的字符串果。

返回

(string) : 返回強制轉(zhuǎn)為字符串的值

示例

_([1, 2, 3]).toString();
// → "1,2,3"

執(zhí)行方法鏈隊列并提取未包裝的值

別名

_.prototype.run

_.prototype.toJSON

_.prototype.valueOf

返回

(*) : 返回已處理的未包裝的值

示例

_([1, 2, 3]).value();
// → [1, 2, 3]