Class JSONDB

apps/node/src/modules/jsondb/jsondb.ts:11–243

import logger from '../utils/logger';

export class JSONDB<DocType extends JSONDocMeta> {
  static DB_PATH: string = "";
  /**
   * If there is too many docs in filesystem, we can use meta.json to store file metas for listing 
   */
  private metaDb!: Low<JSONCollectionMeta>;
  private docs: { [id: string]: Low<DocType>} = {};
  private dbName: string;
  private metaKeys: string[];
  updateEvent = new SlotEvent<JSONDBEvent>();

  constructor(dbName: string, metaKeys: string[]) {
    this.dbName = dbName;
    this.metaKeys = metaKeys
  }

  static serve = serve;

  /**
   * static method to create a db instance in a async way
   * @param dbName 
   * @returns 
   */
  static db = async <DocType extends JSONDocMeta>(dbName: string, metaKeys: string[]): Promise<JSONDB<DocType>> => {
    const db = new JSONDB<DocType>(dbName, metaKeys);
    await db.init();
    return db;
  }

  /**
   * define the db path
   * @param dbPath 
   * @returns 
   */
  static dir = (dbPath?: string): string => {
    if (dbPath) {
      JSONDB.DB_PATH = dbPath;
      fsExtra.ensureDirSync(dbPath);
    }
    return JSONDB.DB_PATH;
  }

  static exist = async (name: string): Promise<boolean> => {
    const dbPath = path.join(JSONDB.DB_PATH, name);
    return await fsExtra.pathExists(dbPath);
  }

  /**
   * init the db
   */
  init = async () => {
    try {
      // Initialize existing docs
      const docsDir = path.join(JSONDB.DB_PATH, this.dbName);

      await fsExtra.ensureDir(docsDir);
      
      const filePath = this.#docFilePath("meta");