refactor: refine circular buffer API

Signed-off-by: Jérôme Benoit <[email protected]>

Author: jerome-benoit

src/circular-buffer.ts

@@ -28,6 +28,15 @@ export class CircularBuffer {
     this.items = new Float32Array(size)
   }
 
+  /**
+   * Clears the buffer.
+   */
+  public clear(): void {
+    this.readIdx = 0
+    this.writeIdx = 0
+    this.size = 0
+  }
+
   /**
    * Checks whether the buffer is empty.
    *

tests/circular-buffer.test.mjs

@@ -165,4 +165,20 @@ describe('Circular buffer test suite', () => {
     circularBuffer.put(6)
     expect(circularBuffer.toArray()).toStrictEqual([3, 4, 5, 6])
   })
+
+  it('Verify that circular buffer clear() works as intended', () => {
+    const circularBuffer = new CircularBuffer(4)
+    circularBuffer.put(1)
+    circularBuffer.put(2)
+    circularBuffer.put(3)
+    circularBuffer.put(4)
+    circularBuffer.put(5)
+    expect(circularBuffer.readIdx).toBe(1)
+    expect(circularBuffer.writeIdx).toBe(1)
+    expect(circularBuffer.size).toBe(4)
+    circularBuffer.clear()
+    expect(circularBuffer.readIdx).toBe(0)
+    expect(circularBuffer.writeIdx).toBe(0)
+    expect(circularBuffer.size).toBe(0)
+  })
 })