Package detail

eachr

bevry648.5kArtistic-2.07.4.0

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.

array, browser, cycle, deno

readme

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

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.4.0/edition-deno/index.ts'

Skypack

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

unpkg

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

jspm

<script type="module">
    import pkg from '//dev.jspm.io/eachr@7.4.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 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:

changelog

History

v7.4.0 2023 December 28

v7.3.0 2023 December 27

v7.2.0 2023 December 6

v7.1.0 2023 December 5

v7.0.0 2023 November 25

v6.6.0 2023 November 24

v6.5.0 2023 November 21

v6.4.0 2023 November 19

  • Updated dependencies, base files, and editions using boundation
  • Dropped need for semver dev dependency, as we no longer support Node.js versions <0.12 which is what it was needed for.

v6.3.0 2023 November 14

v6.2.0 2023 November 14

v6.1.0 2023 November 13

v6.0.0 2023 November 13

  • Updated dependencies, base files, and editions using boundation
  • Minimum required Node.js version changed from node: >=6 to node: >=4 adapting to ecosystem changes

v5.0.0 2023 November 13

  • Updated dependencies, base files, and editions using boundation
  • Minimum required Node.js version changed from node: >=8 to node: >=6 adapting to ecosystem changes

v4.6.0 2023 November 13

v4.5.0 2019 December 9

v4.4.0 2019 December 1

v4.3.0 2019 December 1

v4.2.0 2019 December 1

v4.1.0 2019 November 18

v4.0.0 2019 November 18

  • Updated dependencies, base files, and editions using boundation
  • Minimum required node version changed from node: >=0.10 to node: >=8 to keep up with mandatory ecosystem changes

v3.3.0 2019 November 13

v3.2.0 2016 May 27

v3.1.1 2016 January 15

  • Minimum supported node version changed from 0.12 to 0.10 - Although node 0.10 has broken Maps, so iterating Maps is not support for node 0.10
  • Minor performance improvement for iterating arrays

v3.1.0 2015 December 9

  • Updated internal conventions

v3.0.0 2015 September 21

  • Added support for maps
  • Specifically only support arrays, plain objects, and maps
  • Converted from CoffeeScript to ES6+

v2.0.4 2015 March 11

  • Updated dependencies

v2.0.3 2014 February 8th

  • Updated dependencies

v2.0.2 2013 March 29

  • Added missing typechecker dependency

v2.0.1 2013 March 29

  • Returns the subject instead of this

v2.0.0 2013 March 29