Interface WriteTransaction

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

Hierarchy

ReadTransaction
- WriteTransaction

Index

Methods

Methods

del

del(key: string): Promise<boolean>

- Defined in transactions.ts:88
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>

Inherited from ReadTransaction.get
- Defined in transactions.ts:15
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>

Inherited from ReadTransaction.has
- Defined in transactions.ts:20
Determines if a single key is present in the database.

Parameters
- key: string
Returns Promise<boolean>

put

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

- Defined in transactions.ts:82
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

scan(options?: ScanOptions): Promise<Iterable<ScanItem>>

Inherited from ReadTransaction.scan
- Defined in transactions.ts:25
Gets many values from the database.

Parameters
- Optional options: ScanOptions
Returns Promise<Iterable<ScanItem>>

Generated using TypeDoc