doc: update docs for Enumerable#each.

This commit is contained in:
tjcrowder 2009-09-07 14:33:18 +01:00 committed by Tobie Langel
parent 23ebc851b1
commit 45d7e79f4b
1 changed files with 13 additions and 0 deletions

View File

@ -92,6 +92,19 @@ var Enumerable = (function() {
* the keyword `this` means inside `iterator`.
*
* Calls `iterator` for each item in the collection.
*
* ### Examples
*
* ['one', 'two', 'three'].each(alert);
* // Alerts "one", then alerts "two", then alerts "three"
*
* ### Built-In Variants
*
* Most of the common use cases for `each` are already available pre-coded
* as other methods on `Enumerable`. Whether you want to find the first
* matching item in an enumeration, or transform it, or determine whether it
* has any (or all) values matching a particular condition, `Enumerable`
* has a method to do that for you.
**/
function each(iterator, context) {
var index = 0;