@xylabs/indexed-db 5.0.95 → 5.0.96

package/README.md

@@ -1,70 +1,52 @@
 # @xylabs/indexed-db
 
-[![logo][]](https://xylabs.com)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
 
-[![main-build][]][main-build-link]
-[![npm-badge][]][npm-link]
-[![npm-downloads-badge][]][npm-link]
-[![jsdelivr-badge][]][jsdelivr-link]
-[![npm-license-badge][]](LICENSE)
-[![codacy-badge][]][codacy-link]
-[![codeclimate-badge][]][codeclimate-link]
-[![snyk-badge][]][snyk-link]
-[![socket-badge][]][socket-link]
+> Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
+## Install
 
-Base functionality used throughout XY Labs TypeScript/JavaScript libraries
-
+Using npm:
 
+```sh
+npm install {{name}}
+```
 
-## Reference
+Using yarn:
 
-**@xylabs/indexed-db**
+```sh
+yarn add {{name}}
+```
 
-***
+Using pnpm:
 
-## Classes
+```sh
+pnpm add {{name}}
+```
 
-| Class | Description |
-| ------ | ------ |
-| [IndexedDbKeyValueStore](#classes/IndexedDbKeyValueStore) | An IndexedDB key/value store. |
+Using bun:
 
-## Interfaces
+```sh
+bun add {{name}}
+```
 
-| Interface | Description |
-| ------ | ------ |
-| [ObjectStore](#interfaces/ObjectStore) | Generic IndexedDB schema type that maps store names to their value types. |
 
-## Type Aliases
+## License
 
-| Type Alias | Description |
-| ------ | ------ |
-| [IndexDirection](#type-aliases/IndexDirection) | The index direction (1 for ascending, -1 for descending) |
-| [IndexDescription](#type-aliases/IndexDescription) | Description of index(es) to be created on a store |
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
 
-## Variables
+## Reference
 
-| Variable | Description |
-| ------ | ------ |
-| [IndexSeparator](#variables/IndexSeparator) | Separator used between key names when building standard index names. |
+### packages
 
-## Functions
+  ### indexed-db
 
-| Function | Description |
-| ------ | ------ |
-| [buildStandardIndexName](#functions/buildStandardIndexName) | Given an index description, this will build the index name in standard form |
-| [checkDbNeedsUpgrade](#functions/checkDbNeedsUpgrade) | Checks whether any store in the database needs an upgrade and returns the appropriate version number. |
-| [createStoreDuringUpgrade](#functions/createStoreDuringUpgrade) | Creates an object store with the specified indexes during a version upgrade transaction. |
-| [getExistingIndexes](#functions/getExistingIndexes) | Retrieves the existing index descriptions for a store. Accepts either a database instance or a database name. |
-| [withDb](#functions/withDb) | Opens an IndexedDB database, automatically upgrading if needed, and passes it to the callback. Uses a mutex to serialize access to the same database by default. |
-| [withDbByVersion](#functions/withDbByVersion) | Opens an IndexedDB database at a specific version, handling upgrade events, and passes it to the callback. The database is automatically closed after the callback completes. |
-| [withReadOnlyStore](#functions/withReadOnlyStore) | Opens a read-only transaction on the specified store and passes it to the callback. |
-| [withReadWriteStore](#functions/withReadWriteStore) | Opens a read-write transaction on the specified store and passes it to the callback. |
-| [withStore](#functions/withStore) | Opens a transaction on the specified store with the given mode and passes the store to the callback. If the store does not exist, the callback receives null. |
+    ### .temp-typedoc
 
-### classes
+      ### classes
 
-  ### <a id="IndexedDbKeyValueStore"></a>IndexedDbKeyValueStore
+        ### <a id="IndexedDbKeyValueStore"></a>IndexedDbKeyValueStore
 
 [**@xylabs/indexed-db**](#../README)
 
@@ -74,10 +56,13 @@ An IndexedDB key/value store.
 
 ## Type Parameters
 
-| Type Parameter |
-| ------ |
-| `T` *extends* `DBSchema` |
-| `S` *extends* `StoreNames`\<`T`\> |
+### T
+
+`T` *extends* `DBSchema`
+
+### S
+
+`S` *extends* `StoreNames`\<`T`\>
 
 ## Implements
 
@@ -88,15 +73,18 @@ An IndexedDB key/value store.
 ### Constructor
 
 ```ts
-new IndexedDbKeyValueStore<T, S>(dbName: string, storeName: S): IndexedDbKeyValueStore<T, S>;
+new IndexedDbKeyValueStore<T, S>(dbName, storeName): IndexedDbKeyValueStore<T, S>;
 ```
 
 ### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `dbName` | `string` |
-| `storeName` | `S` |
+#### dbName
+
+`string`
+
+#### storeName
+
+`S`
 
 ### Returns
 
@@ -104,10 +92,23 @@ new IndexedDbKeyValueStore<T, S>(dbName: string, storeName: S): IndexedDbKeyValu
 
 ## Properties
 
-| Property | Modifier | Type | Description |
-| ------ | ------ | ------ | ------ |
-| <a id="dbname"></a> `dbName` | `readonly` | `string` | The name of the IndexedDB database. |
-| <a id="storename"></a> `storeName` | `readonly` | `S` | The name of the object store within the database. |
+### dbName
+
+```ts
+readonly dbName: string;
+```
+
+The name of the IndexedDB database.
+
+***
+
+### storeName
+
+```ts
+readonly storeName: S;
+```
+
+The name of the object store within the database.
 
 ## Methods
 
@@ -134,16 +135,18 @@ KeyValueStore.clear
 ### delete()
 
 ```ts
-delete(key: StoreKey<T, S>): Promise<void>;
+delete(key): Promise<void>;
 ```
 
 Deletes the entry with the given key.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `StoreKey`\<`T`, `S`\> | The key of the entry to delete |
+#### key
+
+`StoreKey`\<`T`, `S`\>
+
+The key of the entry to delete
 
 ### Returns
 
@@ -160,16 +163,18 @@ KeyValueStore.delete
 ### get()
 
 ```ts
-get(key: StoreKey<T, S>): Promise<StoreValue<T, S> | undefined>;
+get(key): Promise<StoreValue<T, S> | undefined>;
 ```
 
 Retrieves the value associated with the given key.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `StoreKey`\<`T`, `S`\> | The key to look up |
+#### key
+
+`StoreKey`\<`T`, `S`\>
+
+The key to look up
 
 ### Returns
 
@@ -208,17 +213,24 @@ KeyValueStore.keys
 ### set()
 
 ```ts
-set(key: StoreKey<T, S>, value: StoreValue<T, S>): Promise<void>;
+set(key, value): Promise<void>;
 ```
 
 Sets a value for the given key, creating or updating the entry.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `StoreKey`\<`T`, `S`\> | The key to set |
-| `value` | `StoreValue`\<`T`, `S`\> | The value to store |
+#### key
+
+`StoreKey`\<`T`, `S`\>
+
+The key to set
+
+#### value
+
+`StoreValue`\<`T`, `S`\>
+
+The value to store
 
 ### Returns
 
@@ -235,22 +247,24 @@ KeyValueStore.set
 ### withDb()
 
 ```ts
-withDb<R>(callback: (db: IDBPDatabase<T>) => R | Promise<R>): Promise<R>;
+withDb<R>(callback): Promise<R>;
 ```
 
 Opens the underlying IndexedDB database and passes it to the callback.
 
 ### Type Parameters
 
-| Type Parameter | Default type |
-| ------ | ------ |
-| `R` | `StoreValue`\<`T`, `S`\> |
+#### R
+
+`R` = `StoreValue`\<`T`, `S`\>
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `callback` | (`db`: `IDBPDatabase`\<`T`\>) => `R` \| `Promise`\<`R`\> | Function to execute with the database |
+#### callback
+
+(`db`) => `R` \| `Promise`\<`R`\>
+
+Function to execute with the database
 
 ### Returns
 
@@ -258,16 +272,16 @@ Opens the underlying IndexedDB database and passes it to the callback.
 
 The result of the callback
 
-### functions
+      ### functions
 
-  ### <a id="buildStandardIndexName"></a>buildStandardIndexName
+        ### <a id="buildStandardIndexName"></a>buildStandardIndexName
 
 [**@xylabs/indexed-db**](#../README)
 
 ***
 
 ```ts
-function buildStandardIndexName(index: IndexDescription): string;
+function buildStandardIndexName(index): string;
 ```
 
 Given an index description, this will build the index
@@ -275,9 +289,11 @@ name in standard form
 
 ## Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `index` | [`IndexDescription`](#../type-aliases/IndexDescription) | The index description |
+### index
+
+[`IndexDescription`](#../interfaces/IndexDescription)
+
+The index description
 
 ## Returns
 
@@ -285,7 +301,7 @@ name in standard form
 
 The index name in standard form
 
-  ### <a id="checkDbNeedsUpgrade"></a>checkDbNeedsUpgrade
+        ### <a id="checkDbNeedsUpgrade"></a>checkDbNeedsUpgrade
 
 [**@xylabs/indexed-db**](#../README)
 
@@ -293,20 +309,32 @@ The index name in standard form
 
 ```ts
 function checkDbNeedsUpgrade(
-   dbName: string, 
-   stores: Record<string, IndexDescription[]>, 
-logger?: Logger): Promise<number>;
+   dbName, 
+   stores, 
+logger?): Promise<number>;
 ```
 
 Checks whether any store in the database needs an upgrade and returns the appropriate version number.
 
 ## Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `dbName` | `string` | The name of the database to check |
-| `stores` | `Record`\<`string`, [`IndexDescription`](#../type-aliases/IndexDescription)[]\> | Map of store names to their expected index descriptions |
-| `logger?` | `Logger` | Optional logger for diagnostics |
+### dbName
+
+`string`
+
+The name of the database to check
+
+### stores
+
+`Record`\<`string`, [`IndexDescription`](#../interfaces/IndexDescription)[]\>
+
+Map of store names to their expected index descriptions
+
+### logger?
+
+`Logger`
+
+Optional logger for diagnostics
 
 ## Returns
 
@@ -314,7 +342,7 @@ Checks whether any store in the database needs an upgrade and returns the approp
 
 The version to open (current version + 1 if upgrade needed, otherwise current version)
 
-  ### <a id="createStoreDuringUpgrade"></a>createStoreDuringUpgrade
+        ### <a id="createStoreDuringUpgrade"></a>createStoreDuringUpgrade
 
 [**@xylabs/indexed-db**](#../README)
 
@@ -322,34 +350,51 @@ The version to open (current version + 1 if upgrade needed, otherwise current ve
 
 ```ts
 function createStoreDuringUpgrade<DBTypes>(
-   db: IDBPDatabase<DBTypes>, 
-   storeName: StoreNames<DBTypes>, 
-   indexes: IndexDescription[], 
-   logger?: Logger): void;
+   db, 
+   storeName, 
+   indexes, 
+   logger?): void;
 ```
 
 Creates an object store with the specified indexes during a version upgrade transaction.
 
 ## Type Parameters
 
-| Type Parameter | Default type |
-| ------ | ------ |
-| `DBTypes` *extends* `unknown` | `unknown` |
+### DBTypes
+
+`DBTypes` *extends* `unknown` = `unknown`
 
 ## Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `db` | `IDBPDatabase`\<`DBTypes`\> | The IndexedDB database instance (during upgrade) |
-| `storeName` | `StoreNames`\<`DBTypes`\> | The name of the store to create |
-| `indexes` | [`IndexDescription`](#../type-aliases/IndexDescription)[] | The index descriptions to create on the store |
-| `logger?` | `Logger` | Optional logger for diagnostics |
+### db
+
+`IDBPDatabase`\<`DBTypes`\>
+
+The IndexedDB database instance (during upgrade)
+
+### storeName
+
+`StoreNames`\<`DBTypes`\>
+
+The name of the store to create
+
+### indexes
+
+[`IndexDescription`](#../interfaces/IndexDescription)[]
+
+The index descriptions to create on the store
+
+### logger?
+
+`Logger`
+
+Optional logger for diagnostics
 
 ## Returns
 
 `void`
 
-  ### <a id="getExistingIndexes"></a>getExistingIndexes
+        ### <a id="getExistingIndexes"></a>getExistingIndexes
 
 [**@xylabs/indexed-db**](#../README)
 
@@ -357,36 +402,47 @@ Creates an object store with the specified indexes during a version upgrade tran
 
 ```ts
 function getExistingIndexes<T>(
-   db: 
-  | string
-  | IDBPDatabase<ObjectStore<T>>, 
-   storeName: StoreNames<ObjectStore<T>>, 
-logger?: Logger): Promise<IndexDescription[] | null>;
+   db, 
+   storeName, 
+logger?): Promise<IndexDescription[] | null>;
 ```
 
 Retrieves the existing index descriptions for a store. Accepts either a database instance or a database name.
 
 ## Type Parameters
 
-| Type Parameter | Default type |
-| ------ | ------ |
-| `T` *extends* `object` | `object` |
+### T
+
+`T` *extends* `object` = `object`
 
 ## Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `db` | \| `string` \| `IDBPDatabase`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\> | The IndexedDB database instance or database name |
-| `storeName` | `StoreNames`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\> | The name of the store to inspect |
-| `logger?` | `Logger` | Optional logger for diagnostics |
+### db
+
+  \| `string`
+  \| `IDBPDatabase`\<[`ObjectStore`](#../type-aliases/ObjectStore)\<`T`\>\>
+
+The IndexedDB database instance or database name
+
+### storeName
+
+`StoreNames`\<[`ObjectStore`](#../type-aliases/ObjectStore)\<`T`\>\>
+
+The name of the store to inspect
+
+### logger?
+
+`Logger`
+
+Optional logger for diagnostics
 
 ## Returns
 
-`Promise`\<[`IndexDescription`](#../type-aliases/IndexDescription)[] \| `null`\>
+`Promise`\<[`IndexDescription`](#../interfaces/IndexDescription)[] \| `null`\>
 
 An array of index descriptions, or null if the store does not exist
 
-  ### <a id="withDb"></a>withDb
+        ### <a id="withDb"></a>withDb
 
 [**@xylabs/indexed-db**](#../README)
 
@@ -394,11 +450,11 @@ An array of index descriptions, or null if the store does not exist
 
 ```ts
 function withDb<DBTypes, R>(
-   dbName: string, 
-   callback: (db: IDBPDatabase<DBTypes>) => R | Promise<R>, 
-   expectedIndexes?: Record<string, IndexDescription[]>, 
-   logger?: Logger, 
-lock?: boolean): Promise<R>;
+   dbName, 
+   callback, 
+   expectedIndexes?, 
+   logger?, 
+lock?): Promise<R>;
 ```
 
 Opens an IndexedDB database, automatically upgrading if needed, and passes it to the callback.
@@ -406,20 +462,45 @@ Uses a mutex to serialize access to the same database by default.
 
 ## Type Parameters
 
-| Type Parameter | Default type |
-| ------ | ------ |
-| `DBTypes` *extends* `unknown` | `unknown` |
-| `R` | `object` |
+### DBTypes
+
+`DBTypes` *extends* `unknown` = `unknown`
+
+### R
+
+`R` = `object`
 
 ## Parameters
 
-| Parameter | Type | Default value | Description |
-| ------ | ------ | ------ | ------ |
-| `dbName` | `string` | `undefined` | The name of the database to open |
-| `callback` | (`db`: `IDBPDatabase`\<`DBTypes`\>) => `R` \| `Promise`\<`R`\> | `undefined` | Function to execute with the opened database |
-| `expectedIndexes?` | `Record`\<`string`, [`IndexDescription`](#../type-aliases/IndexDescription)[]\> | `undefined` | Optional map of store names to their expected indexes (triggers upgrade check) |
-| `logger?` | `Logger` | `undefined` | Optional logger for diagnostics |
-| `lock?` | `boolean` | `true` | Whether to use a mutex to serialize access (defaults to true) |
+### dbName
+
+`string`
+
+The name of the database to open
+
+### callback
+
+(`db`) => `R` \| `Promise`\<`R`\>
+
+Function to execute with the opened database
+
+### expectedIndexes?
+
+`Record`\<`string`, [`IndexDescription`](#../interfaces/IndexDescription)[]\>
+
+Optional map of store names to their expected indexes (triggers upgrade check)
+
+### logger?
+
+`Logger`
+
+Optional logger for diagnostics
+
+### lock?
+
+`boolean` = `true`
+
+Whether to use a mutex to serialize access (defaults to true)
 
 ## Returns
 
@@ -427,7 +508,7 @@ Uses a mutex to serialize access to the same database by default.
 
 The result of the callback
 
-  ### <a id="withDbByVersion"></a>withDbByVersion
+        ### <a id="withDbByVersion"></a>withDbByVersion
 
 [**@xylabs/indexed-db**](#../README)
 
@@ -435,12 +516,12 @@ The result of the callback
 
 ```ts
 function withDbByVersion<DBTypes, R>(
-   dbName: string, 
-   callback: (db: IDBPDatabase<DBTypes>) => R | Promise<R>, 
-   version?: number, 
-   expectedIndexes?: Record<string, IndexDescription[]>, 
-   logger?: Logger, 
-lock?: boolean): Promise<R>;
+   dbName, 
+   callback, 
+   version?, 
+   expectedIndexes?, 
+   logger?, 
+lock?): Promise<R>;
 ```
 
 Opens an IndexedDB database at a specific version, handling upgrade events, and passes it to the callback.
@@ -448,21 +529,51 @@ The database is automatically closed after the callback completes.
 
 ## Type Parameters
 
-| Type Parameter | Default type |
-| ------ | ------ |
-| `DBTypes` *extends* `unknown` | `unknown` |
-| `R` | `object` |
+### DBTypes
+
+`DBTypes` *extends* `unknown` = `unknown`
+
+### R
+
+`R` = `object`
 
 ## Parameters
 
-| Parameter | Type | Default value | Description |
-| ------ | ------ | ------ | ------ |
-| `dbName` | `string` | `undefined` | The name of the database to open |
-| `callback` | (`db`: `IDBPDatabase`\<`DBTypes`\>) => `R` \| `Promise`\<`R`\> | `undefined` | Function to execute with the opened database |
-| `version?` | `number` | `undefined` | Optional specific version to open (undefined for latest) |
-| `expectedIndexes?` | `Record`\<`string`, [`IndexDescription`](#../type-aliases/IndexDescription)[]\> | `undefined` | Optional map of store names to indexes to create during upgrade |
-| `logger?` | `Logger` | `undefined` | Optional logger for diagnostics |
-| `lock?` | `boolean` | `true` | Whether to use a mutex to serialize access (defaults to true) |
+### dbName
+
+`string`
+
+The name of the database to open
+
+### callback
+
+(`db`) => `R` \| `Promise`\<`R`\>
+
+Function to execute with the opened database
+
+### version?
+
+`number`
+
+Optional specific version to open (undefined for latest)
+
+### expectedIndexes?
+
+`Record`\<`string`, [`IndexDescription`](#../interfaces/IndexDescription)[]\>
+
+Optional map of store names to indexes to create during upgrade
+
+### logger?
+
+`Logger`
+
+Optional logger for diagnostics
+
+### lock?
+
+`boolean` = `true`
+
+Whether to use a mutex to serialize access (defaults to true)
 
 ## Returns
 
@@ -470,7 +581,7 @@ The database is automatically closed after the callback completes.
 
 The result of the callback
 
-  ### <a id="withReadOnlyStore"></a>withReadOnlyStore
+        ### <a id="withReadOnlyStore"></a>withReadOnlyStore
 
 [**@xylabs/indexed-db**](#../README)
 
@@ -478,31 +589,49 @@ The result of the callback
 
 ```ts
 function withReadOnlyStore<T, R>(
-   db: IDBPDatabase<ObjectStore<T>>, 
-   storeName: StoreNames<ObjectStore<T>>, 
-   callback: (store: 
-  | IDBPObjectStore<ObjectStore<T>, [StoreNames<ObjectStore<T>>], StoreNames<ObjectStore<T>>, "readonly">
-  | null) => R | Promise<R>, 
-logger?: Logger): Promise<R>;
+   db, 
+   storeName, 
+   callback, 
+logger?): Promise<R>;
 ```
 
 Opens a read-only transaction on the specified store and passes it to the callback.
 
 ## Type Parameters
 
-| Type Parameter | Default type |
-| ------ | ------ |
-| `T` *extends* `object` | `object` |
-| `R` | `T` |
+### T
+
+`T` *extends* `object` = `object`
+
+### R
+
+`R` = `T`
 
 ## Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `db` | `IDBPDatabase`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\> | The IndexedDB database instance |
-| `storeName` | `StoreNames`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\> | The name of the object store to open |
-| `callback` | (`store`: \| `IDBPObjectStore`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>, \[`StoreNames`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\>\], `StoreNames`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\>, `"readonly"`\> \| `null`) => `R` \| `Promise`\<`R`\> | Function to execute with the read-only store |
-| `logger?` | `Logger` | Optional logger for diagnostics |
+### db
+
+`IDBPDatabase`\<[`ObjectStore`](#../type-aliases/ObjectStore)\<`T`\>\>
+
+The IndexedDB database instance
+
+### storeName
+
+`StoreNames`\<[`ObjectStore`](#../type-aliases/ObjectStore)\<`T`\>\>
+
+The name of the object store to open
+
+### callback
+
+(`store`) => `R` \| `Promise`\<`R`\>
+
+Function to execute with the read-only store
+
+### logger?
+
+`Logger`
+
+Optional logger for diagnostics
 
 ## Returns
 
@@ -510,7 +639,7 @@ Opens a read-only transaction on the specified store and passes it to the callba
 
 The result of the callback
 
-  ### <a id="withReadWriteStore"></a>withReadWriteStore
+        ### <a id="withReadWriteStore"></a>withReadWriteStore
 
 [**@xylabs/indexed-db**](#../README)
 
@@ -518,31 +647,49 @@ The result of the callback
 
 ```ts
 function withReadWriteStore<T, R>(
-   db: IDBPDatabase<ObjectStore<T>>, 
-   storeName: StoreNames<ObjectStore<T>>, 
-   callback: (store: 
-  | IDBPObjectStore<ObjectStore<T>, [StoreNames<ObjectStore<T>>], StoreNames<ObjectStore<T>>, "readwrite">
-  | null) => R | Promise<R>, 
-logger?: Logger): Promise<R>;
+   db, 
+   storeName, 
+   callback, 
+logger?): Promise<R>;
 ```
 
 Opens a read-write transaction on the specified store and passes it to the callback.
 
 ## Type Parameters
 
-| Type Parameter | Default type |
-| ------ | ------ |
-| `T` *extends* `object` | `object` |
-| `R` | `T` |
+### T
+
+`T` *extends* `object` = `object`
+
+### R
+
+`R` = `T`
 
 ## Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `db` | `IDBPDatabase`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\> | The IndexedDB database instance |
-| `storeName` | `StoreNames`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\> | The name of the object store to open |
-| `callback` | (`store`: \| `IDBPObjectStore`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>, \[`StoreNames`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\>\], `StoreNames`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\>, `"readwrite"`\> \| `null`) => `R` \| `Promise`\<`R`\> | Function to execute with the read-write store |
-| `logger?` | `Logger` | Optional logger for diagnostics |
+### db
+
+`IDBPDatabase`\<[`ObjectStore`](#../type-aliases/ObjectStore)\<`T`\>\>
+
+The IndexedDB database instance
+
+### storeName
+
+`StoreNames`\<[`ObjectStore`](#../type-aliases/ObjectStore)\<`T`\>\>
+
+The name of the object store to open
+
+### callback
+
+(`store`) => `R` \| `Promise`\<`R`\>
+
+Function to execute with the read-write store
+
+### logger?
+
+`Logger`
+
+Optional logger for diagnostics
 
 ## Returns
 
@@ -550,7 +697,7 @@ Opens a read-write transaction on the specified store and passes it to the callb
 
 The result of the callback
 
-  ### <a id="withStore"></a>withStore
+        ### <a id="withStore"></a>withStore
 
 [**@xylabs/indexed-db**](#../README)
 
@@ -558,13 +705,11 @@ The result of the callback
 
 ```ts
 function withStore<T, R, M>(
-   db: IDBPDatabase<ObjectStore<T>>, 
-   storeName: StoreNames<ObjectStore<T>>, 
-   callback: (store: 
-  | IDBPObjectStore<ObjectStore<T>, [StoreNames<ObjectStore<T>>], StoreNames<ObjectStore<T>>, M>
-  | null) => R | Promise<R>, 
-   mode: M, 
-logger?: Logger): Promise<R>;
+   db, 
+   storeName, 
+   callback, 
+   mode, 
+logger?): Promise<R>;
 ```
 
 Opens a transaction on the specified store with the given mode and passes the store to the callback.
@@ -572,21 +717,49 @@ If the store does not exist, the callback receives null.
 
 ## Type Parameters
 
-| Type Parameter | Default type |
-| ------ | ------ |
-| `T` *extends* `object` | `object` |
-| `R` | `T` |
-| `M` *extends* `"readonly"` \| `"readwrite"` | `"readonly"` |
+### T
+
+`T` *extends* `object` = `object`
+
+### R
+
+`R` = `T`
+
+### M
+
+`M` *extends* `"readonly"` \| `"readwrite"` = `"readonly"`
 
 ## Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `db` | `IDBPDatabase`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\> | The IndexedDB database instance |
-| `storeName` | `StoreNames`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\> | The name of the object store to open |
-| `callback` | (`store`: \| `IDBPObjectStore`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>, \[`StoreNames`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\>\], `StoreNames`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\>, `M`\> \| `null`) => `R` \| `Promise`\<`R`\> | Function to execute with the store (or null if it doesn't exist) |
-| `mode` | `M` | The transaction mode ('readonly' or 'readwrite') |
-| `logger?` | `Logger` | Optional logger for diagnostics |
+### db
+
+`IDBPDatabase`\<[`ObjectStore`](#../type-aliases/ObjectStore)\<`T`\>\>
+
+The IndexedDB database instance
+
+### storeName
+
+`StoreNames`\<[`ObjectStore`](#../type-aliases/ObjectStore)\<`T`\>\>
+
+The name of the object store to open
+
+### callback
+
+(`store`) => `R` \| `Promise`\<`R`\>
+
+Function to execute with the store (or null if it doesn't exist)
+
+### mode
+
+`M`
+
+The transaction mode ('readonly' or 'readwrite')
+
+### logger?
+
+`Logger`
+
+Optional logger for diagnostics
 
 ## Returns
 
@@ -594,55 +767,49 @@ If the store does not exist, the callback receives null.
 
 The result of the callback
 
-### interfaces
+      ### interfaces
 
-  ### <a id="ObjectStore"></a>ObjectStore
+        ### <a id="IndexDescription"></a>IndexDescription
 
 [**@xylabs/indexed-db**](#../README)
 
 ***
 
-Generic IndexedDB schema type that maps store names to their value types.
-
-## Type Parameters
+Description of index(es) to be created on a store
 
-| Type Parameter | Default type |
-| ------ | ------ |
-| `T` *extends* `EmptyObject` | `EmptyObject` |
+## Properties
 
-## Indexable
+### key
 
 ```ts
-[s: string]: T
+key: Record<string, IndexDirection>;
 ```
 
-### type-aliases
+The key(s) to index
 
-  ### <a id="IndexDescription"></a>IndexDescription
+***
 
-[**@xylabs/indexed-db**](#../README)
+### multiEntry?
+
+```ts
+optional multiEntry?: boolean;
+```
+
+Is the indexed value an array
 
 ***
 
+### unique?
+
 ```ts
-type IndexDescription = {
-  key: Record<string, IndexDirection>;
-  multiEntry?: boolean;
-  unique?: boolean;
-};
+optional unique?: boolean;
 ```
 
-Description of index(es) to be created on a store
-
-## Properties
+If true, the index must enforce uniqueness on the key
 
-| Property | Type | Description |
-| ------ | ------ | ------ |
-| <a id="key"></a> `key` | `Record`\<`string`, [`IndexDirection`](#IndexDirection)\> | The key(s) to index |
-| <a id="multientry"></a> `multiEntry?` | `boolean` | Is the indexed value an array |
-| <a id="unique"></a> `unique?` | `boolean` | If true, the index must enforce uniqueness on the key |
+      ### type-aliases
 
-  ### <a id="IndexDirection"></a>IndexDirection
+        ### <a id="IndexDirection"></a>IndexDirection
 
 [**@xylabs/indexed-db**](#../README)
 
@@ -654,56 +821,40 @@ type IndexDirection = -1 | 1;
 
 The index direction (1 for ascending, -1 for descending)
 
-### variables
-
-  ### <a id="IndexSeparator"></a>IndexSeparator
+        ### <a id="ObjectStore"></a>ObjectStore
 
 [**@xylabs/indexed-db**](#../README)
 
 ***
 
 ```ts
-const IndexSeparator: "-" = '-';
+type ObjectStore<T> = Record<string, T>;
 ```
 
-Separator used between key names when building standard index names.
+Generic IndexedDB schema type that maps store names to their value types.
 
+## Type Parameters
 
-Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
+### T
 
-## Maintainers
+`T` *extends* `EmptyObject` = `EmptyObject`
 
--   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
--   [Matt Jones](https://github.com/jonesmac)
--   [Joel Carter](https://github.com/JoelBCarter)
--   [Jordan Trouw](https://github.com/jordantrouw)
+      ### variables
 
-## License
+        ### <a id="IndexSeparator"></a>IndexSeparator
 
-> See the [LICENSE](LICENSE) file for license details
+[**@xylabs/indexed-db**](#../README)
 
-## Credits
+***
 
-[Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
+```ts
+const IndexSeparator: "-" = '-';
+```
+
+Separator used between key names when building standard index names.
 
-[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
 
-[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
-[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
 [npm-badge]: https://img.shields.io/npm/v/@xylabs/indexed-db.svg
 [npm-link]: https://www.npmjs.com/package/@xylabs/indexed-db
-[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
-[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
-[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
-[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
-[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
-[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
-
-[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/indexed-db
-[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/indexed-db
-
-[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/indexed-db/badge
-[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/indexed-db
-
-[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/indexed-db
-[socket-link]: https://socket.dev/npm/package/@xylabs/indexed-db
+[license-badge]: https://img.shields.io/npm/l/@xylabs/indexed-db.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE