@n1md7/indexeddb-promise
Advanced tools
Readme
npm install @n1md7/indexeddb-promise --save
# or
yarn add @n1md7/indexeddb-promise
or
<script src="https://bundle.run/@n1md7/indexeddb-promise@2.0.0"></script>
<script src="https://unpkg.com/@n1md7/indexeddb-promise@2.0.0/src/index.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@n1md7/indexeddb-promise@2.0.0/dist/indexed-db.min.js"></script>
Gets all the data from db and returns promise with response data
Has one parameter pkey as primaryKey and returns promise with data
Has one parameter props which can be
/**
* @typedef {string | number | boolean | null | undefined} Item
*/
/**
* @typedef {{[key: string]: Item} | Item} ListItem
*/
/**
* @param {{
* where?: {
* [key: string]: any
* } | function(ListItem[]):ListItem[],
* limit?: number,
* orderByDESC?: boolean,
* sortBy?: string | string[]
* }} options
* @returns {Promise<ListItem[]>}
*/
props = {
limit: 10,
where: (dataArray) => {
return dataArray;
},
orderByDESC: true,
sortBy: 'comments', // ['comments', 'date']
};
@where property can filter out data like
where: (data) => data.filter((item) => item.username === 'admin');
or it can be an object, which gets data with AND(&&) comparison
where: {
username: 'admin',
password:'admin123'
}
Has two parameters pkey and keyValue pair of updated data
.updateByPk(123, { username: 'admin' })
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
<html>
<head>
<title>IndexedDB app</title>
<script src="./dist/indexed-db.min.js"></script>
</head>
<body>
<script>
// Your script here
</script>
</body>
</html>
Once you add indexed-db.min.js in your document then you will be able to access
IndexedDBModel variable globally which contains Model. They can be extracted as following
const { Model } = IndexedDBModel;
// or
const Model = IndexedDBModel.Model;
class DB extends IndexedDBModel.Model {
//@overrides default method
get config() {
return {
version: 1,
databaseName: 'myNewDatabase',
tableName: 'myNewTable',
primaryKey: {
name: 'id',
autoIncrement: false,
unique: true,
},
initData: [],
structure: {
username: { unique: false, autoIncrement: false },
password: { unique: false, autoIncrement: false },
createdAt: { unique: false, autoIncrement: false },
updatedAt: { unique: false, autoIncrement: false },
},
};
}
}
const db = new DB();
<html>
<head>
<title>IndexedDB app</title>
<script src="./dist/indexed-db.min.js"></script>
</head>
<body>
<script>
class DB extends IndexedDBModel.Model {
//@overrides default method
get config() {
return {
version: 1,
databaseName: 'myNewDatabase',
tableName: 'myNewTable',
primaryKey: {
name: 'id',
autoIncrement: false,
unique: true,
},
initData: [],
structure: {
username: { unique: false, autoIncrement: false },
password: { unique: false, autoIncrement: false },
createdAt: { unique: false, autoIncrement: false },
updatedAt: { unique: false, autoIncrement: false },
},
};
}
}
const db = new DB();
// add a new record
db.insert({
id: Math.random() * 10,
username: 'admin',
password: 'nimda',
createdAt: new Date(),
updatedAt: new Date(),
})
.then(function () {
console.info('Yay, you have saved the data.');
})
.catch(function (error) {
console.error(error);
});
// Get all results from the database
db.selectAll().then(function (results) {
console.log(...results);
});
</script>
</body>
</html>
const IndexedDBModel = require('@n1md7/indexeddb-promise');
const { Model } = IndexedDBModel;
// or
import { Model } from '@n1md7/indexeddb-promise';
FAQs
Indexed DB wrapper with promises
The npm package @n1md7/indexeddb-promise receives a total of 1 weekly downloads. As such, @n1md7/indexeddb-promise popularity was classified as not popular.
We found that @n1md7/indexeddb-promise demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
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.
Security News
Results from the 2023 State of JavaScript Survey highlight key trends, including Vite's dominance, rising TypeScript adoption, and the enduring popularity of React. Discover more insights on developer preferences and technology usage.
Security News
The US Justice Department has penalized two consulting firms $11.3 million for failing to meet cybersecurity requirements on federally funded projects, emphasizing strict enforcement to protect sensitive government data.
Security News
ua-parser-js is set to drop the MIT license and adopt a controversial dual AGPLv3 + PRO licensing model in its upcoming v2.0 release, raising significant concerns among developers and enterprise users.