docs: added list of methods/properties

Author: tutinoko2048

ArrayDatabase.d.ts

@@ -18,8 +18,8 @@ export declare class ArrayDatabase<T = any> {
     some(callbackfn: (value: T) => boolean): boolean;
     every(callbackfn: (value: T) => boolean): boolean;
     [Symbol.iterator](): IterableIterator<T>;
-    private trySave;
     get size(): number;
+    private trySave;
     private load;
     private unload;
     private get keyPrefix();

ArrayDatabase.js

@@ -90,6 +90,9 @@ export class ArrayDatabase {
     [Symbol.iterator]() {
         return this.values();
     }
+    get size() {
+        return this.cache.reduce((acc, arr) => acc + arr.length, 0);
+    }
     trySave(values, swap = []) {
         let sizeOK = true;
         const stringified = JSON.stringify(values);
@@ -114,9 +117,6 @@ export class ArrayDatabase {
             this.trySave(swap);
         }
     }
-    get size() {
-        return this.cache.reduce((acc, arr) => acc + arr.length, 0);
-    }
     load() {
         this.currentKeyIndex = world.getDynamicProperty(this.indexKey) ?? 0;
         const keys = world.getDynamicPropertyIds();

ArrayDatabase.ts

@@ -25,12 +25,12 @@ export class ArrayDatabase<T = any> {
     return this;
   }
 
-  public has(value: T) {
+  public has(value: T): boolean {
     const locations = this.getAll();
     return locations.includes(value);
   }
 
-  public clear() {
+  public clear(): void {
     const keys = world.getDynamicPropertyIds();
     const prefix = this.keyPrefix;
     for (const key of keys) {
@@ -97,6 +97,10 @@ export class ArrayDatabase<T = any> {
     return this.values();
   }
 
+  public get size(): number {
+    return this.cache.reduce((acc, arr) => acc + arr.length, 0);
+  }
+
   private trySave(values: T[], swap: T[] = []) {
     let sizeOK = true;
     const stringified = JSON.stringify(values);
@@ -120,10 +124,6 @@ export class ArrayDatabase<T = any> {
     }
   }
 
-  public get size(): number {
-    return this.cache.reduce((acc, arr) => acc + arr.length, 0);
-  }
-
    private load() {
     this.currentKeyIndex = world.getDynamicProperty(this.indexKey) as number ?? 0;
     const keys = world.getDynamicPropertyIds();
@@ -160,7 +160,7 @@ export class ArrayDatabase<T = any> {
   private get indexKey(): string {
     return `${ArrayDatabase.PREFIX}:index_${this.id}` as string;
   }
-  
+
   public get [Symbol.toStringTag](): string {
     return this.id;
   }

README.md

@@ -9,7 +9,7 @@ const db = new ArrayDatabase('test');
 
 db.put('hello');
 db.put('world');
-db.get(); // ["hello", "world"]
+db.getAll(); // ["hello", "world"]
 db.has('hello'); // true
 db.clear();
 db.size; // 0
@@ -21,9 +21,26 @@ const db = new ArrayDatabase<Vector3>('test');
 
 db.put({ x: 0, y: 0, z: 0 });
 db.put({ x: 1, y: 1, z: 1 });
-db.get(); // [{ x: 0, y: 0, z: 0 }, { x: 1, y: 1, z: 1 }]
+db.getAll(); // [{ x: 0, y: 0, z: 0 }, { x: 1, y: 1, z: 1 }]
 ```
 
+## Method/Properties
+- (template) `T`
+- `readonly id: string`
+- `get size(): number`
+- `getAll(): T[]`
+- `add(value: T): this`
+- `has(value: T): boolean`
+- `clear(): void`
+- `*values(): IterableIterator<T>`
+- `find(callbackfn: (value: T) => boolean): T | undefined`
+- `filter(callbackfn: (value: T) => boolean): T[]`
+- `map<U>(callbackfn: (value: T) => U): U[]`
+- `forEach(callbackfn: (value: T) => void): void`
+- `some(callbackfn: (value: T) => boolean): boolean`
+- `every(callbackfn: (value: T) => boolean): boolean`
+- `[Symbol.iterator](): IterableIterator<T>`
+
 ## Benchmark (put)
 ||x10|x100|
 |-|-|-|