Socket
Socket
Sign inDemoInstall

@n1md7/indexeddb-promise

Package Overview
Dependencies
Maintainers
1
Versions
32
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@n1md7/indexeddb-promise

Indexed DB


Version published
Weekly downloads
35
increased by775%
Maintainers
1
Weekly downloads
 
Created
Source

Indexed DB with promises

npm GitHub

Demo

  • Example01
  • Advanced Example02

Installation

npm install @n1md7/indexeddb-promise --save

Properties

  • selectAll
  • selectFrom
  • selectWhere
  • updateWhere
  • deleteWhere

.selectAll()

Gets all the data from db and returns promise with response data

.selectFrom(pKey)

Has one parameter pkey as primaryKey and returns promise with data

.selectWhere({...})

Has one parameter props which can be

props = {
   limit: 10,
   where: (dataArray) => {return dataArray},
   orderByDESC: true,
   sortBy: 'comments'// ['comments', 'date']
}

@where property can filter out data like where: data => data.filter(dt.username === 'admin')

.updateWhere(pKey, {...})

Has two parameters pkey and keyValue pair of updated data .updateWhere(123, {username: 'admin'})

.deleteWhere(pKey)

Has one parameter pKey which record to delete based on primary key

note primary key is type sensitive. If it is saved as integer then should pass as integer and vice versa

Usage example

<html>
<head>
    <title>IndexedDB app</title>
    <script src="./dist/indexeddb-promise.min.js"></script>
</head>
<body>
    <script>
        // Your script here
    </script>
</body>
</html>

Once you add indexeddb-promise.min.js in your document then you will be able to access indexedDBModel variable globally which contains Model and ModelConfig. They can be extracted as following

const {
    ModelConfig,
    Model
} = indexedDBModel;

// or
const ModelConfig = indexedDBModel.ModelConfig;
const Model = indexedDBModel.Model;

Create example config

class Rooms extends ModelConfig{
    //@overrides default method
    get config() {
      return {
        version: 1,
        databaseName: 'myNewDatabase',
        tableName: 'myNewTable',
        primaryKey: {
          name: 'id',
          autoIncrement: false
        },
        initData: [],
        structure: {
          roomId: { unique: false,  autoIncrement: true },
          roomName: { unique: false,  autoIncrement: false },
          comments: { unique: false,  autoIncrement: false }
        }
      };
   }
}

Create connector

const db = new Model(new Rooms);

Full example

<html>
<head>
    <title>IndexedDB app</title>
    <script src="indexeddb-promise.min.js"></script>
</head>
<body>
    <script>
        const {
            ModelConfig,
            Model
        } = indexedDBModel;
        
        class Rooms extends ModelConfig{
            //@overrides default method
            get config() {
              return {
                version: 1,
                databaseName: 'myNewDatabase',
                tableName: 'myNewTable',
                primaryKey: {
                  name: 'id',
                  autoIncrement: false
                },
                initData: [],
                structure: {
                  roomId: { unique: false,  autoIncrement: true },
                  roomName: { unique: false,  autoIncrement: false },
                  comment: { unique: false,  autoIncrement: false }
                }
              };
           }
        }
        
        const db = new Model(new Rooms);
        
        // add new record
        db.insertData({
              'id': Math.random() * 10,
              'roomName': 'My room name',
              'roomId': 1,
              'comment': 'This room is awesome'
            })
              .then(function(){
                //when done click update button
                console.info('Yay, you have saved the data.');
              }).catch(function(error){
                console.error(error);
            });
        
        // Get all results from DB
        db.selectAll()
          .then(function(results){
            console.log(...results);
          });

    </script>
</body>
</html>

Keywords

FAQs

Package last updated on 14 Dec 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc