A simple circular array buffer
npm install circle-bufferA simple circular array buffer (also known as a ring buffer) for efficient management of string data in JavaScript/TypeScript.
This simple module is designed to manage a fixed-size buffer efficiently, with the ability to
overwrite old data with new data as it arrives. This is useful in scenarios where memory usage
needs to be constant and predictable, such as in real-time data processing, streaming applications,
or when handling continuous data streams like logs, sensor data, or network packets.
``bash`
npm install circle-buffer --save
`javascript
import { CircularBuffer } from 'circle-buffer';
// Create a circular buffer with a limit of 5
const buffer = new CircularBuffer({ limit: 5 });
// Add values to the buffer
buffer.forward('A');
buffer.forward('B');
buffer.forward('C');
buffer.forward('D');
buffer.forward('E');
// Get the current state of the buffer
buffer.current(); // Output: 'ABCDE'
// Rewind the buffer
buffer.rewind();
// Get the updated buffer state
buffer.current(); // Output: 'ABCD'
// Get the buffer value at the specified position using index
buffer.get(1); // Output: 'B'
// Get the buffer value at the specified range using index and length
buffer.range(0,2); // Output: 'AB'
// Reset the buffer
buffer.reset();
// Get the buffer state after reset
buffer.current(); // Output: ''
`
#### Constructor
- new CircularBuffer(options: { limit: number }): CircularBuffer
Creates a new instance of the CircularBuffer class with the specified limit.
- options.limit: The maximum number of elements the circular buffer can hold.
#### Methods
- current(): string
Returns the current state of the buffer.
- get(index: number): string
Returns the content at the specific position in the buffer.
- index: The index position in the buffer.
- range(start: number, length: number): string
Returns the content at the specific range in the buffer.
- start: The starting position in the buffer.length
- : The length of the range to fetch.
- reset(): void
Resets the buffer by filling it with empty strings.
- forward(value: string): void
Moves the buffer forward by one position, adding the provided value at the end of the buffer. If the buffer is full, the oldest value is removed.
- value: The string value to be added to the buffer.
- rewind(): void`
Moves the buffer backward by one position, removing the last value. If the buffer becomes empty, an empty string is added at the beginning.
Suitable for various use cases involving the management of circular buffers that exclusively store strings or characters. Some potential use cases include:
1. Input History in a Console or Terminal:
- Maintain a history of user inputs with a fixed size.
2. Text Animation:
- Create scrolling text displays or text-based animations.
3. Textual Undo/Redo Functionality:
- Implement undo and redo functionality for changes made to a string.
4. Rotating Text Displays:
- Display a rotating set of messages or information.
5. Logging Recent Events:
- Log recent events in a string format within a fixed-size buffer.
6. String History in Interactive Applications:
- Manage a history of user inputs or actions involving strings.
7. String-based Sliding Windows:
- Process a stream of string data and keep track of recent strings.
8. Fixed-Size String Buffer in Resource-Constrained Environments:
- Manage string data efficiently in resource-constrained environments.
This project is licensed under the MIT License - see the LICENSE file for details.