refactor: use classic setter in configuration class
[e-mobility-charging-stations-simulator.git] / src / utils / CircularArray.ts
index 227165fb5ac50d775a72944ca6528973120a48ab..4fafe5280a78cd849667f94e12e7e198e16f2dc7 100644 (file)
@@ -1,5 +1,10 @@
-export const DEFAULT_CIRCULAR_ARRAY_SIZE = 2000;
+// Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
 
+export const DEFAULT_CIRCULAR_ARRAY_SIZE = 1024;
+
+/**
+ * Array with a maximum length and shifting items when full.
+ */
 export class CircularArray<T> extends Array<T> {
   public size: number;
 
@@ -29,31 +34,35 @@ export class CircularArray<T> extends Array<T> {
   }
 
   public concat(...items: (T | ConcatArray<T>)[]): CircularArray<T> {
-    const concatenatedCircularArray = super.concat(
-      items as T[]
-    ) as CircularArray<T>;
+    const concatenatedCircularArray = super.concat(items as T[]) as CircularArray<T>;
     concatenatedCircularArray.size = this.size;
     if (concatenatedCircularArray.length > concatenatedCircularArray.size) {
       concatenatedCircularArray.splice(
         0,
-        concatenatedCircularArray.length - concatenatedCircularArray.size
+        concatenatedCircularArray.length - concatenatedCircularArray.size,
       );
     }
     return concatenatedCircularArray;
   }
 
-  public splice(start: number, deleteCount?: number, ...items: T[]): T[] {
-    let itemsRemoved: T[];
-    if (arguments.length >= 3 && typeof deleteCount !== 'undefined') {
-      itemsRemoved = super.splice(start, deleteCount);
-      // FIXME: that makes the items insert not in place
-      this.push(...items);
+  public splice(start: number, deleteCount?: number, ...items: T[]): CircularArray<T> {
+    let itemsRemoved: T[] = [];
+    if (arguments.length >= 3 && deleteCount !== undefined) {
+      itemsRemoved = super.splice(start, deleteCount, ...items);
+      if (this.length > this.size) {
+        const itemsOverflowing = super.splice(0, this.length - this.size);
+        itemsRemoved = new CircularArray<T>(
+          itemsRemoved.length + itemsOverflowing.length,
+          ...itemsRemoved,
+          ...itemsOverflowing,
+        );
+      }
     } else if (arguments.length === 2) {
       itemsRemoved = super.splice(start, deleteCount);
     } else {
       itemsRemoved = super.splice(start);
     }
-    return itemsRemoved;
+    return itemsRemoved as CircularArray<T>;
   }
 
   public resize(size: number): void {
@@ -76,9 +85,12 @@ export class CircularArray<T> extends Array<T> {
     return this.length === this.size;
   }
 
-  private checkSize(size: number) {
+  private checkSize(size: number): void {
+    if (!Number.isSafeInteger(size)) {
+      throw new TypeError(`Invalid circular array size: ${size} is not a safe integer`);
+    }
     if (size < 0) {
-      throw new RangeError('Invalid circular array size');
+      throw new RangeError(`Invalid circular array size: ${size} < 0`);
     }
   }
 }