@xylabs/indexed-db

[![logo][]](https://xylabs.com)

[![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

Reference

@xylabs/indexed-db

*

Classes

- IndexedDbKeyValueStore

Interfaces

- ObjectStore

Type Aliases

- IndexDirection
- IndexDescription

Variables

- IndexSeparator

Functions

- buildStandardIndexName
- checkDbNeedsUpgrade
- createStoreDuringUpgrade
- getExistingIndexes
- withDb
- withDbByVersion
- withReadOnlyStore
- withReadWriteStore
- withStore

$3

### IndexedDbKeyValueStore

@xylabs/indexed-db

*

An IndexedDB key/value store.

Type Parameters

$3

T extends DBSchema

$3

S extends StoreNames\<T\>

Implements

- KeyValueStore\<StoreValue\<T, S\>, StoreKey\<T, S\>\>

Constructors

$3

``ts
new IndexedDbKeyValueStore(dbName, storeName): IndexedDbKeyValueStore;
`

$3

#### dbName

string

#### storeName

S

$3

IndexedDbKeyValueStore\<T, S\>

Properties

$3

`ts
readonly dbName: string;
`

*

$3

`ts
readonly storeName: S;
`

Methods

$3

`ts
optional clear(): Promise;
`

$3

Promise\<void\>

$3

`ts
KeyValueStore.clear
`

*

$3

`ts
delete(key): Promise;
`

$3

#### key

StoreKey\<T, S\>

$3

Promise\<void\>

$3

`ts
KeyValueStore.delete
`

*

$3

`ts
get(key): Promise>;
`

Returns a promise that resolves to the value for the given key.

$3

#### key

StoreKey\<T, S\>

The key to get the value for.

$3

Promise\<undefined \| StoreValue\<T, S\>\>

$3

`ts
KeyValueStore.get
`

*

$3

`ts
optional keys(): Promise[]>;
`

The keys an array of keys.

$3

Promise\<StoreKey\<T, S\>[]\>

$3

`ts
KeyValueStore.keys
`

*

$3

`ts
set(key, value): Promise;
`

$3

#### key

StoreKey\<T, S\>

#### value

StoreValue\<T, S\>

$3

Promise\<void\>

$3

`ts
KeyValueStore.set
`

*

$3

`ts
withDb(callback): Promise;
`

$3

#### R

R = StoreValue\<T, S\>

$3

#### callback

(db) => R \| Promise\<R\>

$3

Promise\<R\>

$3

### buildStandardIndexName

@xylabs/indexed-db

*

`ts
function buildStandardIndexName(index): string;
`

Given an index description, this will build the index
name in standard form

Parameters

$3

IndexDescription

The index description

Returns

string

The index name in standard form

### checkDbNeedsUpgrade

@xylabs/indexed-db

*

`ts
function checkDbNeedsUpgrade(
dbName,
stores,
logger?): Promise;
`

Parameters

$3

string

$3

Record\<string, IndexDescription[]\>

$3

Logger

Returns

Promise\<number\>

### createStoreDuringUpgrade

@xylabs/indexed-db

*

`ts
function createStoreDuringUpgrade(
db,
storeName,
indexes,
logger?): void;
`

Type Parameters

$3

DBTypes extends unknown = unknown

Parameters

$3

IDBPDatabase\<DBTypes\>

$3

StoreNames\<DBTypes\>

$3

IndexDescription[]

$3

Logger

Returns

void

### getExistingIndexes

@xylabs/indexed-db

*

`ts
function getExistingIndexes(
db,
storeName,
logger?): Promise;
`

Type Parameters

$3

T extends object = object

Parameters

$3

string | IDBPDatabase\<ObjectStore\<T\>\>

$3

StoreNames\<ObjectStore\<T\>\>

$3

Logger

Returns

Promise\<null \| IndexDescription[]\>

### withDb

@xylabs/indexed-db

*

`ts
function withDb(
dbName,
callback,
expectedIndexes?,
logger?,
lock?): Promise;
`

Type Parameters

$3

DBTypes extends unknown = unknown

$3

R = object

Parameters

$3

string

$3

(db) => R \| Promise\<R\>

$3

Record\<string, IndexDescription[]\>

$3

Logger

$3

boolean = true

Returns

Promise\<R\>

### withDbByVersion

@xylabs/indexed-db

*

`ts
function withDbByVersion(
dbName,
callback,
version?,
expectedIndexes?,
logger?,
lock?): Promise;
`

Type Parameters

$3

DBTypes extends unknown = unknown

$3

R = object

Parameters

$3

string

$3

(db) => R \| Promise\<R\>

$3

number

$3

Record\<string, IndexDescription[]\>

$3

Logger

$3

boolean = true

Returns

Promise\<R\>

### withReadOnlyStore

@xylabs/indexed-db

*

`ts
function withReadOnlyStore(
db,
storeName,
callback,
logger?): Promise;
`

Type Parameters

$3

T extends object = object

$3

R = T

Parameters

$3

IDBPDatabase\<ObjectStore\<T\>\>

$3

StoreNames\<ObjectStore\<T\>\>

$3

(store) => R \| Promise\<R\>

$3

Logger

Returns

Promise\<R\>

### withReadWriteStore

@xylabs/indexed-db

*

`ts
function withReadWriteStore(
db,
storeName,
callback,
logger?): Promise;
`

Type Parameters

$3

T extends object = object

$3

R = T

Parameters

$3

IDBPDatabase\<ObjectStore\<T\>\>

$3

StoreNames\<ObjectStore\<T\>\>

$3

(store) => R \| Promise\<R\>

$3

Logger

Returns

Promise\<R\>

### withStore

@xylabs/indexed-db

*

`ts
function withStore(
db,
storeName,
callback,
mode,
logger?): Promise;
`

Type Parameters

$3

T extends object = object

$3

R = T

$3

M extends "readonly" \| "readwrite" = "readonly"

Parameters

$3

IDBPDatabase\<ObjectStore\<T\>\>

$3

StoreNames\<ObjectStore\<T\>\>

$3

(store) => R \| Promise\<R\>

$3

M

$3

Logger

Returns

Promise\<R\>

$3

### ObjectStore

@xylabs/indexed-db

*

Type Parameters

$3

T extends EmptyObject = EmptyObject

Indexable

`ts
[s: string]: T
`

$3

### IndexDescription

@xylabs/indexed-db

*

`ts
type IndexDescription = object;
`

Description of index(es) to be created on a store

Properties

$3

`ts
key: Record;
`

The key(s) to index

*

$3

`ts
optional multiEntry: boolean;
`

Is the indexed value an array

*

$3

`ts
optional unique: boolean;
`

If true, the index must enforce uniqueness on the key

### IndexDirection

@xylabs/indexed-db

*

`ts
type IndexDirection = -1 | 1;
`

The index direction (1 for ascending, -1 for descending)

$3

### IndexSeparator

@xylabs/indexed-db

*

`ts
const IndexSeparator: "-" = '-';
``

Part of sdk-js

Maintainers

- Arie Trouw (arietrouw.com)
- Matt Jones
- Joel Carter
- Jordan Trouw

License

> See the LICENSE file for license details

Credits

Made with 🔥 and ❄️ by XYLabs

[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