Package Exports

eachr

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (eachr) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

eachr

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: npm install --save eachr
Require: require('eachr')

jspm

<script type="module">
    import * as pkg from '//dev.jspm.io/eachr'
</script>

Editions

This package is published with the following editions:

eachr aliases eachr/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

Usage

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