cyclist

What is cyclist?

The cyclist npm package is a utility for managing a fixed size cyclic list, also known as a ring buffer. It is particularly useful in scenarios where a fixed number of items need to be stored and managed efficiently, such as in systems or applications where memory management is critical and older entries are overwritten by new ones once the buffer is full.

What are cyclist's main functionalities?

Create and manage a cyclic list

This feature allows the creation of a cyclic list with a specified size. You can add items to the list at specific indices and retrieve them. When the index is reused, the old value is overwritten with the new value.

const Cyclist = require('cyclist');
const buffer = new Cyclist(3);
buffer.put(0, 'a');
buffer.put(1, 'b');
buffer.put(2, 'c');
console.log(buffer.get(1)); // Output: 'b'
buffer.put(1, 'd');
console.log(buffer.get(1)); // Output: 'd'

Other packages similar to cyclist

ringbufferjs

RingBufferJS is another npm package that provides similar functionality to cyclist. It allows for the creation and management of ring buffers. Compared to cyclist, RingBufferJS might offer different methods for interacting with the buffer, but the core concept of a fixed-size, overwritable buffer remains the same.

circular-buffer

Circular-buffer is an npm package that also implements a circular buffer mechanism. It provides functionality similar to cyclist but may include additional features such as different methods for buffer manipulation and retrieval. It's useful for comparing how different packages implement similar data structures.

README

Cyclist

Cyclist is an efficient cyclic list implemention for Javascript. It is available through npm

npm install cyclist

What?

Cyclist allows you to create a list of fixed size that is cyclic. In a cyclist list the element following the last one is the first one. This property can be really useful when for example trying to order data packets that can arrive out of order over a network stream.

Usage

var cyclist = require('cyclist')
var list = cyclist(4)

list.put(42, 'hello 42') // store something and index 42
list.put(43, 'hello 43') // store something and index 43

console.log(list.get(42)) // prints hello 42
console.log(list.get(46)) // prints hello 42 again since 46 - 42 == list.size

API

• cyclist(size) creates a new buffer
• cyclist#get(index) get an object stored in the buffer
• cyclist#put(index,value) insert an object into the buffer
• cyclist#del(index) delete an object from an index
• cyclist#size property containing current size of buffer

License

MIT