https://github.com/aegisjsproject/idb

Simple, promise-based IndexedDB CRUD library.
https://github.com/aegisjsproject/idb

crud database idb indexeddb

Last synced: 3 months ago
JSON representation

Simple, promise-based IndexedDB CRUD library.

• Host: GitHub
• URL: https://github.com/aegisjsproject/idb
• Owner: AegisJSProject
• License: mit
• Created: 2025-01-21T16:31:07.000Z (6 months ago)
• Default Branch: master
• Last Pushed: 2025-04-03T17:06:53.000Z (3 months ago)
• Last Synced: 2025-04-03T18:22:58.595Z (3 months ago)
• Topics: crud, database, idb, indexeddb
• Language: JavaScript
• Homepage: https://npmjs.com/package/@aegisjsproject/idb
• Size: 196 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# `@aegisjsproject/idb`

Simple, promise-based IndexedDB CRUD library.

[![CodeQL](https://github.com/AegisJSProject/idb/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/AegisJSProject/idb/actions/workflows/codeql-analysis.yml)

![Node CI](https://github.com/AegisJSProject/idb/workflows/Node%20CI/badge.svg)

![Lint Code Base](https://github.com/AegisJSProject/idb/workflows/Lint%20Code%20Base/badge.svg)

[![GitHub license](https://img.shields.io/github/license/AegisJSProject/idb.svg)](https://github.com/AegisJSProject/idb/blob/master/LICENSE)

[![GitHub last commit](https://img.shields.io/github/last-commit/AegisJSProject/idb.svg)](https://github.com/AegisJSProject/idb/commits/master)

[![GitHub release](https://img.shields.io/github/release/AegisJSProject/idb?logo=github)](https://github.com/AegisJSProject/idb/releases)

[![GitHub Sponsors](https://img.shields.io/github/sponsors/shgysk8zer0?logo=github)](https://github.com/sponsors/shgysk8zer0)

[![npm](https://img.shields.io/npm/v/@aegisjsproject/idb)](https://www.npmjs.com/package/@aegisjsproject/idb)

![node-current](https://img.shields.io/node/v/@aegisjsproject/idb)

![npm bundle size gzipped](https://img.shields.io/bundlephobia/minzip/@aegisjsproject/idb)

[![npm](https://img.shields.io/npm/dw/@aegisjsproject/idb?logo=npm)](https://www.npmjs.com/package/@aegisjsproject/idb)

[![GitHub followers](https://img.shields.io/github/followers/shgysk8zer0.svg?style=social)](https://github.com/shgysk8zer0)

![GitHub forks](https://img.shields.io/github/forks/AegisJSProject/idb.svg?style=social)

![GitHub stars](https://img.shields.io/github/stars/AegisJSProject/idb.svg?style=social)

[![Twitter Follow](https://img.shields.io/twitter/follow/shgysk8zer0.svg?style=social)](https://twitter.com/shgysk8zer0)

[![Donate using Liberapay](https://img.shields.io/liberapay/receives/shgysk8zer0.svg?logo=liberapay)](https://liberapay.com/shgysk8zer0/donate "Donate using Liberapay")

- - -

- [Code of Conduct](./.github/CODE_OF_CONDUCT.md)

- [Contributing](./.github/CONTRIBUTING.md)

## Features

- Intuitive CRUD (Create, Read, Update, Delete) operations for IndexedDB.

- Utilities for handling transactions and object stores.

- Support for `AbortController` signals to cancel ongoing requests.

- Helper functions for both `readonly` and `readwrite` operations.

## Installation

### Using npm

Install the package with npm:

```bash

npm i @aegisjsproject/idb

```