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:13

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:9

Methods

clear

clear(): void
Returns void
- Defined in src/storage.ts:16

clearSync

clearSync(): void
Returns void
- Defined in src/storage.ts:20

delete

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

get

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

keys

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

set

set(key: number, data: Uint8Array): void
Parameters
- key: number
- data: Uint8Array
Returns void
Implementation of SyncMapStore.set
- Defined in src/storage.ts:43

sync

sync(): Promise<void>
Syncs the store

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

transaction

transaction(): SyncMapTransaction
Begins a new transaction.

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