Skip to content
module@warp-drive/experiments/storage @experimental

Interface ReactiveStorage ​

Defined in: storage/storage.ts:116

A reactive wrapper around the Web Storage API (localStorage/sessionStorage) that provides signal-based access to storage items and length.

Will automatically update when storage events occur in other tabs/windows.

Implements ​

Methods ​

clear() ​

ts
clear(): void;

Defined in: storage/storage.ts:309

Clears all keys from Storage, triggering reactivity

Returns ​

void

Implementation of ​

ts
Storage.clear

getItem() ​

ts
getItem(key): string | null;

Defined in: storage/storage.ts:203

Reactive access to Storage contents

Parameters ​

key ​

string

Returns ​

string | null

Implementation of ​

ts
Storage.getItem

key() ​

ts
key(index): string | null;

Defined in: storage/storage.ts:324

Reactive access to the key at the given index

Parameters ​

index ​

number

Returns ​

string | null

Implementation of ​

ts
Storage.key

peekItem() ​

ts
peekItem(key): string | null;

Defined in: storage/storage.ts:181

Non-reactive way to peek the current value of a key in Storage

Parameters ​

key ​

string

Returns ​

string | null


removeItem() ​

ts
removeItem(key): void;

Defined in: storage/storage.ts:287

Remove a value from Storage, triggering reactivity

Parameters ​

key ​

string

Returns ​

void

Implementation of ​

ts
Storage.removeItem

setEffect() ​

ts
setEffect(key, fn): void;

Defined in: storage/storage.ts:126

Parameters ​

key ​

string

fn ​

(value) => void

Returns ​

void


setItem() ​

ts
setItem(key, value): void;

Defined in: storage/storage.ts:228

Set a value in Storage, triggering reactivity

Parameters ​

key ​

string

value ​

string

Returns ​

void

Implementation of ​

ts
Storage.setItem

Properties ​

length ​

Get Signature ​

ts
get length(): number;

Defined in: storage/storage.ts:174

Reactive access to the number of keys in Storage

Returns ​

number

Implementation of ​

ts
Storage.length

Released under the MIT License.