angeldb/src/types/index.d.ts

AngelDB is a json database for nodejs

declare interface CakebaseProvider {
    /**
     * Add an object to the json file.
     * @param data the object.
     */
    set(data: object) : Promise<void>;

    /**
     * Retrieve for objects in the json file
     * @param prediciton the prediction to find the objects.
     */
    get(prediciton: void) : Promise<object[]>

    /**
     * Remove objects in the json file
     * @param prediciton the prediction to find the objects
     */
    remove(prediciton: void) : Promise<void>;

    /**
     * Update objects in the json file
     * @param prediciton the prediction to find the objects
     * @param data Data you want to edit or add
     */
    update(prediciton: void, data : object) : Promise<void>;

    /**
     * Delete all objects in the json file
     */
    clear() : Promise<void>;
}

/**
 * Cakebase is an asynchronous fast json database.
 * 
 * Initalize the json database.
 * @param root The json file path where our objects are stored.
 * 
 */
declare function _CakebaseInstance(root : string) : CakebaseProvider;

export = _CakebaseInstance;