module@warp-drive/experiments/storage @experimental

Interface ReactiveStorage

interface ReactiveStorage {
  get length(): number;
  clear(): void;
  getItem(key: string): string | null;
  key(index: number): string | null;
  peekItem(key: string): string | null;
  removeItem(key: string): void;
  setEffect(key: string, fn: (value: EffectStorageEvent) => void): void;
  setItem(key: string, value: string): void;
}

Defined in: storage/storage.ts:143

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

• Storage

Methods

clear()

clear(): void;

Defined in: storage/storage.ts:334

Clears all keys from Storage, triggering reactivity

Returns

void

Implementation of

Storage.clear

---

getItem()

getItem(key: string): string | null;

Defined in: storage/storage.ts:228

Reactive access to Storage contents

Parameters

key

string

Returns

string | null

Implementation of

Storage.getItem

---

key()

key(index: number): string | null;

Defined in: storage/storage.ts:349

Reactive access to the key at the given index

Parameters

index

number

Returns

string | null

Implementation of

Storage.key

---

peekItem()

peekItem(key: string): string | null;

Defined in: storage/storage.ts:206

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

Parameters

key

string

Returns

string | null

---

removeItem()

removeItem(key: string): void;

Defined in: storage/storage.ts:312

Remove a value from Storage, triggering reactivity

Parameters

key

string

Returns

void

Implementation of

Storage.removeItem

---

setEffect()

setEffect(key: string, fn: (value: EffectStorageEvent) => void): void;

Defined in: storage/storage.ts:153

Parameters

key

string

fn

(value: EffectStorageEvent) => void

Returns

void

---

setItem()

setItem(key: string, value: string): void;

Defined in: storage/storage.ts:253

Set a value in Storage, triggering reactivity

Parameters

key

string

value

string

Returns

void

Implementation of

Storage.setItem

Properties

length

Get Signature

get length(): number;

Defined in: storage/storage.ts:199

Reactive access to the number of keys in Storage

Returns

number

Implementation of

Storage.length