Class LocalStorageStore

LocalStorage state with cross-tab sync

Implements

PersistenceStore

Index

Constructors

Methods

getItem removeItem setItem subscribe?

Constructors

constructor

new LocalStorageStore(storage?: Storage): LocalStorageStore
Parameters
- storage: Storage = window.localStorage
Returns LocalStorageStore

Methods

getItem

getItem(k: string): string | null
Retrieves the value associated with the given key.
Parameters
- k: string
  The key to retrieve.
Returns string | null

Implementation of PersistenceStore.getItem

removeItem

removeItem(k: string): void
Removes the value associated with the given key.
Parameters
- k: string
  The key to remove.
Returns void

Implementation of PersistenceStore.removeItem

setItem

setItem(k: string, v: string): void
Sets the value for the given key.
Parameters
- k: string
  The key to set.
- v: string
  The value to associate with the key.
Returns void

Implementation of PersistenceStore.setItem

`Optional`subscribe

subscribe?(onExternalChange: (changedKey: string) => void): () => void
Subscribes to external changes for cross-tab synchronization.
Parameters
- onExternalChange: (changedKey: string) => void
  Callback invoked when a key changes externally.
Returns () => void

Remarks
Not all state implementations support cross-tab subscription (may no-op)

Implementation of PersistenceStore.subscribe