refactor: cleanup utils export

[e-mobility-charging-stations-simulator.git] / src / utils / CircularArray.ts

diff --git a/src/utils/CircularArray.ts b/src/utils/CircularArray.ts
index bd768673605021a31aaf498278f0d50db6a8fa41..f84b21aa3ac9d93a19075b8db1a2f889e05bdfa9 100644 (file)
--- a/src/utils/CircularArray.ts
+++ b/src/utils/CircularArray.ts
@@ -1,96 +1,96 @@
-// Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
+// Copyright Jerome Benoit. 2021-2024. All Rights Reserved.
 
-const DEFAULT_CIRCULAR_ARRAY_SIZE = 1024;
+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;
+  public size: number
 
-  constructor(size: number = DEFAULT_CIRCULAR_ARRAY_SIZE, ...items: T[]) {
-    super();
-    this.checkSize(size);
-    this.size = size;
+  constructor (size: number = DEFAULT_CIRCULAR_ARRAY_SIZE, ...items: T[]) {
+    super()
+    this.checkSize(size)
+    this.size = size
     if (arguments.length > 1) {
-      this.push(...items);
+      this.push(...items)
     }
   }
 
-  public push(...items: T[]): number {
-    const length = super.push(...items);
+  public push (...items: T[]): number {
+    const length = super.push(...items)
     if (length > this.size) {
-      super.splice(0, length - this.size);
+      super.splice(0, length - this.size)
     }
-    return this.length;
+    return this.length
   }
 
-  public unshift(...items: T[]): number {
-    const length = super.unshift(...items);
+  public unshift (...items: T[]): number {
+    const length = super.unshift(...items)
     if (length > this.size) {
-      super.splice(this.size, items.length);
+      super.splice(this.size, items.length)
     }
-    return this.length;
+    return this.length
   }
 
-  public concat(...items: (T | ConcatArray<T>)[]): CircularArray<T> {
-    const concatenatedCircularArray = super.concat(items as T[]) as CircularArray<T>;
-    concatenatedCircularArray.size = this.size;
+  public concat (...items: Array<T | ConcatArray<T>>): 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;
+    return concatenatedCircularArray
   }
 
-  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);
+  public splice (start: number, deleteCount?: number, ...items: T[]): CircularArray<T> {
+    let itemsRemoved: T[] = []
+    if (arguments.length >= 3 && deleteCount != null) {
+      itemsRemoved = super.splice(start, deleteCount, ...items)
       if (this.length > this.size) {
-        const itemsOverflowing = super.splice(0, this.length - this.size);
+        const itemsOverflowing = super.splice(0, this.length - this.size)
         itemsRemoved = new CircularArray<T>(
           itemsRemoved.length + itemsOverflowing.length,
           ...itemsRemoved,
-          ...itemsOverflowing,
-        );
+          ...itemsOverflowing
+        )
       }
     } else if (arguments.length === 2) {
-      itemsRemoved = super.splice(start, deleteCount);
+      itemsRemoved = super.splice(start, deleteCount)
     } else {
-      itemsRemoved = super.splice(start);
+      itemsRemoved = super.splice(start)
     }
-    return itemsRemoved as CircularArray<T>;
+    return itemsRemoved as CircularArray<T>
   }
 
-  public resize(size: number): void {
-    this.checkSize(size);
+  public resize (size: number): void {
+    this.checkSize(size)
     if (size === 0) {
-      this.length = 0;
+      this.length = 0
     } else if (size < this.size) {
       for (let i = size; i < this.size; i++) {
-        super.pop();
+        super.pop()
       }
     }
-    this.size = size;
+    this.size = size
   }
 
-  public empty(): boolean {
-    return this.length === 0;
+  public empty (): boolean {
+    return this.length === 0
   }
 
-  public full(): boolean {
-    return this.length === this.size;
+  public full (): boolean {
+    return this.length === this.size
   }
 
-  private checkSize(size: number): void {
+  private checkSize (size: number): void {
     if (!Number.isSafeInteger(size)) {
-      throw new TypeError(`Invalid circular array size: ${size} is not a safe integer`);
+      throw new TypeError(`Invalid circular array size: ${size} is not a safe integer`)
     }
     if (size < 0) {
-      throw new RangeError(`Invalid circular array size: ${size} < 0`);
+      throw new RangeError(`Invalid circular array size: ${size} < 0`)
     }
   }
 }