Interface Adapter<C>

Low-level interface for PouchDB adapters - allows basic CRUD operations for arbitrary (weakly-typed) data types.

Type Parameters

Hierarchy

  • Adapter

Implemented by

Methods

  • Delete saved records

    Type Parameters

    • N extends string

    • T

    Parameters

    • collectionName: N
    • references: (undefined | RecordReference<T>)[]

      Can be sparse

    Returns Promise<void>

  • Retrieve and return every saved record for a given collection name

    Type Parameters

    • N extends string

    • T

    Parameters

    • collectionName: N

    Returns Promise<SavedRecord<T>[]>

  • Retrieve specific saved records of a given collection name by list of references.

    Type Parameters

    • N extends string

    • T

    Parameters

    • collectionName: N
    • references: (undefined | RecordReference<T>)[]

      Can be sparse

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

    • Items in list correspond to references by index (also sparse)
  • Create or update saved records of a given collection name.

    Type Parameters

    • N extends string

    • T

    Parameters

    • collectionName: N
    • records: (undefined | Record<T>)[]

      Can be sparse

    • options: {
          overwrite?: boolean;
      }
      • Optional overwrite?: boolean

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

    • Items in list correspond to records by index (also sparse)
  • Search for saved records of a given collection name by PouchDB find syntax

    Type Parameters

    • N extends string

    • T

    Parameters

    • collectionName: N
    • options: FindRequest<{}>

    Returns Promise<SavedRecord<T>[]>

Generated using TypeDoc