Mirrors/lodash
1
0
Fork 0
mirror of https://github.com/whoisclebs/lodash.git synced 2026-02-04 08:57:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixes #436 -- document the second argument to _.flatten

Browse Source
This commit is contained in:
Jeremy Ashkenas
2012-01-23 17:03:19 -05:00
parent d959c019f8
commit a8c956fe6a
1 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
index.html
View File

@@ -656,13 +656,17 @@ _.compact([0, 1, false, 2, '', 3]);
</pre>
<p id="flatten">
<b class="header">flatten</b><code>_.flatten(array)</code>
<b class="header">flatten</b><code>_.flatten(array, [shallow])</code>
<br />
Flattens a nested <b>array</b> (the nesting can be to any depth).
Flattens a nested <b>array</b> (the nesting can be to any depth). If you
pass <b>shallow</b>, the array will only be flattened a single level.
</p>
<pre>
_.flatten([1, [2], [3, [[[4]]]]]);
_.flatten([1, [2], [3, [[4]]]]);
=&gt; [1, 2, 3, 4];
_.flatten([1, [2], [3, [[4]]]], true);
=&gt; [1, 2, 3, [[4]]];
</pre>
<p id="without">