Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Databases<C>

Aggegrates logic for interacting wth a set of PouchDB databases identified by resource collection name.

Type parameters

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private collections

collections: CollectionDatabases<C>

Private definitions

definitions: Definitions<C>

Private generateId

generateId: GenerateId<C>

Private ready

ready: Promise<void>

Methods

Protected Abstract createDatabase

delete

  • delete<N, T>(collectionName: N, references: (undefined | Pick<Record<T>, "_id">)[]): Promise<void>

every

  • every<N, T>(collectionName: N): Promise<SavedRecord<T>[]>

Private initialize

  • initialize(): Promise<void>

Private initializeCollection

  • initializeCollection<N>(collectionName: N, definition: Definition<C, N>): Promise<void>

retrieve

  • retrieve<N, T>(collectionName: N, records: (undefined | Pick<Record<T>, "_id">)[]): Promise<(undefined | SavedRecord<T>)[]>

save

  • save<N, T>(collectionName: N, records: (undefined | Record<T>)[], options?: { overwrite?: undefined | boolean }): Promise<(undefined | SavedRecord<T>)[]>

  • Type parameters

    • N: string

    • T

    Parameters

    • collectionName: N
    • records: (undefined | Record<T>)[]
    • options: { overwrite?: undefined | boolean } = ...
      • Optional overwrite?: undefined | boolean

    Returns Promise<(undefined | SavedRecord<T>)[]>

search

  • search<N, T>(collectionName: N, options: FindRequest<{}>): Promise<SavedRecord<T>[]>

Protected setup

  • setup(_: any): void

Generated using TypeDoc