Give eachr an item to iterate (array, object or map) and an iterator, then in return eachr gives iterator the value and key of each item, and will stop if the iterator returned false.
- Install:
npm install --save eachr
- Require:
require('eachr')
<script type="module">
import * as pkg from '//dev.jspm.io/eachr'
</script>
This package is published with the following editions:
-
eachr
aliaseseachr/source/index.js
-
eachr/source/index.js
is esnext source code with require for modules -
eachr/edition-browsers/index.js
is esnext compiled for browsers with require for modules
Eachr accepts an array, object, or map. The iterator is bound to the list, and receives three arguments: the value, key, and list.
// Prepare
const eachr = require('eachr')
const arr = ['first', 'second', 'third']
const obj = {a: 'first', b: 'second', c: 'third'}
const map = new Map([['a', 'first'], ['b', 'second'], ['c', 'third']])
function iterator (value, key) {
console.log({value: value, key: key})
if ( value === 'second' ) {
console.log('break')
return false
}
}
// Cycle Array
eachr(arr, iterator)
// {'value': 'first', 'key': 0}
// {'value': 'second', 'key': 1}
// break
// Cycle Object
eachr(obj, iterator)
// {'value': 'first', 'key': 'a'}
// {'value': 'second', 'key': 'b'}
// break
// Cycle Map
eachr(map, iterator)
// {'value': 'first', 'key': 'a'}
// {'value': 'second', 'key': 'b'}
// break
Discover the release history by heading on over to the HISTORY.md
file.
Discover how you can contribute by heading on over to the CONTRIBUTING.md
file.
These amazing people are maintaining this project:
No sponsors yet! Will you be the first?
These amazing people have contributed code to this project:
- Benjamin Lupton — view contributions
- Sean Fridman
- Rob Loach — view contributions
- Sean Fridman — view contributions
- dependabot-preview[bot] — view contributions
Discover how you can contribute by heading on over to the CONTRIBUTING.md
file.
Unless stated otherwise all works are:
- Copyright © 2011+ Bevry Pty Ltd
and licensed under: