index.d.ts

declare module 'quick.db' {

    export interface Options {
        target?: string | null;
        table?: string;
    }

    export interface OptionsStartsWith extends Options {
        sort?: string;
        limit?: number;
    }

    export type ValueData = string | object | number | null | boolean | bigint | symbol | any[];

    export interface Many {
        key: string;
        value: ValueData;
    }

    /**
     * Package version. Community requested feature.
     * ```
     * const db = require("quick.db-prototypes")(require("quick.db"));
     * console.log(db.version);
     * ```
     */
    const version: string;

    /**
     * This function fetches data from a key in the database.
     * @param key Any string as a key. Also allows for dot notation following the key.
     * @param ops Any options to be added to the request.
     */
    function fetch(key: string, ops?: Options): any;

    /**
     * This function fetches data from a key in the database.
     * @param key Any string as a key. Also allows for dot notation following the key.
     * @param ops Any options to be added to the request.
     */
    function get(key: string, ops?: Options): any;

    /**
     * This function sets new data based on a key in the database. 
     * @param key Any string as a key. Also allows for dot notation following the key.
     * @param value Value to set.
     * @param ops Any options to be added to the request.
     */
    function set(key: string, value: ValueData, ops?: Options): any;

    /**
     * This method inserts multiple data at once
     * @param items Items to insert
     * @param ops Any options to be added to the request.
     */
    function setMany(items: Many[], ops?: Options): Many[];

    /**
     * This function adds a number to a key in the database. (If no existing number, it will add to 0)
     * @param key Any string as a key. Also allows for dot notation following the key.
     * @param value Any numerical value.
     * @param ops Any options to be added to the request.
     */
    function add(key: string, value: number, ops?: Options): any;

    /**
     * This function subtracts a number to a key in the database. (If no existing number, it will subtract from 0)
     * @param key Any string as a key. Also allows for dot notation following the key.
     * @param value Any numerical value.
     * @param ops Any options to be added to the request.
     */
    function subtract(key: string, value: number, ops?: Options): any;

    /**
     * This function will push into an array in the database based on the key. (If no existing array, it will create one)
     * @param key Any string as a key. Also allows for dot notation following the key.
     * @param value Any data to push.
     * @param ops Any options to be added to the request.
     */
    function push(key: string, value: ValueData, ops?: Options): any[];

    /**
     * This function will pull all matching data from the Array.
     * @param key Any string as a key. Also allows for dot notation following the key.
     * @param value Any data to pull.
     * @param ops Any options to be added to the request.
     */
    function pull(key: string, value: ValueData, ops?: Options): any[];

    /**
     * This function returns a boolean indicating whether an element with the specified key exists or not.
     * @param key Any string as a key. Also allows for dot notation following the key, this will return if the prop exists or not.
     * @param ops Any options to be added to the request.
     */
    function has(key: string, ops?: Options): boolean;

    /**
     * This function returns a boolean indicating whether an element with the specified key exists or not.
     * @param key Any string as a key. Also allows for dot notation following the key, this will return if the prop exists or not.
     * @param ops Any options to be added to the request.
     */
    function includes(key: string, ops?: Options): boolean;

    /**
     * This function fetches the entire active table
     * @param ops Any options to be added to the request.
     */
    function all(ops?: Options): { ID: string; data: any; }[];

    /**
     * This function fetches the entire active table
     * @param ops Any options to be added to the request.
     */
    function fetchAll(ops?: Options): { ID: string; data: any; }[];

    /**
     * This method deletes entire table or specific keys
     * @param key Key to remove (optional)
     * @param ops Any options to be added to the request
     */
    function deleteAll(key?: string, ops?: Options): boolean;

    /**
     * This method can be used to get array of data with the keys that start with the given key.
     * @param key Any string as a key. Also allows for dot notation following the key, this will return if the prop exists or not.
     * @param ops Any options to be added to the request.
     */
    function startsWith(key: string, ops?: OptionsStartsWith): { ID: string; data: any; }[];

    /**
     * This function will delete an object (or property) in the database.
     * @param key Any string as a key. Also allows for dot notation following the key, this will delete the prop in the object.
     * @param ops Any options to be added to the request.
     */
    function del(key: string, ops?: Options): boolean;

