controlled-loop
v2.0.0
Published
A javascript module for moving forward, backward, and in a non-linear fashion through an array or object one or more keys at a time.
Downloads
2
Maintainers
Readme
controlledLoop
A javascript module for moving forward, backward, and in a non-linear fashion through an array or object one or more keys at a time.
Summary
Creating a controlled-loop allows you to move through an array or object in many different ways
- iterate similar to generators with
next()
- backup with
previous()
- run in bulk like a
forEach()
but with the ability to stop at any time - chunk or batch a group of items at a time
- iterate over every nth item
- iterate in reverse
- reverse direction mid-flow
- skip over items
- goto a specific
key
- Set your own
keys
array to only use a subset of properties or to set the order - change the callback at any time
### Homepage
http://www.ozonecreations.com/projects/controlled-loop
Installing
GitHub
https://github.com/bartmelton/ControlledLoop
NPM
npm install controlled-loop
Bower
bower install controlled-loop
Exports:
- It will export as an AMD module if available, otherwise it will try to export as a CommonJS module
- If Lodash or Underscore are available, it adds as a mixin.
- If none of the above options are available it falls back to a global
controlledLoop()
function attached to window, global, or this depending on which is available.
Node
var controlledLoop = require("controlled-loop").controlledLoop
Lodash/Underscore
_.controlledLoop()
Default
controlledLoop();