Class IndexedDBMap<K, V>

A map that stores data in IndexedDB.

Type Parameters

K extends IDBValidKey
V

Hierarchy

DisposableCloseable
- IndexedDBMap

Implements

MaybeAsyncMap<K, V>
MaybeAsyncMapBatch<K, V>
AsyncIterable<[K, V]>
RangeQueryable<K, V>
Startable
Disposable

Index

Constructors

Properties

db? dbName storeName

Accessors

[rangeQueryable] [toStringTag] started

Methods

[asyncIterator] [dispose] clear close delete deleteMany entries get getMany has hasMany keys openDB openObjectStore set setMany start updateMany values

Constructors

constructor

new IndexedDBMap<K, V>(dbName, storeName): IndexedDBMap<K, V>
Type Parameters
- K extends IDBValidKey
- V
Parameters
- dbName: string
  Name of IndexedDB database to use.
- storeName: string
  Name of IndexedDB store to use.
Returns IndexedDBMap<K, V>
Overrides DisposableCloseable.constructor
- Defined in collections/src/impl/indexeddbmap.ts:11

Properties

`Private` `Optional` db

db?: IDBDatabase

`Private` `Readonly` dbName

dbName: string

Name of IndexedDB database to use.

`Private` `Readonly` storeName

storeName: string

Name of IndexedDB store to use.

Accessors

[rangeQueryable]

get [rangeQueryable](): true
Marker to indicate that this object is a RangeQueryable.

Returns true
Implementation of RangeQueryable.[rangeQueryable]
- Defined in collections/src/impl/indexeddbmap.ts:168

[toStringTag]

get [toStringTag](): string
Returns string
- Defined in collections/src/impl/indexeddbmap.ts:164

started

get started(): boolean
Returns if this has started.

Returns boolean
Implementation of Startable.started
- Defined in collections/src/impl/indexeddbmap.ts:20

Methods

[asyncIterator]

[asyncIterator](): AsyncIterableIterator<[K, V]>
Returns AsyncIterableIterator<[K, V]>
Implementation of AsyncIterable.[asyncIterator]
- Defined in collections/src/impl/indexeddbmap.ts:160

[dispose]

[dispose](): void
Returns void
Implementation of Disposable.[dispose]
Inherited from DisposableCloseable.[dispose]
- Defined in commons/dist/lifecycle/closeable.d.ts:10

clear

clear(): Promise<void>
Returns Promise<void>
- Defined in collections/src/impl/indexeddbmap.ts:45

close

close(): void
Closes this object and releases any system resource associated with it.

Returns void
Implementation of Startable.close
Overrides DisposableCloseable.close
- Defined in collections/src/impl/indexeddbmap.ts:30

delete

delete(key): Promise<void>
Deletes an entry by key from the map. Returns MaybePromise<unknown> to be compatible with ES Map.
Parameters
- key: K
Returns Promise<void>
Implementation of MaybeAsyncMap.delete
- Defined in collections/src/impl/indexeddbmap.ts:55

deleteMany

deleteMany(keys, options?): AsyncIterableIterator<undefined | Error>
Deletes the values with given keys.
Parameters
- keys: Iterable<K>
- Optional options: AbortOptions
Returns AsyncIterableIterator<undefined | Error>
Implementation of MaybeAsyncMapBatch.deleteMany
- Defined in collections/src/impl/indexeddbmap.ts:96

entries

entries(options?): AsyncIterableIterator<[K, V]>
Queries key-value pairs by given criteria.
Parameters
- Optional options: RangeQueryOptions<K>
Returns AsyncIterableIterator<[K, V]>
Implementation of RangeQueryable.entries
- Defined in collections/src/impl/indexeddbmap.ts:136

get

get(key): Promise<undefined | V>
Gets a value by key from the map.
Parameters
- key: K
Returns Promise<undefined | V>
Implementation of MaybeAsyncMap.get
- Defined in collections/src/impl/indexeddbmap.ts:35

getMany

getMany(keys, options?): AsyncIterableIterator<undefined | V>
Gets the list of data identified by given keys.
Parameters
- keys: Iterable<K>
- Optional options: AbortOptions
Returns AsyncIterableIterator<undefined | V>
Implementation of MaybeAsyncMapBatch.getMany
- Defined in collections/src/impl/indexeddbmap.ts:60

has

has(key): Promise<boolean>
Returns whether a key exists in the map.
Parameters
- key: K
Returns Promise<boolean>
Implementation of MaybeAsyncMap.has
- Defined in collections/src/impl/indexeddbmap.ts:41

hasMany

hasMany(keys, options?): AsyncIterableIterator<boolean>
Checks if given keys exist in the set.
Parameters
- keys: Iterable<K>
- Optional options: AbortOptions
Returns AsyncIterableIterator<boolean>
Implementation of MaybeAsyncMapBatch.hasMany
- Defined in collections/src/impl/indexeddbmap.ts:69

keys

keys(options?): AsyncIterableIterator<K>
Queries keys by given criteria.
Parameters
- Optional options: RangeQueryOptions<K>
Returns AsyncIterableIterator<K>
Implementation of RangeQueryable.keys
- Defined in collections/src/impl/indexeddbmap.ts:145

`Private` openDB

openDB(): Promise<IDBDatabase>
Returns Promise<IDBDatabase>
- Defined in collections/src/impl/indexeddbmap.ts:178

`Private` openObjectStore

openObjectStore(readwrite?): Promise<IDBObjectStore>
Parameters
- readwrite: boolean = false
Returns Promise<IDBObjectStore>
- Defined in collections/src/impl/indexeddbmap.ts:172

set

set(key, value): Promise<void>
Sets an entry in the map. Returns MaybePromise<unknown> to be compatible with ES Map.
Parameters
- key: K
- value: V
Returns Promise<void>
Implementation of MaybeAsyncMap.set
- Defined in collections/src/impl/indexeddbmap.ts:50

setMany

setMany(entries, options?): AsyncIterableIterator<undefined | Error>
Sets given list of entries.
Parameters
- entries: Iterable<[K, V]>
- Optional options: AbortOptions
Returns AsyncIterableIterator<undefined | Error>
Implementation of MaybeAsyncMapBatch.setMany
- Defined in collections/src/impl/indexeddbmap.ts:78

start

start(): Promise<void>
Starts this component.

Returns Promise<void>
Implementation of Startable.start
- Defined in collections/src/impl/indexeddbmap.ts:24

updateMany

updateMany(entries, options?): AsyncIterableIterator<undefined | Error>
Sets or deletes given list of entries.
Parameters
- entries: Iterable<[K, V?]>
- Optional options: AbortOptions
Returns AsyncIterableIterator<undefined | Error>
Implementation of MaybeAsyncMapBatch.updateMany
- Defined in collections/src/impl/indexeddbmap.ts:114

values

values(options?): AsyncIterableIterator<V>
Queries values by given criteria.
Parameters
- Optional options: RangeQueryOptions<K>
Returns AsyncIterableIterator<V>
Implementation of RangeQueryable.values
- Defined in collections/src/impl/indexeddbmap.ts:154

Generated using TypeDoc