@rtorcato/browser-common / sessionstorage
sessionstorage
Functions
isSessionStorageAvailable()
isSessionStorageAvailable():
boolean
Defined in: sessionstorage/index.ts:10
Checks if sessionStorage is available in the current environment.
Example
import { isSessionStorageAvailable } from '@rtorcato/browser-common/sessionstorage'
if (isSessionStorageAvailable()) restoreState()
Returns
boolean
True if sessionStorage is available, false otherwise.
setSessionStorage()
setSessionStorage(
key,value):void
Defined in: sessionstorage/index.ts:33
Sets a value in sessionStorage. Automatically stringifies objects.
Example
import { setSessionStorage, getSessionStorage } from '@rtorcato/browser-common/sessionstorage'
setSessionStorage('cart', { items: 3 })
const cart = getSessionStorage('cart')
Parameters
key
string
The key to set.
value
unknown
The value to store.
Returns
void
getSessionStorage()
getSessionStorage(
key):unknown
Defined in: sessionstorage/index.ts:50
Gets a value from sessionStorage and parses it as JSON.
Returns unknown — callers must narrow before use.
Example
import { getSessionStorage } from '@rtorcato/browser-common/sessionstorage'
const cart = getSessionStorage('cart') as { items: number } | null
Parameters
key
string
The key to retrieve.
Returns
unknown
The parsed value, or null if not found or not available.
removeSessionStorage()
removeSessionStorage(
key):void
Defined in: sessionstorage/index.ts:69
Removes a value from sessionStorage.
Example
import { removeSessionStorage } from '@rtorcato/browser-common/sessionstorage'
removeSessionStorage('cart')
Parameters
key
string
The key to remove.
Returns
void
clearSessionStorage()
clearSessionStorage():
void
Defined in: sessionstorage/index.ts:82
Clears all keys from sessionStorage.
Example
import { clearSessionStorage } from '@rtorcato/browser-common/sessionstorage'
clearSessionStorage()
Returns
void