forked from jashkenas/underscore
-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathindex.html
2813 lines (2573 loc) · 113 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE HTML>
<html>
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<meta http-equiv="X-UA-Compatible" content="chrome=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<meta name="viewport" content="target-densitydpi=device-dpi" />
<meta name="HandheldFriendly" content="true"/>
<link rel="canonical" href="http://learning.github.io/underscore" />
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon" />
<title>Underscore.js 中文文档 (1.7.0)</title>
<style>
body {
font-size: 14px;
line-height: 22px;
background: #f4f4f4 url(docs/images/background.png);
color: #000;
font-family: Helvetica Neue, Helvetica, Arial;
}
.interface {
font-family: "Lucida Grande", "Lucida Sans Unicode", Helvetica, Arial, sans-serif !important;
}
div#sidebar {
background: #fff;
position: fixed;
top: 0; left: 0; bottom: 0;
width: 200px;
overflow-y: auto;
overflow-x: hidden;
-webkit-overflow-scrolling: touch;
padding: 15px 0 30px 30px;
border-right: 1px solid #bbb;
box-shadow: 0 0 20px #ccc; -webkit-box-shadow: 0 0 20px #ccc; -moz-box-shadow: 0 0 20px #ccc;
}
a.toc_title, a.toc_title:visited {
display: block;
color: black;
font-weight: bold;
margin-top: 15px;
}
a.toc_title:hover {
text-decoration: underline;
}
#sidebar .version {
font-size: 10px;
font-weight: normal;
}
ul.toc_section {
font-size: 11px;
line-height: 14px;
margin: 5px 0 0 0;
padding-left: 0px;
list-style-type: none;
font-family: Lucida Grande;
}
.toc_section li {
cursor: pointer;
margin: 0 0 3px 0;
}
.toc_section li a {
text-decoration: none;
color: black;
}
.toc_section li a:hover {
text-decoration: underline;
}
div.container {
width: 550px;
margin: 40px 0 50px 260px;
}
img#logo {
width: 396px;
height: 69px;
}
div.warning {
margin-top: 15px;
font: bold 11px Arial;
color: #770000;
}
p {
margin: 20px 0;
width: 550px;
}
a, a:visited {
color: #444;
}
a:active, a:hover {
color: #000;
}
h1, h2, h3, h4, h5, h6 {
padding-top: 20px;
}
h2 {
font-size: 20px;
}
b.header {
font-size: 16px;
line-height: 30px;
}
span.alias {
font-size: 14px;
font-style: italic;
margin-left: 20px;
}
table, tr, td {
margin: 0; padding: 0;
}
td {
padding: 2px 12px 2px 0;
}
table .rule {
height: 1px;
background: #ccc;
margin: 5px 0;
}
ul {
list-style-type: circle;
padding: 0 0 0 20px;
}
li {
margin-bottom: 10px;
}
code, pre, tt {
font-family: Monaco, Consolas, "Lucida Console", monospace;
font-size: 12px;
line-height: 18px;
font-style: normal;
}
tt {
padding: 0px 3px;
background: #fff;
border: 1px solid #ddd;
zoom: 1;
}
code {
margin-left: 20px;
}
pre {
font-size: 12px;
padding: 2px 0 2px 15px;
border-left: 5px solid #bbb;
margin: 0px 0 30px;
}
@media only screen and (-webkit-min-device-pixel-ratio: 1.5) and (max-width: 640px),
only screen and (-o-min-device-pixel-ratio: 3/2) and (max-width: 640px),
only screen and (min-device-pixel-ratio: 1.5) and (max-width: 640px) {
img {
max-width: 100%;
}
div#sidebar {
-webkit-overflow-scrolling: initial;
position: relative;
width: 90%;
height: 120px;
left: 0;
top: -7px;
padding: 10px 0 10px 30px;
border: 0;
}
img#logo {
width: auto;
height: auto;
}
div.container {
margin: 0;
width: 100%;
}
p, div.container ul {
max-width: 98%;
overflow-x: scroll;
}
pre {
overflow: scroll;
}
}
</style>
</head>
<body>
<div id="sidebar" class="interface">
<a class="toc_title" href="#">
Underscore.js <span class="version">(1.7.0)</span>
</a>
<ul class="toc_section">
<li>» <a href="https://github.com/jashkenas/underscore">GitHub Repository</a></li>
<li>» <a href="docs/underscore.html">Annotated Source</a></li>
<li>» <a href="http://documentcloud.github.io/underscore-contrib/">Underscore-contrib</a></li>
</ul>
<a class="toc_title" href="#">
介绍
</a>
<a class="toc_title" href="#collections">
集合(Collections)
</a>
<ul class="toc_section">
<li>- <a href="#each">each</a></li>
<li>- <a href="#map">map</a></li>
<li>- <a href="#reduce">reduce</a></li>
<li>- <a href="#reduceRight">reduceRight</a></li>
<li>- <a href="#find">find</a></li>
<li>- <a href="#filter">filter</a></li>
<li>- <a href="#where">where</a></li>
<li>- <a href="#findWhere">findWhere</a></li>
<li>- <a href="#reject">reject</a></li>
<li>- <a href="#every">every</a></li>
<li>- <a href="#some">some</a></li>
<li>- <a href="#contains">contains</a></li>
<li>- <a href="#invoke">invoke</a></li>
<li>- <a href="#pluck">pluck</a></li>
<li>- <a href="#max">max</a></li>
<li>- <a href="#min">min</a></li>
<li>- <a href="#sortBy">sortBy</a></li>
<li>- <a href="#groupBy">groupBy</a></li>
<li>- <a href="#indexBy">indexBy</a></li>
<li>- <a href="#countBy">countBy</a></li>
<li>- <a href="#shuffle">shuffle</a></li>
<li>- <a href="#sample">sample</a></li>
<li>- <a href="#toArray">toArray</a></li>
<li>- <a href="#size">size</a></li>
<li>- <a href="#partition">partition</a></li>
</ul>
<a class="toc_title" href="#arrays">
数组(Arrays)
</a>
<ul class="toc_section">
<li>- <a href="#first">first</a></li>
<li>- <a href="#initial">initial</a></li>
<li>- <a href="#last">last</a></li>
<li>- <a href="#rest">rest</a></li>
<li>- <a href="#compact">compact</a></li>
<li>- <a href="#flatten">flatten</a></li>
<li>- <a href="#without">without</a></li>
<li>- <a href="#union">union</a></li>
<li>- <a href="#intersection">intersection</a></li>
<li>- <a href="#difference">difference</a></li>
<li>- <a href="#uniq">uniq</a></li>
<li>- <a href="#zip">zip</a></li>
<li>- <a href="#object">object</a></li>
<li>- <a href="#indexOf">indexOf</a></li>
<li>- <a href="#lastIndexOf">lastIndexOf</a></li>
<li>- <a href="#sortedIndex">sortedIndex</a></li>
<li>- <a href="#range">range</a></li>
</ul>
<a class="toc_title" href="#functions">
函数(Functions)
</a>
<ul class="toc_section">
<li>- <a href="#bind">bind</a></li>
<li>- <a href="#bindAll">bindAll</a></li>
<li>- <a href="#partial">partial</a></li>
<li>- <a href="#memoize">memoize</a></li>
<li>- <a href="#delay">delay</a></li>
<li>- <a href="#defer">defer</a></li>
<li>- <a href="#throttle">throttle</a></li>
<li>- <a href="#debounce">debounce</a></li>
<li>- <a href="#once">once</a></li>
<li>- <a href="#after">after</a></li>
<li>- <a href="#before">before</a></li>
<li>- <a href="#wrap">wrap</a></li>
<li>- <a href="#negate">negate</a></li>
<li>- <a href="#compose">compose</a></li>
</ul>
<a class="toc_title" href="#objects">
对象(Objects)
</a>
<ul class="toc_section">
<li>- <a href="#keys">keys</a></li>
<li>- <a href="#values">values</a></li>
<li>- <a href="#pairs">pairs</a></li>
<li>- <a href="#invert">invert</a></li>
<li>- <a href="#object-functions">functions</a></li>
<li>- <a href="#extend">extend</a></li>
<li>- <a href="#pick">pick</a></li>
<li>- <a href="#omit">omit</a></li>
<li>- <a href="#defaults">defaults</a></li>
<li>- <a href="#clone">clone</a></li>
<li>- <a href="#tap">tap</a></li>
<li>- <a href="#has">has</a></li>
<li>- <a href="#matches">matches</a></li>
<li>- <a href="#property">property</a></li>
<li>- <a href="#isEqual">isEqual</a></li>
<li>- <a href="#isEmpty">isEmpty</a></li>
<li>- <a href="#isElement">isElement</a></li>
<li>- <a href="#isArray">isArray</a></li>
<li>- <a href="#isObject">isObject</a></li>
<li>- <a href="#isArguments">isArguments</a></li>
<li>- <a href="#isFunction">isFunction</a></li>
<li>- <a href="#isString">isString</a></li>
<li>- <a href="#isNumber">isNumber</a></li>
<li>- <a href="#isFinite">isFinite</a></li>
<li>- <a href="#isBoolean">isBoolean</a></li>
<li>- <a href="#isDate">isDate</a></li>
<li>- <a href="#isRegExp">isRegExp</a></li>
<li>- <a href="#isNaN">isNaN</a></li>
<li>- <a href="#isNull">isNull</a></li>
<li>- <a href="#isUndefined">isUndefined</a></li>
</ul>
<a class="toc_title" href="#utility">
实用功能(Utility)
</a>
<ul class="toc_section">
<li>- <a href="#noConflict">noConflict</a></li>
<li>- <a href="#identity">identity</a></li>
<li>- <a href="#constant">constant</a></li>
<li>- <a href="#noop">noop</a></li>
<li>- <a href="#times">times</a></li>
<li>- <a href="#random">random</a></li>
<li>- <a href="#mixin">mixin</a></li>
<li>- <a href="#iteratee">iteratee</a></li>
<li>- <a href="#uniqueId">uniqueId</a></li>
<li>- <a href="#escape">escape</a></li>
<li>- <a href="#unescape">unescape</a></li>
<li>- <a href="#result">result</a></li>
<li>- <a href="#now">now</a></li>
<li>- <a href="#template">template</a></li>
</ul>
<a class="toc_title" href="#chaining">
链式语法(Chaining)
</a>
<ul class="toc_section">
<li>- <a href="#chain">chain</a></li>
<li>- <a href="#value">value</a></li>
</ul>
<a class="toc_title" href="#links">
更多链接
</a>
<a class="toc_title" href="#changelog">
更新日志
</a>
</div>
<div class="container">
<p id="introduction">
<img id="logo" src="docs/images/underscore.png" alt="Underscore.js" />
</p>
<p>
<a href="http://github.com/jashkenas/underscore/">Underscore</a> 是一个JavaScript实用库,提供了类似<a href="http://prototypejs.org/api">Prototype.js</a>
(或 <a href="http://www.ruby-doc.org/core/classes/Enumerable.html">Ruby</a>)的一些功能,但是没有继承任何JavaScript内置对象。它弥补了部分<a href="http://docs.jquery.com">jQuery</a>没有实现的功能,同时又是<a href="http://backbonejs.org">Backbone.js</a>必不可少的部分。
</p>
<p>
Underscore提供了80多个函数,包括常用的: <b>map</b>, <b>select</b>, <b>invoke</b> — 当然还有更多专业的辅助函数,如:函数绑定, JavaScript模板功能, 强类型相等测试, 等等. 在新的浏览器中, 有许多函数如果浏览器本身直接支持,将会采用原生的,如 <b>forEach</b>, <b>map</b>, <b>reduce</b>,
<b>filter</b>, <b>every</b>, <b>some</b> 和 <b>indexOf</b>.
</p>
<p>
一个完整的 <a href="test/">测试评分</a>
可以给您更详细的对比.
</p>
<p>
您也可以阅读 <a href="docs/underscore.html">带注释的源码</a>.
</p>
<p>
此项目
<a href="http://github.com/jashkenas/underscore/">在GitHub托管</a>.
您可以在
<a href="http://github.com/jashkenas/underscore/issues">issues页面</a>报告Bug或者讨论功能,
或者 Freenode 上的 <tt>#documentcloud</tt> 频道,
或者发推到 <a href="http://twitter.com/documentcloud">@documentcloud</a>.
</p>
<p>
<i>Underscore 是一个<a href="http://documentcloud.org/">DocumentCloud</a>的开源组件.</i>
</p>
<h2>下载 <i style="padding-left: 12px; font-size:12px;">(右键单击, 选择 "另存为")</i></h2>
<table>
<tr>
<td><a href="underscore.js">开发版 (1.7.0)</a></td>
<td><i>46kb, 未压缩版, 含大量注释</i></td>
</tr>
<tr>
<td><a href="underscore-min.js">生产版 (1.7.0)</a></td>
<td>
<i>5.2kb, 最简化并用Gzip压缩</i>
<small>(<a href="underscore-min.map">Source Map</a>)</small>
</td>
</tr>
<tr>
<td colspan="2"><div class="rule"></div></td>
</tr>
<tr>
<td><a href="https://raw.github.com/jashkenas/underscore/master/underscore.js">不稳定版</a></td>
<td><i>未发布版本, 当前开发中的 <tt>master</tt> 分支, 如果实用此版本, 风险自负</i></td>
</tr>
</table>
<h2>Installation</h2>
<ul>
<li>
<b>Node.js</b> <tt>npm install underscore</tt>
</li>
<li>
<b>Require.js</b> <tt>require(["underscore"], ...</tt>
</li>
<li>
<b>Bower</b> <tt>bower install underscore</tt>
</li>
<li>
<b>Component</b> <tt>component install jashkenas/underscore</tt>
</li>
</ul>
<div id="documentation">
<h2 id="collections">集合函数 (数组或对象)</h2>
<p id="each">
<b class="header">each</b><code>_.each(list, iterator, [context])</code>
<span class="alias">别名: <b>forEach</b></span>
<br />
对一个 <b>list</b> 的所有元素进行迭代, 对每一个元素执行 <b>iterator</b>
函数. <b>iterator</b> 和 <b>context</b> 对象绑定, 如果传了这个参数. 每次 <b>iterator</b> 的调用将会带有三个参数:
<tt>(element, index, list)</tt>. 如果 <b>list</b> 是一个 JavaScript 对象, <b>iterator</b> 的参数将会是 <tt>(value, key, list)</tt>. 如果有原生的 <b>forEach</b> 函数就会用原生的代替.
</p>
<pre>
_.each([1, 2, 3], alert);
=> 依次alert每个数字...
_.each({one: 1, two: 2, three: 3}, alert);
=> 依此alert每个数字...</pre>
<p>
<i>
Note: Collection functions work on arrays, objects, and
array-like objects such as</i> <tt>arguments</tt>, <tt>NodeList</tt><i>
and similar. But it works by duck-typing, so avoid passing objects with
a numeric <tt>length</tt> property. It's also good to note that an
<tt>each</tt> loop cannot be broken out of — to break, use <b>_.find</b>
instead.
</i>
</p>
<p id="map">
<b class="header">map</b><code>_.map(list, iterator, [context])</code>
<span class="alias">别名: <b>collect</b></span>
<br />
映射 <b>list</b> 里的每一个值, 通过一个转换函数(<b>iterator</b>)产生一个新的数组. 如果有原生的 <b>map</b> 函数, 将用之代替. 如果 <b>list</b> 是一个 JavaScript 对象,
<b>iterator</b>的参数将会是 <tt>(value, key, list)</tt>.
</p>
<pre>
_.map([1, 2, 3], function(num){ return num * 3; });
=> [3, 6, 9]
_.map({one: 1, two: 2, three: 3}, function(num, key){ return num * 3; });
=> [3, 6, 9]</pre>
<p id="reduce">
<b class="header">reduce</b><code>_.reduce(list, iterator, memo, [context])</code>
<span class="alias">别名: <b>inject, foldl</b></span>
<br />
也被称为 <b>inject</b> 和 <b>foldl</b>, <b>reduce</b> 将一个
<b>list</b> 里的所有值归结到一个单独的数值. <b>Memo</b> 是归结的初始值, 而且每一步都由
<b>iterator</b>返回. 迭代器 iterator 会传入四个参数: <tt>memo</tt>,
<tt>value</tt> 和迭代的索引<tt>index</tt> (或 key),
最后还有对整个 <tt>list</tt> 的一个引用.
</p>
<pre>
var sum = _.reduce([1, 2, 3], function(memo, num){ return memo + num; }, 0);
=> 6
</pre>
<p id="reduceRight">
<b class="header">reduceRight</b><code>_.reduceRight(list, iterator, memo, [context])</code>
<span class="alias">别名: <b>foldr</b></span>
<br />
<b>reduce</b>的右结合版本. 如果可能, 将调用
JavaScript 1.8 版本原生的 <b>reduceRight</b>. <b>Foldr</b>
在 JavaScript 中并没那么有用, 人们对它的评价并不好.
</p>
<pre>
var list = [[0, 1], [2, 3], [4, 5]];
var flat = _.reduceRight(list, function(a, b) { return a.concat(b); }, []);
=> [4, 5, 2, 3, 0, 1]
</pre>
<p id="find">
<b class="header">find</b><code>_.find(list, iterator, [context])</code>
<span class="alias">别名: <b>detect</b></span>
<br />
在 <b>list</b> 里的每一项进行查找, 返回第一个符合
测试(<b>iterator</b>)条件的元素. 此函数只返回第一个符合条件的元素, 并不会遍历整个list.
</p>
<pre>
var even = _.find([1, 2, 3, 4, 5, 6], function(num){ return num % 2 == 0; });
=> 2
</pre>
<p id="filter">
<b class="header">filter</b><code>_.filter(list, iterator, [context])</code>
<span class="alias">别名: <b>select</b></span>
<br />
在 <b>list</b> 里的每一项进行查找, 返回一个符合测试 (<b>iterator</b>) 条件的所有元素的集合. 如果存在原生的 <b>filter</b> 方法, 将采用原生的.
</p>
<pre>
var evens = _.filter([1, 2, 3, 4, 5, 6], function(num){ return num % 2 == 0; });
=> [2, 4, 6]
</pre>
<p id="where">
<b class="header">where</b><code>_.where(list, properties)</code>
<br />
遍历 <b>list</b> 里的每一个值, 返回包含 <b>properties</b> 里所有
key-value 组合的对象的数组.
</p>
<pre>
_.where(listOfPlays, {author: "Shakespeare", year: 1611});
=> [{title: "Cymbeline", author: "Shakespeare", year: 1611},
{title: "The Tempest", author: "Shakespeare", year: 1611}]
</pre>
<p id="findWhere">
<b class="header">findWhere</b><code>_.findWhere(list, properties)</code>
<br />
Looks through the <b>list</b> and returns the <i>first</i> value that matches
all of the key-value pairs listed in <b>properties</b>.
</p>
<p>
If no match is found, or if <b>list</b> is empty, <i>undefined</i> will be
returned.
</p>
<pre>
_.findWhere(publicServicePulitzers, {newsroom: "The New York Times"});
=> {year: 1918, newsroom: "The New York Times",
reason: "For its public service in publishing in full so many official reports,
documents and speeches by European statesmen relating to the progress and
conduct of the war."}
</pre>
<p id="reject">
<b class="header">reject</b><code>_.reject(list, iterator, [context])</code>
<br />
返回在 <b>list</b> 不能通过测试 (<b>iterator</b>) 的所有元素的集合. 与 <b>filter</b> 相反.
</p>
<pre>
var odds = _.reject([1, 2, 3, 4, 5, 6], function(num){ return num % 2 == 0; });
=> [1, 3, 5]
</pre>
<p id="every">
<b class="header">every</b><code>_.every(list, [iterator], [context])</code>
<span class="alias">别名: <b>all</b></span>
<br />
如果所有在 <b>list</b> 里的元素通过了 <b>iterator</b> 的测试, 返回 <i>true</i>.
如果存在则使用原生的 <b>every</b> 方法.
</p>
<pre>
_.every([true, 1, null, 'yes'], _.identity);
=> false
</pre>
<p id="some">
<b class="header">some</b><code>_.some(list, [iterator], [context])</code>
<span class="alias">别名: <b>any</b></span>
<br />
如果任何 <b>list</b> 里的任何一个元素通过了 <b>iterator</b> 的测试, 将返回 <i>true</i>.
一旦找到了符合条件的元素, 就直接中断对list的遍历. 如果存在, 将会使用原生的 <b>some</b> 方法.
</p>
<pre>
_.some([null, 0, 'yes', false]);
=> true
</pre>
<p id="contains">
<b class="header">contains</b><code>_.contains(list, value)</code>
<span class="alias">别名: <b>include</b></span>
<br />
如果 <b>value</b> 存在与 <b>list</b> 里, 返回 <i>true</i>.
如果 <b>list</b> 是一个数组, 内部会使用 <b>indexOf</b>.
</p>
<pre>
_.contains([1, 2, 3], 3);
=> true
</pre>
<p id="invoke">
<b class="header">invoke</b><code>_.invoke(list, methodName, [*arguments])</code>
<br />
在 <b>list</b> 里的每个元素上调用名为 <b>methodName</b> 的函数.
任何附加的函数传入, <b>invoke</b> 将会转给要调用的函数.
</p>
<pre>
_.invoke([[5, 1, 7], [3, 2, 1]], 'sort');
=> [[1, 5, 7], [1, 2, 3]]
</pre>
<p id="pluck">
<b class="header">pluck</b><code>_.pluck(list, propertyName)</code>
<br />
一个 <b>map</b> 通常用法的简便版本: 提取一个集合里指定的属性值.
</p>
<pre>
var stooges = [{name: 'moe', age: 40}, {name: 'larry', age: 50}, {name: 'curly', age: 60}];
_.pluck(stooges, 'name');
=> ["moe", "larry", "curly"]
</pre>
<p id="max">
<b class="header">max</b><code>_.max(list, [iterator], [context])</code>
<br />
返回 <b>list</b> 里最大的元素. 如果传入了 <b>iterator</b>,
它将用来比较每个值.
</p>
<pre>
var stooges = [{name: 'moe', age: 40}, {name: 'larry', age: 50}, {name: 'curly', age: 60}];
_.max(stooges, function(stooge){ return stooge.age; });
=> {name: 'curly', age: 60};
</pre>
<p id="min">
<b class="header">min</b><code>_.min(list, [iterator], [context])</code>
<br />
返回 <b>list</b> 里最小的元素. 如果传入了 <b>iterator</b>,
它将用来比较每个值.
</p>
<pre>
var numbers = [10, 5, 100, 2, 1000];
_.min(numbers);
=> 2
</pre>
<p id="sortBy">
<b class="header">sortBy</b><code>_.sortBy(list, iterator, [context])</code>
<br />
返回一个经过排序的 <b>list</b> 副本, 用升序排列 <b>iterator</b> 返回的值.
迭代器也可以用字符串的属性来进行比较(如<tt>length</tt>).
</p>
<pre>
_.sortBy([1, 2, 3, 4, 5, 6], function(num){ return Math.sin(num); });
=> [5, 4, 6, 3, 1, 2]
</pre>
<p id="groupBy">
<b class="header">groupBy</b><code>_.groupBy(list, iterator)</code>
<br />
把一个集合分为多个集合, 通过 <b>iterator</b> 返回的结果进行分组. 如果 <b>iterator</b>
是一个字符串而不是函数, 那么将使用 <b>iterator</b> 作为各元素的属性名来对比进行分组.
</p>
<pre>
_.groupBy([1.3, 2.1, 2.4], function(num){ return Math.floor(num); });
=> {1: [1.3], 2: [2.1, 2.4]}
_.groupBy(['one', 'two', 'three'], 'length');
=> {3: ["one", "two"], 5: ["three"]}
</pre>
<p id="indexBy">
<b class="header">indexBy</b><code>_.indexBy(list, iteratee, [context])</code>
<br />
Given a <b>list</b>, and an <b>iteratee</b> function that returns a
key for each element in the list (or a property name),
returns an object with an index of each item.
Just like <a href="#groupBy">groupBy</a>, but for when you know your
keys are unique.
</p>
<pre>
var stooges = [{name: 'moe', age: 40}, {name: 'larry', age: 50}, {name: 'curly', age: 60}];
_.indexBy(stooges, 'age');
=> {
"40": {name: 'moe', age: 40},
"50": {name: 'larry', age: 50},
"60": {name: 'curly', age: 60}
}
</pre>
<p id="countBy">
<b class="header">countBy</b><code>_.countBy(list, iterator)</code>
<br />
把一个数组分组并返回每一组内对象个数.
与 <tt>groupBy</tt> 相似, 但不是返回一组值,
而是组内对象的个数.
</p>
<pre>
_.countBy([1, 2, 3, 4, 5], function(num) {
return num % 2 == 0 ? 'even': 'odd';
});
=> {odd: 3, even: 2}
</pre>
<p id="shuffle">
<b class="header">shuffle</b><code>_.shuffle(list)</code>
<br />
返回一个随机乱序的 <b>list</b> 副本, 使用
<a href="http://en.wikipedia.org/wiki/Fisher%E2%80%93Yates_shuffle">Fisher-Yates shuffle</a> 来进行随机乱序.
</p>
<pre>
_.shuffle([1, 2, 3, 4, 5, 6]);
=> [4, 1, 6, 3, 5, 2]
</pre>
<p id="sample">
<b class="header">sample</b><code>_.sample(list, [n])</code>
<br />
从 <b>list</b> 里进行随机取样. 传一个数字 <b>n</b> 来决定返回的样本个数,
否则只返回一个样本.
</p>
<pre>
_.sample([1, 2, 3, 4, 5, 6]);
=> 4
_.sample([1, 2, 3, 4, 5, 6], 3);
=> [1, 6, 2]
</pre>
<p id="toArray">
<b class="header">toArray</b><code>_.toArray(list)</code>
<br />
将一个 <b>list</b> (任何可以被进行迭代的对象)转换成一个数组. 在转换 <b>arguments</b> 对象时非常有用.
</p>
<pre>
(function(){ return _.toArray(arguments).slice(1); })(1, 2, 3, 4);
=> [2, 3, 4]
</pre>
<p id="size">
<b class="header">size</b><code>_.size(list)</code>
<br />
返回 <b>list</b> 里所有元素的个数.
</p>
<pre>
_.size({one: 1, two: 2, three: 3});
=> 3
</pre>
<p id="partition">
<b class="header">partition</b><code>_.partition(array, predicate)</code>
<br />
Split <b>array</b> into two arrays: one whose elements all satisfy
<b>predicate</b> and one whose elements all do not satisfy <b>predicate</b>.
</p>
<pre>
_.partition([0, 1, 2, 3, 4, 5], isOdd);
=> [[1, 3, 5], [0, 2, 4]]
</pre>
<h2 id="arrays">Array Functions</h2>
<p>
<i>
注意: 所有数组函数都可以用在 <b>arguments</b> 对象上.
然而, Underscore 函数的设计并不只是针对稀疏数组的.
</i>
</p>
<p id="first">
<b class="header">first</b><code>_.first(array, [n])</code>
<span class="alias">别名: <b>head</b>, <b>take</b></span>
<br />
返回数组 <b>array</b> 里的第一个元素. 如果传了参数 <b>n</b>
将返回数组里前 <b>n</b> 个元素.
</p>
<pre>
_.first([5, 4, 3, 2, 1]);
=> 5
</pre>
<p id="initial">
<b class="header">initial</b><code>_.initial(array, [n])</code>
<br />
返回一个数组里除了最后一个元素以外的所有元素. 在arguments对象上特别有用.
传参 <b>n</b> 将排除数组最后的 <b>n</b> 个元素.
</p>
<pre>
_.initial([5, 4, 3, 2, 1]);
=> [5, 4, 3, 2]
</pre>
<p id="last">
<b class="header">last</b><code>_.last(array, [n])</code>
<br />
返回数组 <b>array</b> 里的最后一个元素. 传参 <b>n</b> 将返回
数组里的后 <b>n</b> 个元素.
</p>
<pre>
_.last([5, 4, 3, 2, 1]);
=> 1
</pre>
<p id="rest">
<b class="header">rest</b><code>_.rest(array, [index])</code>
<span class="alias">别名: <b>tail, drop</b></span>
<br />
返回一个数组里除了第一个以外 <b>剩余的</b> 所有元素. 传参 <b>index</b>
将返回除了第 <b>index</b> 个元素以外剩余的所有元素.
</p>
<pre>
_.rest([5, 4, 3, 2, 1]);
=> [4, 3, 2, 1]
</pre>
<p id="compact">
<b class="header">compact</b><code>_.compact(array)</code>
<br />
返回一个数组 <b>array</b> 除空(真值检验为false)后的副本.
在JavaScript里, <i>false</i>, <i>null</i>, <i>0</i>, <i>""</i>,
<i>undefined</i> 和 <i>NaN</i> 真值检验的结果都为false.
</p>
<pre>
_.compact([0, 1, false, 2, '', 3]);
=> [1, 2, 3]
</pre>
<p id="flatten">
<b class="header">flatten</b><code>_.flatten(array, [shallow])</code>
<br />
将一个嵌套多层的数组 <b>array</b> (嵌套可以是任何层数)转换为只有一层的数组.
如果传参 <b>shallow</b> 为true, 数组只转换第一层.
</p>
<pre>
_.flatten([1, [2], [3, [[4]]]]);
=> [1, 2, 3, 4];
_.flatten([1, [2], [3, [[4]]]], true);
=> [1, 2, 3, [[4]]];
</pre>
<p id="without">
<b class="header">without</b><code>_.without(array, [*values])</code>
<br />
返回一个除去所有 <b>values</b> 后的 <b>array</b> 副本.
</p>
<pre>
_.without([1, 2, 1, 0, 3, 1, 4], 0, 1);
=> [2, 3, 4]
</pre>
<p id="union">
<b class="header">union</b><code>_.union(*arrays)</code>
<br />
返回传入的多个数组 <b>arrays</b> 结合后的数组: 且所有数组元素都是唯一的,
传入的数组可以是一个或多个数组 <b>arrays</b>.
</p>
<pre>
_.union([1, 2, 3], [101, 2, 1, 10], [2, 1]);
=> [1, 2, 3, 101, 10]
</pre>
<p id="intersection">
<b class="header">intersection</b><code>_.intersection(*arrays)</code>
<br />
返回一个多个数组 <b>arrays</b> 的交集.
即返回的数组里每个元素, 都存在于参数 <b>arrays</b> 每个数组里.
</p>
<pre>
_.intersection([1, 2, 3], [101, 2, 1, 10], [2, 1]);
=> [1, 2]
</pre>
<p id="difference">
<b class="header">difference</b><code>_.difference(array, *others)</code>
<br />
跟 <b>without</b> 相似, 但是返回的数组是 <b>array</b> 里跟别的数组 <b>other</b> 里不一样的元素.
</p>
<pre>
_.difference([1, 2, 3, 4, 5], [5, 2, 10]);
=> [1, 3, 4]
</pre>
<p id="uniq">
<b class="header">uniq</b><code>_.uniq(array, [isSorted], [iterator])</code>
<span class="alias">别名: <b>unique</b></span>
<br />
返回 <b>array</b> 去重后的副本, 使用 <i>===</i> 做相等测试.
如果您确定 <b>array</b> 已经排序,
给 <b>isSorted</b> 参数传如 <i>true</i>, 此函数将使用更快的算法.
如果要处理对象元素, 传参 <b>iterator</b> 来获取要对比的属性.
</p>
<pre>
_.uniq([1, 2, 1, 3, 1, 4]);
=> [1, 2, 3, 4]
</pre>
<p id="zip">
<b class="header">zip</b><code>_.zip(*arrays)</code>
<br />
合并 <b>arrays</b> 里每一个数组的每个元素, 并保留对应位置.
在合并分开保存的数据时很有用. 如果你用来处理矩阵嵌套数组时,
<b>zip.apply</b> 可以做类似的效果.
</p>
<pre>
_.zip(['moe', 'larry', 'curly'], [30, 40, 50], [true, false, false]);
=> [["moe", 30, true], ["larry", 40, false], ["curly", 50, false]]
_.zip.apply(_, arrayOfRowsOfData);
=> arrayOfColumnsOfData
</pre>
<p id="object">
<b class="header">object</b><code>_.object(list, [values])</code>
<br />
把数组转换成对象. 传一个或多个
<tt>[key, value]</tt> 形式的数组,
或者一个包含key的数组和一个包含value的数组.
</p>
<pre>
_.object(['moe', 'larry', 'curly'], [30, 40, 50]);
=> {moe: 30, larry: 40, curly: 50}
_.object([['moe', 30], ['larry', 40], ['curly', 50]]);
=> {moe: 30, larry: 40, curly: 50}
</pre>
<p id="indexOf">
<b class="header">indexOf</b><code>_.indexOf(array, value, [isSorted])</code>
<br />
返回元素 <b>value</b> 在数组 <b>array</b> 里的索引位置,
如果元素没在数组 <b>array</b> 中, 将返回 <i>-1</i>. 此函数将使用原生的 <b>indexOf</b> 方法, 除非原生的方法无故消失或者被覆盖重写了, 才使用非原生的.
如果您要处理一个大型数组, 而且确定数组已经排序, 参数 <b>isSorted</b> 可以传 <tt>true</tt>, 函数将使用更快的二进制搜索来进行处理... 或者, 传一个数字作为
第三个参数, 以便于在指定索引之后开始寻找对应值.
</p>
<pre>
_.indexOf([1, 2, 3], 2);
=> 1
</pre>
<p id="lastIndexOf">
<b class="header">lastIndexOf</b><code>_.lastIndexOf(array, value, [fromIndex])</code>
<br />
返回元素 <b>value</b> 在数组 <b>arrry</b> 里最后一次出现的索引位置,
如果元素没在数组 <b>array</b> 中, 将返回 <i>-1</i>.
如有可能, 此函数将使用原生的 <b>lastIndexOf</b> 方法. 传参 <b>fromIndex</b> 以便从指定索引开始寻找.
</p>
<pre>
_.lastIndexOf([1, 2, 3, 1, 2, 3], 2);
=> 4
</pre>
<p id="sortedIndex">
<b class="header">sortedIndex</b><code>_.sortedIndex(list, value, [iterator])</code>
<br />
为了保持 <b>list</b> 已经排好的顺序, 使用二进制搜索来检测 <b>value</b>
<i>应该</i> 插入到 <b>list</b> 里的所在位置的索引.
如果传入了一个 <b>iterator</b> , 它将用来计算每个值的排名, 包括所传的 <b>value</b> 参数.
</p>
<pre>
_.sortedIndex([10, 20, 30, 40, 50], 35);
=> 3
var stooges = [{name: 'moe', age: 40}, {name: 'curly', age: 60}];
_.sortedIndex(stooges, {name: 'larry', age: 50}, 'age');
=> 1
</pre>
<p id="range">
<b class="header">range</b><code>_.range([start], stop, [step])</code>
<br />
一个灵活创建范围内整数数组的函数,
<tt>each</tt> 和 <tt>map</tt> 循环整合的简便版本. 如果省略<b>start</b> 参数, 默认为 <i>0</i>; <b>step</b> 默认为 <i>1</i>. 返回一个数组, 包含从 <b>start</b> 到 <b>stop</b> (不包含<b>stop</b>) 范围内, 以 <b>step</b> 递增(减)的整数.
</p>
<pre>
_.range(10);
=> [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
_.range(1, 11);
=> [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
_.range(0, 30, 5);
=> [0, 5, 10, 15, 20, 25]
_.range(0, -10, -1);
=> [0, -1, -2, -3, -4, -5, -6, -7, -8, -9]
_.range(0);
=> []
</pre>
<h2 id="functions">与函数有关的函数</h2>
<p id="bind">
<b class="header">bind</b><code>_.bind(function, object, [*arguments])</code>
<br />
绑定函数 <b>function</b> 到对象 <b>object</b> 上,
也就是无论何时函数被调用, 函数里的 <i>this</i> 都指向 <b>object</b>.
可选参数 <b>arguments</b> 可以绑定到函数 <b>function</b> , 可以填充函数所需要的参数,
这也被成为 <b>部分应用</b>.
</p>
<pre>
var func = function(greeting){ return greeting + ': ' + this.name };
func = _.bind(func, {name: 'moe'}, 'hi');
func();
=> 'hi: moe'
</pre>
<p id="bindAll">
<b class="header">bindAll</b><code>_.bindAll(object, [*methodNames])</code>
<br />
绑定 <b>methodNames</b> 指定的方法到 <b>object</b> 上, 当这些方法被执行时将在对象的上下文执行. 绑定函数用作事件处理时非常方便, 否则函数调用时
<i>this</i> 关键字根本没什么用. 如果不传 <b>methodNames</b> 参数, 对象里的所有方法都被绑定.
</p>