0.0.1 • Published 5 years ago

step-through-array v0.0.1

Weekly downloads
2
License
MIT
Repository
github
Last release
5 years ago

Step through array

Build Status codecov Known Vulnerabilities npm.io

simple function that returns the next, or previous array value based on the passed in value. It will return to the begining when it hits the end of the array.

Usage

Standard forwards and backwards

	import stepThroughArray from 'step-through-array' 

		or common JS require

	const stepThroughArray = require('step-through-array' )

	let current = 'tigers'
	const array = ['tigers', 'bears', 'lions']
	const reverse = false // optional passing true will step backwards

	current = stepThroughArray(current, array, reverse)

	// current === 'bears'

	current = stepThroughArray(current, array, reverse)
	// current === 'lions'

Looping

If the next value is undefined it will return to the beginning or the end respectively.