Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WriteTransaction

WriteTransactions are used with Replicache.register and allows read and write operations on the database.

Hierarchy

Index

Methods

Methods

del

  • del(key: string): Promise<boolean>

  • Removes a key and its value from the database. Returns true if there was a key to remove.

    Parameters

    • key: string

    Returns Promise<boolean>

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>

put

  • put(key: string, value: JSONValue | ToJSON): Promise<void>

  • Sets a single value in the database. The value will be encoded using JSON.stringify.

    Parameters

    • key: string
    • value: JSONValue | ToJSON

    Returns Promise<void>

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.

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

    Parameters

    • Optional options: ScanOptions

    Returns ScanResult

Generated using TypeDoc