@meniga/storage
v6.1.37-alpha.0
Published
A library to use local and session storage securely
Downloads
426
Readme
@meniga/storage
Storage is a utility library for saving information in local and session storage and uses the store2
and shared-session-storage
dependencies.
Configuration
Default store
The default store used is the sessionStorage, but you can specify to use localStorage by default if you prefer.
Use the auth
config to do that by setting useLocalStorage
to true.
Multitab support
If you want to include multitab support when using session storage, set useSharedSessionStorage
to true in the auth.js
config.
Note: Multitab support is only needed when not using cookie-based authentication, such as the Meniga STS authentication service.
Example:
{
auth: {
useLocalStorage: false,
useSharedSessionStorage: true,
}
}
API
The getItem, setItem, removeItem and clearStorage methods work with the store set as default, while getLocalItem and getSessionItem (et al) work on specific stores.
Full list of API methods:
- getItem ( key )
- getLocalItem ( key )
- getSessionItem ( key )
- setItem ( key, value )
- setLocalItem ( key, value )
- setSessionItem ( key, value )
- removeItem ( key )
- removeLocalItem ( key )
- removeSessionItem ( key )
- clearStorage ()
- clearLocalStorage ()
- clearSessionStorage ()