Skip to content

xchscan/ring-buffer-ts

 
 

Repository files navigation

Ring Buffer

Aka "circular buffer" written in TypeScript

  • Well tested.
  • Documentation (included declaration types and doc-comments).
  • Clean and modern code.
  • Written in TypeScript (strict mode and strongly typed).
  • Easy API.
  • High performance when adding items.
  • No dependencies.
  • NodeJS, Browser.
  • Tiny size.

Missing feature? Note that you can export and import the buffer as array and you can do what ever you want with the array. You can also consider to create an issue here and pull-request to add features.

Install

npm i ring-buffer-ts

NPM Package

Usage

import { RingBuffer } from 'ring-buffer-ts';

const ringBuffer = new RingBuffer<number>(5);
ringBuffer.add(1);
ringBuffer.add(2, 3);
ringBuffer.add(4, 5, 6);

console.log(ringBuffer.toArray());
// Result: [2, 3, 4, 5, 6]

Documentation

About

A circular array buffer written in modern TypeScript.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 95.8%
  • JavaScript 4.2%