@rtorcato/browser-common / localstorage
localstorage
Functions
isLocalStorageAvailable()
isLocalStorageAvailable():
boolean
Defined in: localstorage/index.ts:10
Checks if localStorage is available in the current environment.
Example
import { isLocalStorageAvailable } from '@rtorcato/browser-common/localstorage'
if (isLocalStorageAvailable()) loadPrefs()
Returns
boolean
True if localStorage is available, false otherwise.
setLocalStorage()
setLocalStorage(
key,value):void
Defined in: localstorage/index.ts:33
Sets a value in localStorage. Automatically stringifies objects.
Example
import { setLocalStorage, getLocalStorage } from '@rtorcato/browser-common/localstorage'
setLocalStorage('prefs', { theme: 'dark' })
const prefs = getLocalStorage('prefs')
Parameters
key
string
The key to set.
value
unknown
The value to store.
Returns
void
getLocalStorage()
getLocalStorage(
key):unknown
Defined in: localstorage/index.ts:50
Gets a value from localStorage and parses it as JSON.
Returns unknown — callers must narrow before use.
Example
import { getLocalStorage } from '@rtorcato/browser-common/localstorage'
const value = getLocalStorage('prefs') as { theme: string } | null
Parameters
key
string
The key to retrieve.
Returns
unknown
The parsed value, or null if not found or not available.
removeLocalStorage()
removeLocalStorage(
key):void
Defined in: localstorage/index.ts:69
Removes a value from localStorage.
Example
import { removeLocalStorage } from '@rtorcato/browser-common/localstorage'
removeLocalStorage('prefs')
Parameters
key
string
The key to remove.
Returns
void
clearLocalStorage()
clearLocalStorage():
void
Defined in: localstorage/index.ts:82
Clears all keys from localStorage.
Example
import { clearLocalStorage } from '@rtorcato/browser-common/localstorage'
clearLocalStorage()
Returns
void