1.0.27 • Published 4 years ago
epic-storage v1.0.27
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.
1.0.27
4 years ago
1.0.26
4 years ago
1.0.25
4 years ago
1.0.24
4 years ago
1.0.23
4 years ago
1.0.22
4 years ago
1.0.21
4 years ago
1.0.20
4 years ago
1.0.19
4 years ago
1.0.18
4 years ago
1.0.17
4 years ago
1.0.16
4 years ago
1.0.15
4 years ago
1.0.14
4 years ago
1.0.13
4 years ago
1.0.12
4 years ago
1.0.11
4 years ago
1.0.9
4 years ago
1.0.10
4 years ago
1.0.8
4 years ago
1.0.7
4 years ago
1.0.6
4 years ago
1.0.5
4 years ago
1.0.4
4 years ago
1.0.3
4 years ago
1.0.2
4 years ago
1.0.1
4 years ago
1.0.0
4 years ago