Reign is a lightweight library for managing IndexedDB operations in modern web applications. It simplifies database interactions like creating, updating, retrieving, and deleting records using a clean and intuitive API.

• Easy setup and initialization of IndexedDB databases
• Support for multiple object store creation during database upgrades
• CRUD operations (create, read, update, and delete) with asynchronous promises
• Lightweight helpers for checking whether specific records exist before performing updates or deletes
• Designed for flexibility and reusability in modern JavaScript applications

You can install Reign IDB using npm:

npm install reign-idb

Import the Reign class in your JavaScript project:

import Reign from 'reign-idb';

Instantiate a Reign object by providing the databaseName, storeNames (as an array), and version parameters:

const db = new Reign({
  databaseName: 'MyDatabase',
  storeNames: [
    'Users',
    { name: 'Products', keyPath: 'sku' },
    { storeName: 'Logs', keyPath: null, autoIncrement: true },
  ],
  version: 1
});

Initialize the database connection before performing any operations:

await db.init();

Use the update method to add a new record or update an existing one in a specific store:

const recordId = await db.update('Users', { name: 'John Doe', age: 30 });
console.log(`Record saved with ID: ${recordId}`);

Retrieve all records from a specific object store:

const users = await db.read('Users');
console.log(users);

Fetch a specific record by its ID from a specific store:

const user = await db.get('Users', 1);
console.log(user);

Quickly check whether a record with a particular ID is present in the store:

const exists = await db.isExist('Users', 1);
console.log(`Record exists: ${exists}`);

Delete a record by its ID from a specific store:

await db.delete('Users', 1);
console.log('Record deleted');

When you're done with database operations, it's good practice to close the connection:

db.close();

Reign validates the arguments that are passed into the constructor. If the library throws Store names must be provided as an array of strings or configuration objects, or as a plain object map of configurations, it means the storeNames option was either omitted, not one of the supported collection shapes, or contains entries that are missing a name/storeName string. Valid configuration objects can supply custom keyPath, autoIncrement, or additional options values:

const db = new Reign({
  databaseName: 'MyDatabase',
  storeNames: [
    { storeName: 'Example', keyPath: 'level' },
    { name: 'AnotherStore', keyPath: null, autoIncrement: true },
  ],
  version: 1,
});

You can pass storeNames as either an array or a plain object map. When using a map, each key becomes the store name and the corresponding value is the configuration object. Double-check that the collection you pass to storeNames is constructed correctly (for example, ensure any variables you spread into it are defined) and that each entry includes the required identifier. Once those conditions are met, the constructor will accept the configuration and proceed with database initialization.

new Reign({ databaseName, storeNames, version });

• databaseName (String): Name of the IndexedDB database
• storeNames (Array<String|Object> | Object): Array of store names or configuration objects, or a plain object map whose keys are store names. Configuration objects may define name or storeName, keyPath, autoIncrement, or a complete options object. When omitted, the key path defaults to id with autoIncrement enabled.
• version (Number): Version number for the database

Initializes the database connection. Creates the specified object stores if they don't already exist.

Returns: Promise<IDBDatabase>

Adds or updates a record in the specified object store.

• storeName (String): Name of the object store
• data (Object): The record to add or update

Returns: Promise<number> – The ID of the added or updated record

Retrieves all records from the specified object store.

• storeName (String): Name of the object store

Returns: Promise<Array<Object>>

Retrieves a specific record by its ID from the specified object store.

• storeName (String): Name of the object store
• id (Number): The ID of the record to retrieve

Returns: Promise<Object|undefined>

Checks whether a record with the provided ID is present in the specified store.

• storeName (String): Name of the object store
• id (Number): The ID of the record to check

Returns: Promise<boolean>

Deletes a specific record by its ID from the specified object store.

• storeName (String): Name of the object store
• id (Number): The ID of the record to delete

Returns: Promise<void>

Clears all records from the specified object store.

• storeName (String): Name of the object store

Returns: Promise<void>

Closes the active database connection. This is useful for cleanup when the database connection is no longer needed.

Returns: void

All methods reject with an appropriate error if an operation fails. Use try-catch blocks or .catch handlers to manage errors gracefully:

try {
	const user = await db.get('Users', 1);
} catch (error) {
	console.error('Error fetching record:', error);
}

Reign IDB requires modern browsers with IndexedDB support. Most contemporary browsers (Chrome, Firefox, Safari, Edge) are fully compatible.

Contributions are welcome! Please feel free to submit a Pull Request.

This project is open-source and available under the MIT License.