epic-storage

A small data storage library

Installation

$ npm i epic-storage --save

Usage

const storage = new epicStorage({
    storageName: "my-storage",
    prefix: "prefix-"
});

try {
    storage.init().then(() => {
        //Add New Schema
        storage.addSchema("test").then(() => {
            //Add Single Item
            storage.addItem("status", "Success").then(() => {
                console.log("Added Successfully!");
            });
            //Add Multiple Item
            storage.addItems({
                foo: "bar",
                hello: "world",
                bla: "bla",
                test: "test"
            }).then(() => {
                console.log("Added Successfully!");
                //Remove Item
                storage.removeItems(["status", "foo"]).then(() => {
                    console.log("Successfully Removed!");
                });
            });
        });
    });
} catch (ex) {
    console.log(ex);
}

Options

• storageName - string (Default 'storage') Any Name
• rootDir - string (Default 'Module root') | Where to put data.
• prefix - string (Default 'epic_') | Any Prefix
• logs - boolean (Default False) | Set True if logs are required.

Methods

• init: () => Promise - Required Initializes the module.
• addSchema: (schemaName: string, use?: boolean) => Promise - Create new schema.
• hasSchema: (schemaName: string) => boolean - Check if Schema Exists.
• listSchema: () => string[] - List all available Schema.
• useSchema: (schemaName: string) => this - Pick a Schema to work with.
• removeSchema: (schemaName?: string | undefined) => this - Remove any or current working schema.
• renameSchema: (newSchemaName: string, oldSchemaName?: string | undefined) => this - Rename Schema.
• clearSchema: (schema?: string | undefined, throwError?: boolean) => this - Clear data from any Schema.
• addItem: (key: string, value: string | object, schema?: string | undefined, throwError?: boolean) =>Promise - Add new item to storage.
• addItems: (data: ITEMS, schema?: string | undefined, throwError?: boolean) => Promise - Add multiple item to storage.
• getItem: (key: string, schema?: string | undefined, throwError?: boolean) => Promise - Get Item.
• getAllItems: (schema?: string | undefined, throwError?: boolean) => Promise - Get all Items from working Schema.
• removeItem: (key: string, schema?: string | undefined, throwError?: boolean) => Promise - Remove an Item.
• removeItems: (keys: string[], schema?: string | undefined, throwError?: boolean) => Promise - Remove multiple Items.
• hasItem: (key: string, schema?: string | undefined) => Promise - Check Item (Also checks the Schema).
• destroy: (logs?: boolean) => this - Caution Delete all storage.
• logConfig: (fileName: string, directory: string) => this - Change Log configuration.
• clearLog: () => this - Clear Logs.