Class WebStorageStore

A synchronous key-value store backed by Storage.

Implements

Store
SimpleSyncStore

Index

Constructors

Properties

Accessors

Methods

clear clearSync delete get keys set sync transaction

Constructors

constructor

new WebStorageStore(storage): WebStorageStore
Parameters
- storage: Storage
Returns WebStorageStore
- Defined in src/Storage.ts:12

Properties

`Protected`storage

storage: Storage

Accessors

name

get name(): string
The name of the store.

Returns string
Implementation of Store.name
- Defined in src/Storage.ts:8

Methods

clear

clear(): void
Empties the store completely.

Returns void
Implementation of Store.clear
- Defined in src/Storage.ts:14

clearSync

clearSync(): void
Empties the store completely.

Returns void
Implementation of Store.clearSync
- Defined in src/Storage.ts:18

delete

delete(key): void
Parameters
- key: bigint
Returns void
Implementation of SimpleSyncStore.delete
- Defined in src/Storage.ts:50

get

get(key): undefined | Uint8Array
Parameters
- key: bigint
Returns undefined | Uint8Array
Implementation of SimpleSyncStore.get
- Defined in src/Storage.ts:33

keys

keys(): Iterable<bigint>
Returns Iterable<bigint>
Implementation of SimpleSyncStore.keys
- Defined in src/Storage.ts:29

set

set(key, data): void
Parameters
- key: bigint
- data: Uint8Array
Returns void
Implementation of SimpleSyncStore.set
- Defined in src/Storage.ts:42

sync

sync(): Promise<void>
Syncs the store

Returns Promise<void>
Implementation of Store.sync
- Defined in src/Storage.ts:22

transaction

transaction(): SimpleTransaction
Begins a new transaction.

Returns SimpleTransaction
Implementation of Store.transaction
- Defined in src/Storage.ts:24