Class PouchDbDocumentStore<T>

PouchDB implementation that uses a shared db for multiple PouchDbDocumentStores

Type Parameters

T extends {}

Hierarchy

PouchDbStore<T>
- PouchDbDocumentStore

Implements

storage.DocumentStore<T>

Index

Constructors

Properties

#docId db dbName destroyed idle logger

Methods

#getRev clearDB destroy fetchAllDocs forcePut get set toPouchDbDoc

Constructors

constructor

new PouchDbDocumentStore<T>(dbName: string, docId: string, logger: Logger): PouchDbDocumentStore<T>
Type Parameters
- T extends {}
Parameters
- dbName: string
  
  PouchDB database name
- docId: string
  
  unique document id within the db
- logger: Logger
  
  will silently swallow the errors if not set
Returns PouchDbDocumentStore<T>
Overrides PouchDbStore.constructor
- Defined in packages/wallet/src/persistence/pouchDbStores/PouchDbDocumentStore.ts:16

Properties

`Private` `Readonly` #docId

#docId: string

`Readonly` db

db: Database<T>

dbName

dbName: string

destroyed

destroyed: boolean = false

`Protected` idle

idle: Promise<void> = ...

`Protected` `Readonly` logger

logger: Logger

Methods

`Private` #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

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 DocumentStore.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: T): Observable<undefined | void>
Parameters
- docId: string
- doc: T
Returns Observable<undefined | void>
Inherited from PouchDbStore.forcePut
- Defined in packages/wallet/src/persistence/pouchDbStores/PouchDbStore.ts:72

get

get(): Observable<T>
Get the stored document.

Returns
- When have some document stored: emits once and completes.
- When no document is stored or the store is destroyed: completes without emitting.
Returns Observable<T>
Implementation of DocumentStore.get
- Defined in packages/wallet/src/persistence/pouchDbStores/PouchDbDocumentStore.ts:21

set

set(doc: T): Observable<void>
Store the document. Should never throw.

Returns
Emits undefined and completes. Completes without emitting if the store is destroyed.
Parameters
- doc: T
Returns Observable<void>
Implementation of DocumentStore.set
- Defined in packages/wallet/src/persistence/pouchDbStores/PouchDbDocumentStore.ts:34

`Protected` toPouchDbDoc

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

Generated using TypeDoc