Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ReadTransaction

ReadTransactions are used with Replicache.query and allows read operations on the database.

Hierarchy

Implemented by

Index

Methods

Methods

get

  • get(key: string): Promise<JSONValue | undefined>
  • Get a single value from the database. If the key is not present this returns undefined.

    Parameters

    • key: string

    Returns Promise<JSONValue | undefined>

has

  • has(key: string): Promise<boolean>
  • Determines if a single key is present in the database.

    Parameters

    • key: string

    Returns Promise<boolean>

scan

  • Gets many values from the database. This returns a ScanResult which implements AsyncIterable. It also has methods to iterate over the keys and entries.

    If options has an indexName, then this does a scan over an index with that name. A scan over an index uses a tuple for the key consisting of [secondary: string, primary: string].

    If the ScanResult is used after the ReadTransaction has been closed it will throw a TransactionClosedError.

    Type parameters

    Parameters

    • Optional options: O

    Returns ScanResult<K>

scanAll

  • scanAll<O, K>(options?: O): Promise<[][]>
  • Convenience form of scan() which returns all the entries as an array.

    Type parameters

    Parameters

    • Optional options: O

    Returns Promise<[][]>

Generated using TypeDoc