Class PouchDbUtxoStore

PouchDB database that implements CollectionStore. Supports sorting by custom document _id

Hierarchy

PouchDbCollectionStore<Utxo>
- PouchDbUtxoStore

Index

Constructors

Properties

#computeDocId #updates$ db dbName destroyed idle logger observeAll

Methods

#getRev clearDB destroy fetchAllDocs forcePut getAll setAll toPouchDbDoc

Constructors

constructor

new PouchDbUtxoStore(props: PouchDbCollectionStoreProps<Utxo>, logger: Logger): PouchDbUtxoStore
Parameters
- props: PouchDbCollectionStoreProps<Utxo>
  
  store properties
- logger: Logger
  
  will silently swallow the errors if not set
Returns PouchDbUtxoStore
Inherited from PouchDbCollectionStore.constructor
- Defined in packages/wallet/src/persistence/pouchDbStores/PouchDbCollectionStore.ts:29

Properties

`Private` `Readonly` #computeDocId

#computeDocId: undefined | ComputePouchDbDocId<Utxo>

`Private` `Readonly` #updates$

#updates$: Subject<Utxo[]> = ...

`Protected` `Readonly` db

db: Database<Utxo>

dbName

dbName: string

destroyed

destroyed: boolean = false

`Protected` idle

idle: Promise<void> = ...

`Protected` `Readonly` logger

logger: Logger

observeAll

observeAll: (() => Observable<Utxo[]>)

Type declaration

- (): Observable<Utxo[]>
- Similar to getAll, but does not complete. Instead, emits every time the collection is updated (via this store object). Emits empty array when no documents are stored.
  
  Returns Observable<Utxo[]>

Methods

`Private` #getRev

#getRev(docId: string): Promise<undefined | string>
Parameters
- docId: string
Returns Promise<undefined | string>
Inherited from PouchDbCollectionStore.#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 PouchDbCollectionStore.clearDB
- Defined in packages/wallet/src/persistence/pouchDbStores/PouchDbStore.ts:23

destroy

destroy(): Observable<void>
Clear all resources used by the store.

Returns
Emits undefined and completes. Completes without emitting if store is already destroyed.

Returns Observable<void>
Inherited from PouchDbCollectionStore.destroy
- Defined in packages/wallet/src/persistence/pouchDbStores/PouchDbCollectionStore.ts:69

fetchAllDocs

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

`Protected` forcePut

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

getAll

getAll(): Observable<Utxo[]>
Get all stored documents.

Returns
- When have some documents stored: emits once and completes.
- When no documents are stored or the store is destroyed: completes without emitting.
Returns Observable<Utxo[]>
Inherited from PouchDbCollectionStore.getAll
- Defined in packages/wallet/src/persistence/pouchDbStores/PouchDbCollectionStore.ts:36

setAll

setAll(docs: Utxo[]): 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: Utxo[]
Returns Observable<void>
Inherited from PouchDbCollectionStore.setAll
- Defined in packages/wallet/src/persistence/pouchDbStores/PouchDbCollectionStore.ts:49

`Protected` toPouchDbDoc

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

Generated using TypeDoc