tpatel / cycled

Cycle through the items of an array

cycled

Cycle through the items of an array

This package can be useful for cycling through tabs, images of a slideshows, etc.

Install

$ npm install cycled

Usage

const Cycled = require('cycled');

const cycled = new Cycled([1, 2, 3]);

cycled.current();
//=> 1

cycled.next();
//=> 2

cycled.next();
//=> 3

cycled.next();
//=> 1

cycled.previous();
//=> 3

API

cycled = new Cycled(input)

input

Type: Array

cycled

The instance is an iterable that will cycle through the array indefinitely.

current()

Returns the current item.

next()

Returns the next item.

previous()

Returns the previous item.

step(steps)

Returns the item by going the given amount of steps through the array. For example, calling steps(2) is like calling next() twice. You go backward by specifying a negative number.

size

Get the size.

index

Get or set the current index.

reversed()

Returns an iterable that will cycle through the array backward indefinitely.

indexOf()

Same as Array#indexOf().

License

MIT © Sindre Sorhus