.jsdoc_config doc/Array.html doc/allclasses-frame.html doc/allclasses-noframe.html doc/help-doc.html doc/index-all.html doc/index.html doc/overview-summary-array.js.html doc/overview-summary.html doc/overview-tree.html doc/stylesheet.css @@ -1,2 +1,2 @@ -Array.prototype.collect=function(){var result=[];var block=arguments[arguments.length-1];this.each(function(item){result[result.length]=block(item);});return result;};Array.prototype.each=function(){var block=arguments[arguments.length-1];return this.eachWithIndex(block);};Array.prototype.eachWithIndex=function(){var block=arguments[arguments.length-1];for(var i=0;i<this.length;i+=1){block(this[i],i);} +Array.prototype.collect=function(block){var result=[];this.each(function(item){result[result.length]=block(item);});return result;};Array.prototype.each=function(block){return this.eachWithIndex(block);};Array.prototype.eachWithIndex=function(block){for(var i=0;i<this.length;i+=1){block(this[i],i);} return this;}; \ No newline at end of file array-min.js @@ -1,19 +1,84 @@ -Array.prototype.collect = function() { +/** + * @fileoverview + * Defines functions that extend the Array prototype such that it behaves like + * Ruby's Array class. + * + * @author Nils Jonsson <nils@alumni.rice.edu> + */ + +/** + * Invokes block once for each element in the array, passing that element as an + * argument. + * + * <pre> + * var array = ['foo', 'bar', 'baz']; + * var result = array.collect(function(item) { + * return item + '!'; + * }); + * result // => ['foo!', 'bar!', 'baz!'] + * array // => ['foo', 'bar', 'baz'] + * </pre> + * + * @param {Function} block The function to execute. Should have one parameter + * @returns An array containing the values returned by block + */ +Array.prototype.collect = function(block) { var result = []; - var block = arguments[arguments.length - 1]; this.each(function(item) { result[result.length] = block(item); }); return result; }; -Array.prototype.each = function() { - var block = arguments[arguments.length - 1]; +/** + * Invokes block once for each element in the array, passing that element as an + * argument. + * + * <pre> + * var array = ['foo', 'bar', 'baz']; + * array.each(function(item) { + * alert(item); + * }); + * </pre> + * + * opens three alert boxes: + * + * <ul> + * <li>foo</li> + * <li>bar</li> + * <li>baz</li> + * </ul> + * + * @param {Function} block The function to execute. Should have one parameter + * @returns The array + */ +Array.prototype.each = function(block) { return this.eachWithIndex(block); }; -Array.prototype.eachWithIndex = function() { - var block = arguments[arguments.length - 1]; +/** + * Invokes block once for each element in the array, passing that element and + * its index as arguments. + * + * <pre> + * var array = ['foo', 'bar', 'baz']; + * array.eachWithIndex(function(item, index) { + * alert(index + ': ' + item); + * }); + * </pre> + * + * opens three alert boxes: + * + * <ul> + * <li>0: foo</li> + * <li>1: bar</li> + * <li>2: baz</li> + * </ul> + * + * @param {Function} block The function to execute. Should have two parameters + * @returns The array + */ +Array.prototype.eachWithIndex = function(block) { for (var i = 0; i < this.length; i += 1) { block(this[i], i); } src/lib/array.js 630631702c5f38472436f4447637e8b08b60ba27 Nils Jonsson nils@alumni.rice.edu http://github.com/njonsson/rouge/commit/279f6a3026fa76e7a645ba8e27bdbc51cee3d999 279f6a3026fa76e7a645ba8e27bdbc51cee3d999 2009-02-04T21:07:06-08:00 2009-02-04T21:07:06-08:00 Add JSDoc documentation and switch to explicit block arguments for clarity 9323673b6e90cdf2a07418d4a9a38d49637b32c1 Nils Jonsson nils@alumni.rice.edu