Class PouchDbKeyValueStore<K, V>

PouchDB database that implements KeyValueStore by using keys as document _id

Type Parameters

K extends string | OpaqueString<any>
V extends {}

Hierarchy

PouchDbStore<V>
- PouchDbKeyValueStore

Implements

storage.KeyValueStore<K, V>

Index

Constructors

Properties

db dbName destroyed idle logger

Methods

clearDB destroy fetchAllDocs forcePut getRev getValues setAll setValue toPouchDbDoc

Constructors

constructor

new PouchDbKeyValueStore<K, V>(dbName: string, logger: Logger): PouchDbKeyValueStore<K, V>
Type Parameters
- K extends string | OpaqueString<any>
- V extends {}
Parameters
- dbName: string
  
  collection name
- logger: Logger
  
  will silently swallow the errors if not set
Returns PouchDbKeyValueStore<K, V>
Overrides PouchDbStore.constructor
- Defined in packages/wallet/src/persistence/pouchDbStores/PouchDbKeyValueStore.ts:18

Properties

`Readonly` db

db: Database<V>

dbName

dbName: string

destroyed

destroyed: boolean = false

`Protected` idle

idle: Promise<void> = ...

`Protected` `Readonly` logger

logger: Logger

Methods

clearDB

clearDB(): Promise<void>
Only used internally and for cleaning up after tests. If you need to use this for other purposes, consider adding clear() or destroy() to stores interfaces.

Returns Promise<void>
Inherited from PouchDbStore.clearDB
- Defined in packages/wallet/src/persistence/pouchDbStores/PouchDbStore.ts:23

destroy

destroy(): Observable<void>
Might all destroy other stores, if the underlying PouchDb database is shared.

Returns Observable<void>
Implementation of KeyValueStore.destroy

Inherited from PouchDbStore.destroy
- Defined in packages/wallet/src/persistence/pouchDbStores/PouchDbStore.ts:38

fetchAllDocs

fetchAllDocs(options?: Omit<Partial<AllDocsWithinRangeOptions>, "limit">): Promise<{}[]>
Parameters
- Optional options: Omit<Partial<AllDocsWithinRangeOptions>, "limit">
Returns Promise<{}[]>
Inherited from PouchDbStore.fetchAllDocs
- Defined in packages/wallet/src/persistence/pouchDbStores/PouchDbStore.ts:55

`Protected` forcePut

forcePut(docId: string, doc: V): Observable<undefined | void>
Parameters
- docId: string
- doc: V
Returns Observable<undefined | void>
Inherited from PouchDbStore.forcePut
- Defined in packages/wallet/src/persistence/pouchDbStores/PouchDbStore.ts:72

`Protected` getRev

getRev(docId: string): Promise<undefined | string>
Parameters
- docId: string
Returns Promise<undefined | string>
Inherited from PouchDbStore.getRev
- Defined in packages/wallet/src/persistence/pouchDbStores/PouchDbStore.ts:50

getValues

getValues(keys: K[]): Observable<V[]>
Get the stored documents by keys.

Returns
- When have all requested documents: emits once and completes.
- When at least one document is missing or the store is destroyed: completes without emitting.
Parameters
- keys: K[]
Returns Observable<V[]>
Implementation of KeyValueStore.getValues
- Defined in packages/wallet/src/persistence/pouchDbStores/PouchDbKeyValueStore.ts:42

setAll

setAll(docs: storage.KeyValueCollection<K, V>[]): Observable<void>
Store the full set of documents. getAll() after setAll(docs) should return the same set of 'docs'. Should never throw.

Returns
Emits undefined and completes. Completes without emitting if the store is destroyed.
Parameters
- docs: storage.KeyValueCollection<K, V>[]
Returns Observable<void>
Implementation of KeyValueStore.setAll
- Defined in packages/wallet/src/persistence/pouchDbStores/PouchDbKeyValueStore.ts:23

setValue

setValue(key: K, value: V): Observable<void>
Store the document. Should never throw.
Parameters
- key: K
- value: V
Returns Observable<void>
Implementation of KeyValueStore.setValue
- Defined in packages/wallet/src/persistence/pouchDbStores/PouchDbKeyValueStore.ts:62

`Protected` toPouchDbDoc

toPouchDbDoc(obj: V): V
Parameters
- obj: V
Returns V
Inherited from PouchDbStore.toPouchDbDoc
- Defined in packages/wallet/src/persistence/pouchDbStores/PouchDbStore.ts:46

Generated using TypeDoc