Skip to content

bevry/eachr

Repository files navigation

eachr

Status of the GitHub Workflow: bevry NPM version NPM downloads
GitHub Sponsors donate button ThanksDev donate button Patreon donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button
Discord server badge Twitch community badge

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

  • Install: npm install --save eachr
  • Import: import pkg from ('eachr')
  • Require: const pkg = require('eachr').default
import pkg from 'https://unpkg.com/eachr@^7.4.0/edition-deno/index.ts'
<script type="module">
    import pkg from '//cdn.skypack.dev/eachr@^7.4.0'
</script>
<script type="module">
    import pkg from '//unpkg.com/eachr@^7.4.0'
</script>
<script type="module">
    import pkg from '//dev.jspm.io/eachr@7.4.0'
</script>

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 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
  • eachr/edition-es5/index.js is TypeScript compiled against ES5 for Node.js 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
  • eachr/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 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.

Backers

Code

Discover how to contribute via the CONTRIBUTING.md file.

Authors

Maintainers

Contributors

Finances

GitHub Sponsors donate button ThanksDev donate button Patreon donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button

Sponsors

  • Andrew Nesbitt — Software engineer and researcher
  • Balsa — We're Balsa, and we're building tools for builders.
  • Codecov — Empower developers with tools to improve code quality and testing.
  • Poonacha Medappa
  • Rob Morris
  • Sentry — Real-time crash reporting for your web apps, mobile apps, and games.
  • Syntax — Syntax Podcast

Donors

License

Unless stated otherwise all works are:

and licensed under: