1.0.2 ā€¢ Published 4 years ago

micro-indexeddb v1.0.2

Weekly downloads
2
License
MIT
Repository
github
Last release
4 years ago

šŸ”– Description

šŸ’Ž Micro JavaScript Library for implementation local šŸ’¾ Database IndexedDB that is durable and scalable. Include this library into your native JavaScript application with embed script type module or your React, Angular and others frameworks with npm module.

šŸ“ How to work with this project

Native JavaScript

Copy "index.js" file into the main folder of your JavaScript application and import it with a simple script reference into other js file, for example "db.js".

import Db from "./index.js";

NPM

npm i micro-indexeddb
import Db from "micro-indexeddb";

Run

// Define and init Database
Db.init("myDB", 1, [{
  name: "Article",
  details: {
    keyPath: "id"
  }
}]);

// Save data into Database
const id = await Db.add("Article", {
  "id": Date.now(),
  "title": "Hello World V.1"
});

// Get all data from registered
const result = await Db.findById("Article", id);

// Update data with keypath
await Db.put("Article", {
  "id": id,
  "title": "Hello World V.2"
});

// Remove data with keypath
await Db.delete("Article", id);

šŸ“‚ Code Scaffolding

/
ā”œā”€ā”€ assets šŸŒˆ                   # Images Sources.
ā”œā”€ā”€ src šŸ“¦                      # Main file library.
|   ā””ā”€ā”€ ...
ā””ā”€ā”€ ...

ā›½ļø Review and Update Sependencies

For review and update all npm dependencies of this project you need install in global npm package "npm-check-updates" npm module.

# Install and Run
$npm i -g npm-check-updates
$ncu

License

MIT

Happy Code

Created with JavaScript, lot of ā¤ļø and a few ā˜•ļø

This README.md file has been written keeping in mind

GitHub Markdown \ Emoji Cheat Sheet