Interface IOpts

interface IOpts {
    dbName?: string;
    indexedDB?: IDBFactory;
    localStorage?: Storage;
    workerFactory?: () => Worker;
}

Hierarchy (View Summary)

IOpts
- IOpts

Index

Properties

dbName? indexedDB? localStorage? workerFactory?

Properties

`Optional`dbName

dbName?: string

Optional database name. The same name must be used to open the same database.

`Optional`indexedDB

indexedDB?: IDBFactory

The Indexed DB interface e.g. window.indexedDB

`Optional`localStorage

localStorage?: Storage

The local storage instance to persist some forms of data such as tokens. Rooms will NOT be stored.

`Optional`workerFactory

workerFactory?: () => Worker

Optional factory to spin up a Worker to execute the IDB transactions within.