Super Storage

Super Storage provides some helpers over cookie, localStorage and sessionStorage.

• 1Kb gzipped
• Store all type of values (objects and arrays)
• Default value when empty
• Prefix key
• Session kept between tabs

Install

Install npm package

1npm install @jaysalvat/super-storage

Usage

Module

1import { SuperCookie, SuperLocalStorage, SuperSessionStorage } from '@jaysalvat/super-storage'
2
3const settings = {
4  storagePrefix: 'myApp'
5}
6
7const superCookie = new SuperCookie(settings)
8const superLocalStorage = new SuperLocalStorage(settings)
9const superSessionStorage = new SuperSessionStorage(settings)

CDN

1<script src="https://unpkg.com/@jaysalvat/super-storage@latest/build/super-storage.umd.min.js"></script>
2<script>
3  const settings = {
4    storagePrefix: 'myApp'
5  }
6
7  const superCookie = new superStorage.SuperCookie(settings)
8  const superLocalStorage = new superStorage.SuperLocalStorage(settings)
9  const superSessionStorage = new superStorage.SuperSessionStorage(settings)
10</script>
11

Settings

Default settings.

1{
2  storagePrefix: '',
3  sessionCookieName: '__superStorageSession',
4  sessionNative: false,
5  sessionPrefix: 'session',
6  cookiePrefix: '',
7  cookieOptions: {
8    domain: null,
9    path: null,
10    maxAge: null,
11    expires: null,
12    secure: null
13  }
14}

SuperLocalStorage

setItem

Set a value

1superLocalStorage.setItem('key', 'data')

getItem

Get a value

1superLocalStorage.getItem('key')
2superLocalStorage.getItem('key', 'default value')

removeItem

Remove a value

1superLocalStorage.removeItem('key')

clear

Remove all value

1superLocalStorage.clear()

SuperSessionStorage

Note: If sessionNative set to false (default) in the settings, SuperSessionStorage will use the native localStorage to store values and a cookie in order to watch the browser session. This trick allows SuperSessionStorage to be kept between tabs and windows (unlike native sessionStorage)

setItem

Set a value

1superSessionStorage.setItem('key', 'data')

getItem

Get a value

1superSessionStorage.getItem('key')
2superSessionStorage.getItem('key', 'default value')

removeItem

Remove a value

1superSessionStorage.removeItem('key')

clear

Remove all value

1superSessionStorage.clear()

SuperCookie

setItem

Set a value. Options can be passed (merged with global settings cookieOptions)

1  const options = {
2    domain: null,
3    path: null,
4    maxAge: null,
5    expires: null,
6    secure: null
7  }

See Cookie specs.

1superCookie.setItem('key', 'data', [options]))

getItem

Get a value

1superCookie.getItem('key')
2superCookie.getItem('key', 'default value')

removeItem

Remove a value. Options path and domain can be passed.

1 const options = {
2    domain: 'mydomain.com',
3    path: '/',
4  }

1superCookie.removeItem('key', [options])

Dev

Dev mode

1npm run dev

Build

1npm run build

Lint

1npm run lint

Fix lint errors

1npm run lint:fix

Bump version and publish to NPM

1npm run release
2npm run release:patch
3npm run release:minor
4npm run release:major