github-migration
/
prototype
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: port old Array#flatten docs and clarify

This commit is contained in:
tjcrowder 2009-09-07 12:20:55 +01:00 committed by Tobie Langel
parent a6dac432ac
commit 798a367a3d
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/lang/array.js
View File

@ -185,11 +185,20 @@ Array.from = $A;
/**
* Array#flatten() -> Array
* Returns a "flat" (one-dimensional) version of the array.
*
* Nested arrays are recursively injected "inline." This can prove very
* Returns a flattened (one-dimensional) copy of the array, leaving
* the original array unchanged.
*
* Nested arrays are recursively injected inline. This can prove very
* useful when handling the results of a recursive collection algorithm,
* for instance.
*
* ### Example
*
* var a = ['frank', ['bob', 'lisa'], ['jill', ['tom', 'sally']]];
* var b = a.flatten();
* // a -> ['frank', ['bob', 'lisa'], ['jill', ['tom', 'sally']]]
* // b -> ['frank', 'bob', 'lisa', 'jill', 'tom', 'sally']
**/
function flatten() {
return this.inject([], function(array, value) {