doc: merge and update old docs for Enumerable#collect

This commit is contained in:
tjcrowder 2009-09-07 14:09:44 +01:00 committed by Tobie Langel
parent 061321d17c
commit f1c8c1e266
1 changed files with 19 additions and 2 deletions

View File

@ -193,9 +193,26 @@ var Enumerable = (function() {
/**
* Enumerable#collect([iterator = Prototype.K[, context]]) -> Array
* - iterator (Function): The iterator function to apply to each element
* in the enumeration.
* - context (Object): An optional object to use as `this` within
* calls to the iterator.
*
* Returns the results of applying the iterator to each element.
* Aliased as [[Enumerable#map]].
* Returns the result of applying `iterator` to each element. If no
* `iterator` is provided, the elements are simply copied to the
* result array.
*
* ### Examples
*
* ['Hitch', "Hiker's", 'Guide', 'to', 'the', 'Galaxy'].collect(function(s) {
* return s.charAt(0).toUpperCase();
* })
* // -> ['H', 'H', 'G', 'T', 'T', 'G']
*
* $R(1,5).collect(function(n) {
* return n * n;
* })
* // -> [1, 4, 9, 16, 25]
**/
function collect(iterator, context) {
iterator = iterator || Prototype.K;