forked from jashkenas/underscore
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index-cn.html
2867 lines (2586 loc) · 118 KB
/
index-cn.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://underscorejs.org/" />
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon" />
<script src="http://code.jquery.com/jquery-1.11.0.min.js"></script>
<title>Underscore.js(1.8.2) 中文文档</title>
<style>
body {
font-size: 14px;
line-height: 22px;
background: #f4f4f4 url(docs/images/background.png);
color: #000;
font-family: Helvetica Neue, Helvetica, Arial;
}
i{font-style: normal;color:#f66;font-size: small;}
.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: 728px;
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: 728px;
}
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.8.2)</span>
</a>
<ul class="toc_section">
<li>» <a href="https://github.com/jashkenas/underscore">GitHub 仓库</a></li>
<li>» <a href="docs/underscore.html">有注释的源代码</a></li>
<li>» <a href="http://documentcloud.github.io/underscore-contrib/">Underscore-contrib</a></li>
</ul>
<a class="toc_title" href="#">
介绍(Introduction)
</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="#unzip">unzip</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="#findIndex">findIndex</a></li>
<li>- <a href="#findLastIndex">findLastIndex</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="#allKeys">allKeys</a></li>
<li>- <a href="#values">values</a></li>
<li>- <a href="#mapObject">mapObject</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="#findKey">findKey</a></li>
<li>- <a href="#extend">extend</a></li>
<li>- <a href="#extendOwn">extendOwn</a></li>
<li>- <a href="#create">create</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="#matcher">matcher</a></li>
<li>- <a href="#property">property</a></li>
<li>- <a href="#propertyOf">propertyOf</a></li>
<li>- <a href="#isEqual">isEqual</a></li>
<li>- <a href="#isMatch">isMatch</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">
更多链接(Links)
</a>
<a class="toc_title" href="#changelog">
更新日志(Change Log)
</a>
</div>
<div class="container">
<p id="introduction">
<img id="logo" src="docs/images/underscore.png" alt="Underscore.js" />
</p>
<p>如果您有任何建议,或者拍砖,欢迎在微博上<a href="http://weibo.com/148246293" target="_blank">@愚人码头</a> 联系我。</p>
<iframe style="vertical-align: middle;" width="163" height="24" frameborder="0"
allowtransparency="true" marginwidth="0" marginheight="0" scrolling="no" border="0"
src="http://widget.weibo.com/relationship/followbutton.php?language=zh_cn&width=63&height=24&uid=1477178352&style=2&btn=red&dpc=1"></iframe>
<p>本文档为Underscore.js (1.8.2) 中文文档,<br>
查看1.7.0版本的文档请点击:<a href="http://www.css88.com/doc/underscore1.7.0" target="_blank">http://www.css88.com/doc/underscore1.7.0/</a>
<br>
查看1.6.0版本的文档请点击:<a href="http://www.css88.com/doc/underscore1.6.0" target="_blank">http://www.css88.com/doc/underscore1.6.0/</a>
<br>
查看1.5.2版本的文档请点击:<a href="http://www.css88.com/doc/underscore1.5.2" target="_blank">http://www.css88.com/doc/underscore1.5.2/</a></p>
<p>其他前端相关文档:<a href="http://www.css88.com/jqapi-1.9/" target="_blank">jQuery API中文文档</a> 、<a href="http://www.css88.com/jquery-ui-api/" target="_blank">jQuery UI API中文文档</a> 、<a href="http://www.css88.com/doc/zeptojs_api/" target="_blank">Zepto.js API 中文版</a></p>
<p>
<a href="http://github.com/jashkenas/underscore/">Underscore</a>一个JavaScript实用库,提供了一整套函数式编程的实用功能,但是没有扩展任何JavaScript内置对象。它是这个问题的答案:“如果我在一个空白的HTML页面前坐下, 并希望立即开始工作, 我需要什么?“...它弥补了部分<a href="http://docs.jquery.com">jQuery</a>没有实现的功能,同时又是<a href="http://backbonejs.org">Backbone.js</a>必不可少的部分。 (感谢<a href="http://weibo.com/xiaodengzidaj" target="_blank">@小邓子daj </a> 的翻译建议)
</p>
<p>
Underscore提供了100多个函数,包括常用的: <b>map</b>, <b>filter</b>, <b>invoke</b> — 当然还有更多专业的辅助函数,如:函数绑定, JavaScript模板功能,创建快速索引, 强类型相等测试, 等等.
</p>
<p>
为了你能仔细研读,这里包含了一个完整的<a href="test/">测试套件</a>。
</p>
<p>
您也可以通过<a href="docs/underscore.html">注释阅读源代码</a>。
</p>
<p>享受Underscore,并希望获得更多的使用功能(感谢<a href="http://weibo.com/bananajaward" target="_blank">@Jaward华仔</a> 的翻译建议),可以尝试使用<a href="http://documentcloud.github.io/underscore-contrib/">Underscore-contrib</a>(愚人码头注:Underscore-contrib是一个Underscore的代码贡献库)。
</p>
<p>
该项目代码<a href="http://github.com/documentcloud/underscore/">托管在GitHub</a>上,你可以通过<a href="http://github.com/documentcloud/underscore/issues">issues页</a>、Freenode的 <tt>#documentcloud</tt> 频道、发送tweets给<a href="http://twitter.com/documentcloud">@documentcloud</a>三个途径报告bug以及参与特性讨论。
</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.8.2)</a></td>
<td><i>51kb, 未压缩版, 含大量注释</i></td>
</tr>
<tr>
<td><a href="underscore-min.js">生产版 (1.8.2)</a></td>
<td>
<i>5.7kb, 最简化并用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>Meteor.js</b> <tt>meteor add 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>
<h2 id="collections">集合函数 (数组 或对象)</h2>
<p id="each">
<b class="header">each</b><code>_.each(list, iteratee, [context])</code>
<span class="alias">Alias: <b>forEach</b></span>
<br />
遍历<b>list</b>中的所有元素,按顺序用遍历输出每个元素。如果传递了<b>context</b>参数,则把<b>iteratee</b>绑定到<b>context</b>对象上。每次调用<b>iteratee</b>都会传递三个参数:<tt>(element, index, list)</tt>。如果<b>list</b>是个JavaScript对象,<b>iteratee</b>的参数是 <tt>(value, key, list)</tt>)。返回<b>list</b>以方便链式调用。(愚人码头注:如果存在原生的<b>forEach</b>方法,Underscore就使用它代替。)
</p>
<pre>
_.each([1, 2, 3], alert);
=> alerts each number in turn...
_.each({one: 1, two: 2, three: 3}, alert);
=> alerts each number value in turn...</pre>
<p>
<i>
注意:集合函数能在数组,对象,和类数组对象,比如</i><tt>arguments</tt>, <tt>NodeList</tt><i>和类似的数据类型上正常工作。 但是它通过<a href="http://zh.wikipedia.org/zh-cn/%E9%B8%AD%E5%AD%90%E7%B1%BB%E5%9E%8B" target="_blank">鸭子类型</a>工作,所以要避免传递一个不固定<tt>length</tt>属性的对象(愚人码头注:对象或数组的长度(length)属性要固定的)。每个循环不能被破坏 - 打破, 使用<b>_.find</b>代替,这也是很好的注意。
</i>
</p>
<p id="map">
<b class="header">map</b><code>_.map(list, iteratee, [context])</code>
<span class="alias">Alias: <b>collect</b></span>
<br />
通过转换函数(<b>iteratee</b>迭代器)映射列表中的每个值产生价值的新数组。<tt>iteratee</tt>传递三个参数:<tt>value</tt>,然后是迭代 <tt>index</tt>(或 <tt>key</tt> 愚人码头注:如果<b>list</b>是个JavaScript对象是,这个参数就是<tt>key</tt>),最后一个是引用指向整个<tt>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]
_.map([[1, 2], [3, 4]], _.first);
=> [1, 3]</pre>
<p id="reduce">
<b class="header">reduce</b><code>_.reduce(list, iteratee, [memo], [context])</code>
<span class="alias">Aliases: <b>inject, foldl</b></span>
<br />
别名为 <b>inject</b> 和 <b>foldl</b>, <b>reduce</b>方法把<b>list</b>中元素归结为一个单独的数值。<b>Memo</b>是reduce函数的初始值,reduce的每一步都需要由<b>iteratee</b>返回。这个迭代传递4个参数:<tt>memo</tt>,<tt>value</tt> 和 迭代的<tt>index</tt>(或者 key)和最后一个引用的整个 <tt>list</tt>。
</p>
<p>
如果没有<b>memo</b>传递给<b>reduce</b>的初始调用,<b>iteratee</b>不会被列表中的第一个元素调用。第一个元素将取代 传递给列表中下一个元素调用<b>iteratee</b>的<b>memo</b>参数。
</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, iteratee, memo, [context])</code>
<span class="alias">Alias: <b>foldr</b></span>
<br />
<b>reducRight</b>是从右侧开始组合的元素的<b>reduce</b>函数,如果存在JavaScript 1.8版本的<b>reduceRight</b>,则用其代替。<b>Foldr</b>在javascript中不像其它有懒计算的语言那么有用(愚人码头注:lazy evaluation:一种求值策略,只有当表达式的值真正需要时才对表达式进行计算)。
</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, predicate, [context])</code>
<span class="alias">Alias: <b>detect</b></span>
<br />
在<b>list</b>中逐项查找,返回第一个通过<b>predicate</b>迭代函数真值检测的元素值,如果没有值传递给测试迭代器将返回<code>undefined</code>。
如果找到匹配的元素,函数将立即返回,不会遍历整个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, predicate, [context])</code>
<span class="alias">Alias: <b>select</b></span>
<br />
遍历<b>list</b>中的每个值,返回包含所有通过<b>predicate</b>真值检测的元素值。(愚人码头注:如果存在原生<b>filter</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>所列出的属性的所有的 键 - 值对。
</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 />
遍历整个<b>list</b>,返回匹配 <b>properties</b>参数所列出的所有 键 - 值 对的第一个值。
</p>
<p>
如果没有找到匹配的属性,或者<b>list</b>是空的,那么将返回<i>undefined</i>。
</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, predicate, [context])</code>
<br />
返回<b>list</b>中没有通过<b>predicate</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, [predicate], [context])</code>
<span class="alias">Alias: <b>all</b></span>
<br />
如果<b>list</b>中的所有元素都通过<b>predicate</b>的真值检测就返回<i>true</i>。(愚人码头注:如果存在原生的<b>every</b>方法,就使用原生的<b>every</b>。)
</p>
<pre>
_.every([true, 1, null, 'yes'], _.identity);
=> false
</pre>
<p id="some">
<b class="header">some</b><code>_.some(list, [predicate], [context])</code>
<span class="alias">Alias: <b>any</b></span>
<br />
如果<b>list</b>中有任何一个元素通过 <b>predicate</b> 的真值检测就返回<i>true</i>。一旦找到了符合条件的元素, 就直接中断对list的遍历. (愚人码头注:如果存在原生的<b>some</b>方法,就使用原生的<b>some</b>。)
</p>
<pre>
_.some([null, 0, 'yes', false]);
=> true
</pre>
<p id="contains">
<b class="header">contains</b><code>_.contains(list, value, [fromIndex])</code>
<span class="alias">Alias: <b>includes</b></span>
<br />
如果<b>list</b>包含指定的<b>value</b>则返回<i>true</i>(愚人码头注:使用===检测)。如果<b>list</b> 是数组,内部使用<b>indexOf</b>判断。使用<b>fromIndex</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>的额外参数,<b>invoke</b>都会在调用<b>methodName</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>pluck</b>也许是<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, [iteratee], [context])</code>
<br />
返回<b>list</b>中的最大值。如果传递<b>iteratee</b>参数,<b>iteratee</b>将作为<b>list</b>中每个值的排序依据。如果<b>list</b>为空,将返回<i>-Infinity</i>,所以你可能需要事先用<a href="#isEmpty">isEmpty</a>检查 <b>list</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, [iteratee], [context])</code>
<br />
返回<b>list</b>中的最小值。如果传递<b>iteratee</b>参数,<b>iteratee</b>将作为<b>list</b>中每个值的排序依据。如果<b>list</b>为空,将返回<i>-Infinity</i>,所以你可能需要事先用<a href="#isEmpty">isEmpty</a>检查 <b>list</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, iteratee, [context])</code>
<br />
返回一个排序后的<b>list</b>拷贝副本。如果传递<b>iteratee</b>参数,<b>iteratee</b>将作为<b>list</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]
var stooges = [{name: 'moe', age: 40}, {name: 'larry', age: 50}, {name: 'curly', age: 60}];
_.sortBy(stooges, 'name');
=> [{name: 'curly', age: 60}, {name: 'larry', age: 50}, {name: 'moe', age: 40}];
</pre>
<p id="groupBy">
<b class="header">groupBy</b><code>_.groupBy(list, iteratee, [context])</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 />
给定一个<b>list</b>,和 一个用来返回一个在列表中的每个元素键 的<b>iterator</b> 函数(或属性名),
返回一个每一项索引的对象。和<a href="#groupBy">groupBy</a>非常像,但是当你知道你的键是唯一的时候可以使用<b>indexBy</b> 。
</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, iteratee, [context])</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>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 />
拆分一个数组(<b>array</b>)为两个数组:
第一个数组其元素都满足<b>predicate</b>迭代函数, 而第二个的所有元素均不能满足<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 函数的设计并不只是针对稀疏("sparse" )数组的.</i>
</p>
<p id="first">
<b class="header">first</b><code>_.first(array, [n])</code>
<span class="alias">Alias: <b>head</b>, <b>take</b></span>
<br />
返回<b>array(数组)</b>的第一个元素。传递 <b>n</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>个元素(愚人码头注:排除数组后面的 <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>个元素(愚人码头注:返回数组里的后面的<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">Alias: <b>tail, drop</b></span>
<br />
返回数组中除了第一个元素外的其他全部元素。传递 <b>index</b> 参数将返回从<b>index</b>开始的剩余所有元素 。(感谢<a href="http://weibo.com/heerake" target="_blank">@德德德德撸</a> 指出错误)
</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 />
返回一个除去所有<i>false</i>值的 <b>array</b>副本。
在javascript中, <i>false</i>, <i>null</i>, <i>0</i>, <i>""</i>,
<i>undefined</i> 和 <i>NaN</i> 都是<i>false</i>值.
</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>参数,数组将只减少一维的嵌套。
</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>副本。(愚人码头注:使用<i>===</i>表达式做相等测试。)
</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], [iteratee])</code>
<span class="alias">Alias: <b>unique</b></span>
<br />
返回 <b>array</b>去重后的副本, 使用 <i>===</i> 做相等测试. 如果您确定 <b>array</b> 已经排序, 那么给 <b>isSorted</b> 参数传递 <i>true</i>值, 此函数将运行的更快的算法. 如果要处理对象元素, 传递 <b>iteratee</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>中相应位置的值合并在一起。在合并分开保存的数据时很有用. 如果你用来处理矩阵嵌套数组时, <tt>_.zip.apply</tt> 可以做类似的效果。
</p>
<pre>
_.zip(['moe', 'larry', 'curly'], [30, 40, 50], [true, false, false]);
=> [["moe", 30, true], ["larry", 40, false], ["curly", 50, false]]
</pre>
<p id="unzip">
<b class="header">unzip</b><code>_.unzip(*arrays)</code>
<br>
与<a href="#zip">zip</a>功能相反的函数,给定若干<b>arrays</b>,返回一串联的新数组,其第一元素个包含所有的输入数组的第一元素,其第二包含了所有的第二元素,依此类推。通过<tt>apply</tt>用于传递数组的数组。
</p>
<pre>
_.unzip(["moe", 30, true], ["larry", 40, false], ["curly", 50, false]);
=> [['moe', 'larry', 'curly'], [30, 40, 50], [true, false, false]]
</pre>
<p id="object">
<b class="header">object</b><code>_.object(list, [values])</code>
<br />
将数组转换为对象。传递任何一个单独<tt>[key, value]</tt>对的列表,或者一个键的列表和一个值得列表。
如果存在重复键,最后一个值将被返回。
</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>value</b>不存在 <b>array</b>中就返回<i>-1</i>。使用原生的<b>indexOf</b> 函数,除非它失效。如果您正在使用一个大数组,你知道数组已经排序,传递<tt>true</tt>给<b>isSorted</b>将更快的用二进制搜索..,或者,传递一个数字作为第三个参数,为了在给定的索引的数组中寻找第一个匹配值。
</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>array</b> 中的从最后开始的索引值,如果<b>value</b>不存在 <b>array</b>中就返回<i>-1</i>。如果支持原生的<b>lastIndexOf</b>,将使用原生的<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, [iteratee], [context])</code>
<br />
使用二分查找确定<b>value</b>在<b>list</b>中的位置序号,<b>value</b>按此序号插入能保持<b>list</b>原有的排序。如果提供<b>iterator</b>函数,<b>iterator</b>将作为list排序的依据,包括你传递的<b>value</b> 。<b>iterator</b>也可以是字符串的属性名用来排序(比如<tt>length</tt>)。
</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="findIndex">
<b class="header">findIndex</b><code>_.findIndex(array, predicate, [context])</code>
<br />
类似于<a href="#indexOf"><tt>_.indexOf</tt></a>,当<strong>predicate</strong>通过真检查时,返回第一个索引值;否则返回<i>-1</i>。
</p>
<pre>
_.findIndex([4, 6, 8, 12], isPrime);
=> -1 // not found
_.findIndex([4, 6, 7, 12], isPrime);
=> 2
</pre>
<p id="findLastIndex">
<b class="header">findLastIndex</b><code>_.findLastIndex(array, predicate, [context])</code>
<br />
和<a href="#findIndex"><tt>_.findIndex</tt></a>类似,但反向迭代数组,当<strong>predicate</strong>通过真检查时,最接近末端的索引值将被返回。
</p>
<pre>
var users = [{'id': 1, 'name': 'Bob', 'last': 'Brown'},
{'id': 2, 'name': 'Ted', 'last': 'White'},
{'id': 3, 'name': 'Frank', 'last': 'James'},
{'id': 4, 'name': 'Ted', 'last': 'Jones'}];
_.findLastIndex(users, {
name: 'Ted'
});
=> 3
</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>step</b>来增加 (或减少)独占。值得注意的是,如果<b>stop</b>值在<b>start</b>前面(也就是<b>stop</b>值小于<b>start</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>