@xylabs/indexed-db 5.0.83 → 5.0.86

package/README.md

@@ -15,6 +15,8 @@
 
 Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
+
+
 ## Reference
 
 **@xylabs/indexed-db**
@@ -23,32 +25,42 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ## Classes
 
-- [IndexedDbKeyValueStore](#classes/IndexedDbKeyValueStore)
+| Class | Description |
+| ------ | ------ |
+| [IndexedDbKeyValueStore](#classes/IndexedDbKeyValueStore) | An IndexedDB key/value store. |
 
 ## Interfaces
 
-- [ObjectStore](#interfaces/ObjectStore)
+| Interface | Description |
+| ------ | ------ |
+| [ObjectStore](#interfaces/ObjectStore) | Generic IndexedDB schema type that maps store names to their value types. |
 
 ## Type Aliases
 
-- [IndexDirection](#type-aliases/IndexDirection)
-- [IndexDescription](#type-aliases/IndexDescription)
+| 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 |
 
 ## Variables
 
-- [IndexSeparator](#variables/IndexSeparator)
+| Variable | Description |
+| ------ | ------ |
+| [IndexSeparator](#variables/IndexSeparator) | Separator used between key names when building standard index names. |
 
 ## Functions
 
-- [buildStandardIndexName](#functions/buildStandardIndexName)
-- [checkDbNeedsUpgrade](#functions/checkDbNeedsUpgrade)
-- [createStoreDuringUpgrade](#functions/createStoreDuringUpgrade)
-- [getExistingIndexes](#functions/getExistingIndexes)
-- [withDb](#functions/withDb)
-- [withDbByVersion](#functions/withDbByVersion)
-- [withReadOnlyStore](#functions/withReadOnlyStore)
-- [withReadWriteStore](#functions/withReadWriteStore)
-- [withStore](#functions/withStore)
+| 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. |
 
 ### classes
 
@@ -62,13 +74,10 @@ An IndexedDB key/value store.
 
 ## Type Parameters
 
-### T
-
-`T` *extends* `DBSchema`
-
-### S
-
-`S` *extends* `StoreNames`\<`T`\>
+| Type Parameter |
+| ------ |
+| `T` *extends* `DBSchema` |
+| `S` *extends* `StoreNames`\<`T`\> |
 
 ## Implements
 
@@ -79,18 +88,15 @@ An IndexedDB key/value store.
 ### Constructor
 
 ```ts
-new IndexedDbKeyValueStore<T, S>(dbName, storeName): IndexedDbKeyValueStore<T, S>;
+new IndexedDbKeyValueStore<T, S>(dbName: string, storeName: S): IndexedDbKeyValueStore<T, S>;
 ```
 
 ### Parameters
 
-#### dbName
-
-`string`
-
-#### storeName
-
-`S`
+| Parameter | Type |
+| ------ | ------ |
+| `dbName` | `string` |
+| `storeName` | `S` |
 
 ### Returns
 
@@ -98,19 +104,10 @@ new IndexedDbKeyValueStore<T, S>(dbName, storeName): IndexedDbKeyValueStore<T, S
 
 ## Properties
 
-### dbName
-
-```ts
-readonly dbName: string;
-```
-
-***
-
-### storeName
-
-```ts
-readonly storeName: S;
-```
+| 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. |
 
 ## Methods
 
@@ -120,6 +117,8 @@ readonly storeName: S;
 optional clear(): Promise<void>;
 ```
 
+Removes all entries from the store.
+
 ### Returns
 
 `Promise`\<`void`\>
@@ -135,14 +134,16 @@ KeyValueStore.clear
 ### delete()
 
 ```ts
-delete(key): Promise<void>;
+delete(key: StoreKey<T, S>): Promise<void>;
 ```
 
-### Parameters
+Deletes the entry with the given key.
 
-#### key
+### Parameters
 
-`StoreKey`\<`T`, `S`\>
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `StoreKey`\<`T`, `S`\> | The key of the entry to delete |
 
 ### Returns
 
@@ -159,23 +160,23 @@ KeyValueStore.delete
 ### get()
 
 ```ts
-get(key): Promise<StoreValue<T, S> | undefined>;
+get(key: StoreKey<T, S>): Promise<StoreValue<T, S> | undefined>;
 ```
 
-Returns a promise that resolves to the value for the given key.
+Retrieves the value associated with the given key.
 
 ### Parameters
 
-#### key
-
-`StoreKey`\<`T`, `S`\>
-
-The key to get the value for.
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `StoreKey`\<`T`, `S`\> | The key to look up |
 
 ### Returns
 
 `Promise`\<`StoreValue`\<`T`, `S`\> \| `undefined`\>
 
+The value, or undefined if not found
+
 ### Implementation of
 
 ```ts
@@ -190,7 +191,7 @@ KeyValueStore.get
 optional keys(): Promise<StoreKey<T, S>[]>;
 ```
 
-The keys an array of keys.
+Returns all keys in the store.
 
 ### Returns
 
@@ -207,18 +208,17 @@ KeyValueStore.keys
 ### set()
 
 ```ts
-set(key, value): Promise<void>;
+set(key: StoreKey<T, S>, value: StoreValue<T, S>): Promise<void>;
 ```
 
-### Parameters
-
-#### key
-
-`StoreKey`\<`T`, `S`\>
+Sets a value for the given key, creating or updating the entry.
 
-#### value
+### Parameters
 
-`StoreValue`\<`T`, `S`\>
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `StoreKey`\<`T`, `S`\> | The key to set |
+| `value` | `StoreValue`\<`T`, `S`\> | The value to store |
 
 ### Returns
 
@@ -235,25 +235,29 @@ KeyValueStore.set
 ### withDb()
 
 ```ts
-withDb<R>(callback): Promise<R>;
+withDb<R>(callback: (db: IDBPDatabase<T>) => R | Promise<R>): Promise<R>;
 ```
 
-### Type Parameters
+Opens the underlying IndexedDB database and passes it to the callback.
 
-#### R
+### Type Parameters
 
-`R` = `StoreValue`\<`T`, `S`\>
+| Type Parameter | Default type |
+| ------ | ------ |
+| `R` | `StoreValue`\<`T`, `S`\> |
 
 ### Parameters
 
-#### callback
-
-(`db`) => `R` \| `Promise`\<`R`\>
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `callback` | (`db`: `IDBPDatabase`\<`T`\>) => `R` \| `Promise`\<`R`\> | Function to execute with the database |
 
 ### Returns
 
 `Promise`\<`R`\>
 
+The result of the callback
+
 ### functions
 
   ### <a id="buildStandardIndexName"></a>buildStandardIndexName
@@ -263,7 +267,7 @@ withDb<R>(callback): Promise<R>;
 ***
 
 ```ts
-function buildStandardIndexName(index): string;
+function buildStandardIndexName(index: IndexDescription): string;
 ```
 
 Given an index description, this will build the index
@@ -271,11 +275,9 @@ name in standard form
 
 ## Parameters
 
-### index
-
-[`IndexDescription`](#../type-aliases/IndexDescription)
-
-The index description
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `index` | [`IndexDescription`](#../type-aliases/IndexDescription) | The index description |
 
 ## Returns
 
@@ -291,29 +293,27 @@ The index name in standard form
 
 ```ts
 function checkDbNeedsUpgrade(
-   dbName, 
-   stores, 
-logger?): Promise<number>;
+   dbName: string, 
+   stores: Record<string, IndexDescription[]>, 
+logger?: Logger): Promise<number>;
 ```
 
-## Parameters
-
-### dbName
-
-`string`
-
-### stores
-
-`Record`\<`string`, [`IndexDescription`](#../type-aliases/IndexDescription)[]\>
+Checks whether any store in the database needs an upgrade and returns the appropriate version number.
 
-### logger?
+## Parameters
 
-`Logger`
+| 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 |
 
 ## Returns
 
 `Promise`\<`number`\>
 
+The version to open (current version + 1 if upgrade needed, otherwise current version)
+
   ### <a id="createStoreDuringUpgrade"></a>createStoreDuringUpgrade
 
 [**@xylabs/indexed-db**](#../README)
@@ -322,35 +322,28 @@ logger?): Promise<number>;
 
 ```ts
 function createStoreDuringUpgrade<DBTypes>(
-   db, 
-   storeName, 
-   indexes, 
-   logger?): void;
+   db: IDBPDatabase<DBTypes>, 
+   storeName: StoreNames<DBTypes>, 
+   indexes: IndexDescription[], 
+   logger?: Logger): void;
 ```
 
-## Type Parameters
+Creates an object store with the specified indexes during a version upgrade transaction.
 
-### DBTypes
+## Type Parameters
 
-`DBTypes` *extends* `unknown` = `unknown`
+| Type Parameter | Default type |
+| ------ | ------ |
+| `DBTypes` *extends* `unknown` | `unknown` |
 
 ## Parameters
 
-### db
-
-`IDBPDatabase`\<`DBTypes`\>
-
-### storeName
-
-`StoreNames`\<`DBTypes`\>
-
-### indexes
-
-[`IndexDescription`](#../type-aliases/IndexDescription)[]
-
-### logger?
-
-`Logger`
+| 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 |
 
 ## Returns
 
@@ -364,35 +357,35 @@ function createStoreDuringUpgrade<DBTypes>(
 
 ```ts
 function getExistingIndexes<T>(
-   db, 
-   storeName, 
-logger?): Promise<IndexDescription[] | null>;
+   db: 
+  | string
+  | IDBPDatabase<ObjectStore<T>>, 
+   storeName: StoreNames<ObjectStore<T>>, 
+logger?: Logger): Promise<IndexDescription[] | null>;
 ```
 
-## Type Parameters
+Retrieves the existing index descriptions for a store. Accepts either a database instance or a database name.
 
-### T
+## Type Parameters
 
-`T` *extends* `object` = `object`
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` *extends* `object` | `object` |
 
 ## Parameters
 
-### db
-
-`string` | `IDBPDatabase`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\>
-
-### storeName
-
-`StoreNames`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\>
-
-### logger?
-
-`Logger`
+| 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 |
 
 ## Returns
 
 `Promise`\<[`IndexDescription`](#../type-aliases/IndexDescription)[] \| `null`\>
 
+An array of index descriptions, or null if the store does not exist
+
   ### <a id="withDb"></a>withDb
 
 [**@xylabs/indexed-db**](#../README)
@@ -401,49 +394,39 @@ logger?): Promise<IndexDescription[] | null>;
 
 ```ts
 function withDb<DBTypes, R>(
-   dbName, 
-   callback, 
-   expectedIndexes?, 
-   logger?, 
-lock?): Promise<R>;
+   dbName: string, 
+   callback: (db: IDBPDatabase<DBTypes>) => R | Promise<R>, 
+   expectedIndexes?: Record<string, IndexDescription[]>, 
+   logger?: Logger, 
+lock?: boolean): Promise<R>;
 ```
 
-## Type Parameters
-
-### DBTypes
-
-`DBTypes` *extends* `unknown` = `unknown`
+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.
 
-### R
+## Type Parameters
 
-`R` = `object`
+| Type Parameter | Default type |
+| ------ | ------ |
+| `DBTypes` *extends* `unknown` | `unknown` |
+| `R` | `object` |
 
 ## Parameters
 
-### dbName
-
-`string`
-
-### callback
-
-(`db`) => `R` \| `Promise`\<`R`\>
-
-### expectedIndexes?
-
-`Record`\<`string`, [`IndexDescription`](#../type-aliases/IndexDescription)[]\>
-
-### logger?
-
-`Logger`
-
-### lock?
-
-`boolean` = `true`
+| 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) |
 
 ## Returns
 
 `Promise`\<`R`\>
 
+The result of the callback
+
   ### <a id="withDbByVersion"></a>withDbByVersion
 
 [**@xylabs/indexed-db**](#../README)
@@ -452,54 +435,41 @@ lock?): Promise<R>;
 
 ```ts
 function withDbByVersion<DBTypes, R>(
-   dbName, 
-   callback, 
-   version?, 
-   expectedIndexes?, 
-   logger?, 
-lock?): Promise<R>;
+   dbName: string, 
+   callback: (db: IDBPDatabase<DBTypes>) => R | Promise<R>, 
+   version?: number, 
+   expectedIndexes?: Record<string, IndexDescription[]>, 
+   logger?: Logger, 
+lock?: boolean): Promise<R>;
 ```
 
-## Type Parameters
-
-### DBTypes
+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.
 
-`DBTypes` *extends* `unknown` = `unknown`
-
-### R
+## Type Parameters
 
-`R` = `object`
+| Type Parameter | Default type |
+| ------ | ------ |
+| `DBTypes` *extends* `unknown` | `unknown` |
+| `R` | `object` |
 
 ## Parameters
 
-### dbName
-
-`string`
-
-### callback
-
-(`db`) => `R` \| `Promise`\<`R`\>
-
-### version?
-
-`number`
-
-### expectedIndexes?
-
-`Record`\<`string`, [`IndexDescription`](#../type-aliases/IndexDescription)[]\>
-
-### logger?
-
-`Logger`
-
-### lock?
-
-`boolean` = `true`
+| 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) |
 
 ## Returns
 
 `Promise`\<`R`\>
 
+The result of the callback
+
   ### <a id="withReadOnlyStore"></a>withReadOnlyStore
 
 [**@xylabs/indexed-db**](#../README)
@@ -508,44 +478,38 @@ lock?): Promise<R>;
 
 ```ts
 function withReadOnlyStore<T, R>(
-   db, 
-   storeName, 
-   callback, 
-logger?): Promise<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>;
 ```
 
-## Type Parameters
-
-### T
+Opens a read-only transaction on the specified store and passes it to the callback.
 
-`T` *extends* `object` = `object`
-
-### R
+## Type Parameters
 
-`R` = `T`
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` *extends* `object` | `object` |
+| `R` | `T` |
 
 ## Parameters
 
-### db
-
-`IDBPDatabase`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\>
-
-### storeName
-
-`StoreNames`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\>
-
-### callback
-
-(`store`) => `R` \| `Promise`\<`R`\>
-
-### logger?
-
-`Logger`
+| 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 |
 
 ## Returns
 
 `Promise`\<`R`\>
 
+The result of the callback
+
   ### <a id="withReadWriteStore"></a>withReadWriteStore
 
 [**@xylabs/indexed-db**](#../README)
@@ -554,44 +518,38 @@ logger?): Promise<R>;
 
 ```ts
 function withReadWriteStore<T, R>(
-   db, 
-   storeName, 
-   callback, 
-logger?): Promise<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>;
 ```
 
-## Type Parameters
-
-### T
+Opens a read-write transaction on the specified store and passes it to the callback.
 
-`T` *extends* `object` = `object`
-
-### R
+## Type Parameters
 
-`R` = `T`
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` *extends* `object` | `object` |
+| `R` | `T` |
 
 ## Parameters
 
-### db
-
-`IDBPDatabase`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\>
-
-### storeName
-
-`StoreNames`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\>
-
-### callback
-
-(`store`) => `R` \| `Promise`\<`R`\>
-
-### logger?
-
-`Logger`
+| 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 |
 
 ## Returns
 
 `Promise`\<`R`\>
 
+The result of the callback
+
   ### <a id="withStore"></a>withStore
 
 [**@xylabs/indexed-db**](#../README)
@@ -600,53 +558,42 @@ logger?): Promise<R>;
 
 ```ts
 function withStore<T, R, M>(
-   db, 
-   storeName, 
-   callback, 
-   mode, 
-logger?): Promise<R>;
+   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>;
 ```
 
-## Type Parameters
-
-### T
-
-`T` *extends* `object` = `object`
-
-### R
+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.
 
-`R` = `T`
-
-### M
+## Type Parameters
 
-`M` *extends* `"readonly"` \| `"readwrite"` = `"readonly"`
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` *extends* `object` | `object` |
+| `R` | `T` |
+| `M` *extends* `"readonly"` \| `"readwrite"` | `"readonly"` |
 
 ## Parameters
 
-### db
-
-`IDBPDatabase`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\>
-
-### storeName
-
-`StoreNames`\<[`ObjectStore`](#../interfaces/ObjectStore)\<`T`\>\>
-
-### callback
-
-(`store`) => `R` \| `Promise`\<`R`\>
-
-### mode
-
-`M`
-
-### logger?
-
-`Logger`
+| 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 |
 
 ## Returns
 
 `Promise`\<`R`\>
 
+The result of the callback
+
 ### interfaces
 
   ### <a id="ObjectStore"></a>ObjectStore
@@ -655,11 +602,13 @@ logger?): Promise<R>;
 
 ***
 
-## Type Parameters
+Generic IndexedDB schema type that maps store names to their value types.
 
-### T
+## Type Parameters
 
-`T` *extends* `EmptyObject` = `EmptyObject`
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` *extends* `EmptyObject` | `EmptyObject` |
 
 ## Indexable
 
@@ -676,40 +625,22 @@ logger?): Promise<R>;
 ***
 
 ```ts
-type IndexDescription = object;
+type IndexDescription = {
+  key: Record<string, IndexDirection>;
+  multiEntry?: boolean;
+  unique?: boolean;
+};
 ```
 
 Description of index(es) to be created on a store
 
 ## Properties
 
-### key
-
-```ts
-key: Record<string, IndexDirection>;
-```
-
-The key(s) to index
-
-***
-
-### multiEntry?
-
-```ts
-optional multiEntry: boolean;
-```
-
-Is the indexed value an array
-
-***
-
-### unique?
-
-```ts
-optional unique: boolean;
-```
-
-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 |
 
   ### <a id="IndexDirection"></a>IndexDirection
 
@@ -735,6 +666,8 @@ The index direction (1 for ascending, -1 for descending)
 const IndexSeparator: "-" = '-';
 ```
 
+Separator used between key names when building standard index names.
+
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)