circular_buffer_js
Typescript
implementation of a circular buffer, and JS compiles to a es6
module minified, es6 commonjs minified, es6 iife minified, and es6 iife full.
- Well tested.
- 100% coverage, 100% property coverage.
- Tiny.
- The
es6
minified module build is currently 1.4k.
- The
- Dependency-free.
- Only dev-time deps like
typescript
are involved.
- Only dev-time deps like
- Well tested. 100% coverage, 100% property coverage.
- Well tested. 100% coverage, 100% property coverage.
API
You should consider viewing the real documentation, but:
const cb = new circular_buffer<type>(size); // yields a buffer of fixed size `size`
cb.push(item); // inserts `item` at end of `cb`, then returns `item`
cb.pop(); // removes and returns first element
cb.at(location); // shows the element at 0-indexed offset `location`
cb.full(); // returns `true` if no space left, `false` otherwise
cb.empty(); // returns `true` if no space used, `false` otherwise
cb.available(); // returns the number of spaces remaining currently
cb.capacity(); // returns the total `size` allocated
cb.length(); // returns the amount of space currently used
What is this?
This is a circular buffer (or ring buffer, ring queue, etc.) It was written because a library I wanted to use had a native buggy implementation, so I provided something more trustworthy.
A circular buffer is a fixed size buffer that allows you to push and pop forever, as a first in first out queue-like structure. Circular buffers are more efficient than queues, but can overflow.
import { circular_buffer } from 'circular_buffer_js';
const cb = new circular_buffer(3);
cb.push(1); // ok
cb.push(2); // ok
cb.push(3); // ok
cb.at(0); // 1
cb.push(4); // throws - full!
cb.pop(); // 1
cb.at(0); // 2
cb.push(4); // ok
cb.push(5); // throws - full!
cb.pop(); // 2
cb.pop(); // 3
cb.pop(); // 4
cb.pop(); // throws - empty!
It's typescript, so you can also
const cb = new circular_buffer<number>(3);
And there's a commonjs build, so you can
const cbuf = require('circular_buffer_js'),
circular_buffer = cbuf.circular_buffer;
There're also two iife
builds - both regular and minified - so that you can use this in older browsers.
<script type="text/javascript" src="circular_buffer_js.min.js"></script>
Alternatives
If this doesn't meet your needs, please try: