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.

Usage

Complete API Documentation.

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

Install

npm

• Install: npm install --save eachr
• Import: import pkg from ('eachr')
• Require: const pkg = require('eachr').default

Deno

import pkg from 'https://unpkg.com/eachr@^7.2.0/edition-deno/index.ts'

Skypack

<script type="module">
    import pkg from '//cdn.skypack.dev/eachr@^7.2.0'
</script>

unpkg

<script type="module">
    import pkg from '//unpkg.com/eachr@^7.2.0'
</script>

jspm

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

Editions

This package is published with the following editions:

• eachr aliases eachr/index.cjs which uses the Editions Autoloader to automatically select the correct edition for the consumer's environment
• eachr/source/index.ts is TypeScript source code with Import for modules
• eachr/edition-browsers/index.js is TypeScript compiled against ES2022 for web browsers with Import for modules
• eachr/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js 21 with Require for modules
• eachr/edition-es5/index.js is TypeScript compiled against ES5 for Node.js 4 with Require for modules
• eachr/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js 21 with Import for modules
• eachr/edition-types/index.d.ts is TypeScript compiled Types with Import for modules
• eachr/edition-deno/index.ts is TypeScript source code made to be compatible with Deno

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

• Benjamin Lupton — view contributions

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Benjamin Lupton — view contributions
• Rob Loach — view contributions
• Sean Fridman
• Sean Fridman — view contributions

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

• Copyright © 2011+ Bevry Pty Ltd

and licensed under:

• Artistic License 2.0