each's Introduction

each

Array / object / string iteration utility.

Installation

$ component install component/each

API

each(array, fn[, ctx])

Iterate an array:

each([1,2,3], function(num, i){
  
})

Optionally pass a context object:

each([1,2,3], function(num, i){

}, this)

each(object, fn[, ctx])

Iterate an object's key / value pairs:

each(conf, function(key, val){
  
})

Iterate an array-ish object (has numeric .length):

each(collection, function(val, i){
  
})

each(string, fn[, ctx])

Iterate a string's characters:

each('hello', function(c, i){
  
})

License

MIT

each's People

Contributors

Stargazers

Watchers

each's Issues

Question on the order of callback parameters for iteration over object.

Hi,
I'm a bit wondering why the order of the parameters are kinda reversed on object iteration. If there's any reason why the order is in this way, it would be helpful if you can share your thoughts in order for me and potentially others to avoid relevant mistakes and such.

Currently when you iterate over object, you will get key, (or property name) as the first argument:

var conf = {
  fast: 1,
  normal: 0.5,
  slow: 0.3
};
each(conf, function(key, val){
  console.log(val, key); // => 1, "fast"... 
})

But if we consider key to be more like index, the following order is a bit more consistent compared to other types, where val is always passed as first argument.

var conf = {
  fast: 1,
  normal: 0.5,
  slow: 0.3
};
each(conf, function(val, key){
  console.log(val, key);  // => 1, "fast"... 
})

each("something", function(val, index){
  console.log(val, index)  // => "s", 0... 
})

each(['a', 'b', 'c'], function(val, index){
  console.log(val, index); // => "a", 0…
})

underscore.js and lodash.js are passing val in the first parameter:

var _ = require('underscore') // require('lodash');
var conf = {
  fast: 1,
  normal: 0.5,
  slow: 0.3
};
_.each(conf, function(val, key){
  console.log(val, key); // => 1, "fast"... 
})

component / each Goto Github PK