circlearray

1.2.1 • Public • Published

circlearray

stable

A circle(loop) array structure!

var CircleArray = require('circlearray');
 
var circle = new CircleArray();
 
circle.add({value: 1});
circle.add({value: 2});
circle.add({value: 3});
 

Methods

 
// You can define the circle array sending a param with a regular array. 
var circle = new CircleArray([{value: 1}, {value: 2}, {value: 3}, {value: 4}]);
 
circle.currentElement(); // this return the current element, by default is the element in the position 0
circle.prev(); // This return element in position 4
circle.prev(); // This return element in position 3
circle.next(); // This return element in position 4
circle.next(); // This return element in position 1
circle.isEmpty(); // false
  
  
var circle2 = new CircleArray(2);
circle2.size(); // This return 0
circle2.add({value: 1});
circle2.size(); // This return 1
circle2.add({value: 2});
circle2.size(); // This return 2
 
// You can add in a position.
circle2.addInPosition(element, position);
 
//Remove elements!!
circle2.remove('key', 'value');
 
// Or if its contains no objects like [1,2,3,4,5];
circle2.remove(2);
 

Usage

NPM

Package Sidebar

Install

npm i circlearray

Weekly Downloads

2

Version

1.2.1

License

ISC

Last publish

Collaborators

  • mbfassnacht