Class WebStorageStore

A synchronous key-value store backed by Storage.

Implements

Store
SyncMapStore

Index

Constructors

Properties

Accessors

Methods

clear clearSync delete get keys set sync transaction

Constructors

constructor

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

Properties

`Protected`storage

storage: Storage

Accessors

name

get name(): string
What the file system using this store should be called. For example, tmpfs for an in memory store

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

Methods

clear

clear(): void
Empties the store completely.

Returns void
Deprecated
Implementation of Store.clear
- Defined in src/storage.ts:15

clearSync

clearSync(): void
Empties the store completely.

Returns void
Deprecated
Implementation of Store.clearSync
- Defined in src/storage.ts:19

delete

delete(key: number): void
Parameters
- key: number
Returns void
Implementation of SyncMapStore.delete
- Defined in src/storage.ts:50

get

get(key: number): undefined | Uint8Array
Parameters
- key: number
Returns undefined | Uint8Array
Implementation of SyncMapStore.get
- Defined in src/storage.ts:33

keys

keys(): Iterable<number>
Returns Iterable<number>
Implementation of SyncMapStore.keys
- Defined in src/storage.ts:29

set

set(key: number, data: Uint8Array): void
Parameters
- key: number
- data: Uint8Array
Returns void
Implementation of SyncMapStore.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:23

transaction

transaction(): SyncMapTransaction
Begins a new transaction.

Returns SyncMapTransaction
Implementation of Store.transaction
- Defined in src/storage.ts:25