    /**
     * Used to get the type of the value.
     * @param key Any string as a key. Also allows for dot notation following the key, this will delete the prop in the object.
     * @param ops Any options to be added to the request.
     */
    function dataType(key: string, ops?: Options): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function";

    class Table {
        tableName: string;

        /**
         * Using 'new' on this function creates a new instance of a table.
         * @param tableName Any string as the name of the table.
         * @param options Options
         */
        public constructor(tableName: string, options?: object);

        /**
         * This function sets new data based on a key in the database. 
         * @param key Any string as a key. Also allows for dot notation following the key.
         * @param value Value to set.
         * @param ops Any options to be added to the request.
         */
        public set(key: string, value: ValueData, ops?: Options): any;

        /**
         * This method inserts multiple data at once
         * @param items Items to insert
         * @param ops Any options to be added to the request.
         */
        public setMany(items: Many[], ops?: Options): Many[];

        /**
         * This function fetches data from a key in the database.
         * @param key Any string as a key. Also allows for dot notation following the key.
         * @param ops Any options to be added to the request.
         */
        public get(key: string, ops?: Options): any;

        /**
         * This function fetches data from a key in the database.
         * @param key Any string as a key. Also allows for dot notation following the key.
         * @param ops Any options to be added to the request.
         */
        public fetch(key: string, ops?: Options): any;

        /**
         * This function adds a number to a key in the database. (If no existing number, it will add to 0)
         * @param key Any string as a key. Also allows for dot notation following the key.
         * @param value Any numerical value.
         * @param ops Any options to be added to the request.
         */
        public add(key: string, value: number, ops?: Options): any;

        /**
         * This function subtracts a number to a key in the database. (If no existing number, it will subtract from 0)
         * @param key Any string as a key. Also allows for dot notation following the key.
         * @param value Any numerical value.
         * @param ops Any options to be added to the request.
         */
        public subtract(key: string, value: number, ops?: Options): any;

        /**
         * This function will push into an array in the database based on the key. (If no existing array, it will create one)
         * @param key Any string as a key. Also allows for dot notation following the key.
         * @param value Any data to push.
         * @param ops Any options to be added to the request.
         */
        public push(key: string, value: ValueData, ops?: Options): any[];

        /**
         * This function will pull all matching data from the Array.
         * @param key Any string as a key. Also allows for dot notation following the key.
         * @param value Any data to pull.
         * @param ops Any options to be added to the request.
         */
        public pull(key: string, value: ValueData, ops?: Options): any[];

        /**
         * This function returns a boolean indicating whether an element with the specified key exists or not.
         * @param key Any string as a key. Also allows for dot notation following the key, this will return if the prop exists or not.
         * @param ops Any options to be added to the request.
         */
        public has(key: string, ops?: Options): boolean;

        /**
         * This function returns a boolean indicating whether an element with the specified key exists or not.
         * @param key Any string as a key. Also allows for dot notation following the key, this will return if the prop exists or not.
         * @param ops Any options to be added to the request.
         */
        public includes(key: string, ops?: Options): boolean;

        /**
         * This function fetches the entire active table
         * @param ops Any options to be added to the request.
         */
        public all(ops?: Options): { ID: string; data: any }[];

        /**
         * This function fetches the entire active table
         * @param ops Any options to be added to the request.
         */
        public fetchAll(ops?: Options): { ID: string; data: any }[];

        /**
         * This method deletes entire table or specific keys
         * @param key Key to remove (optional)
         * @param ops Any options to be added to the request
         */
        public deleteAll(key?: string, ops?: Options): boolean;

        /**
         * This method can be used to get array of data with the keys that start with the given key.
         * @param key Any string as a key. Also allows for dot notation following the key, this will return if the prop exists or not.
         * @param ops Any options to be added to the request.
         */
        public startsWith(key: string, ops?: OptionsStartsWith): { ID: string; data: any }[];

        /**
         * This function will delete an object (or property) in the database.
         * @param key Any string as a key. Also allows for dot notation following the key, this will delete the prop in the object.
         * @param ops Any options to be added to the request.
         */
        public delete(key: string, ops?: Options): boolean;
    }

    export {
        fetch,
        get,
        set,
        setMany,
        add,
        subtract,
        push,
        pull,
        has,
        includes,
        all,
        fetchAll,
        deleteAll,
        startsWith,
        del as delete,
        dataType as type,
        Table as table,
        version
    }

}