Class PouchDbTransactionsStore

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

Hierarchy

PouchDbCollectionStore<HydratedTx>
- PouchDbTransactionsStore

Index

Constructors

constructor

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

Properties

`Private` `Readonly` #computeDocId

#computeDocId: ComputePouchDbDocId<HydratedTx>

`Private` `Readonly` #updates$

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

`Readonly` db

db: Database<HydratedTx>

dbName

dbName: string

destroyed

destroyed: boolean = false

`Protected` idle

idle: Promise<void> = ...

`Protected` `Readonly` logger

logger: Logger

observeAll

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

Type declaration

- (): Observable<HydratedTx[]>
- 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<HydratedTx[]>

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 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:90

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

getAll

getAll(): Observable<HydratedTx[]>
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<HydratedTx[]>
Inherited from PouchDbCollectionStore.getAll
- Defined in packages/wallet/src/persistence/pouchDbStores/PouchDbCollectionStore.ts:36

`Protected` 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

setAll

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

`Protected` toPouchDbDoc

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

Class PouchDbTransactionsStore

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

props: PouchDbCollectionStoreProps<HydratedTx>

logger: Logger

Returns PouchDbTransactionsStore

Properties

Private Readonly #computeDocId

Private Readonly #updates$

Readonly db

dbName

destroyed

Protected idle

Protected Readonly logger

observeAll

Type declaration

Returns Observable<HydratedTx[]>

Methods

clearDB

Returns Promise<void>

destroy

Returns

Returns Observable<void>

fetchAllDocs

Parameters

Optional options: Omit<Partial<AllDocsWithinRangeOptions>, "limit">

Returns Promise<{}[]>

Protected forcePut

Parameters

docId: string

doc: HydratedTx

Returns Observable<undefined | void>

getAll

Returns

Returns Observable<HydratedTx[]>

Protected getRev

Parameters

docId: string

Returns Promise<undefined | string>

setAll

Returns

Parameters

docs: HydratedTx[]

Returns Observable<void>

Protected toPouchDbDoc

Parameters

obj: HydratedTx

Returns HydratedTx

Settings

Member Visibility

Theme

`Private` `Readonly` #computeDocId

`Private` `Readonly` #updates$

`Readonly` db

`Protected` idle

`Protected` `Readonly` logger

`Optional` options: Omit<Partial<AllDocsWithinRangeOptions>, "limit">

`Protected` forcePut

`Protected` getRev

`Protected` toPouchDbDoc