SOT Storage Module

library to handle how to access local and session storage, with the ability to imitate amplifyjs storage structure.

Quick Start

Installation

In sot_pages repo

npm run package-setup install @sot/storage <Page-Path>

Regular repo

npm install @sot/storage

Importing

ES Modules

import { Storage } from '@sot/storage/dist/js';

Included Directly

If you want to use the library on a page that doesn't have a build environment, you can directly copy the index.js in the dist folder (you can change the name to sot-storage.min.js) file into the vendors folder on the page to use and import it in the HTML as:

<script src="js/vendors/sot-storage.min.js"></script>

Usage

Please refer to the documentation page for the Storage on Backstage to learn more about the library.

Set:

1. Local Storage (Legacy):

Storage.local.set('yourKey', value);

2. Local Storage (Non-Legacy):

Storage.local.set('yourKey', value, false);

3. Session Storage:

Storage.session.set('yourKey', value);

Get:

1. Local Storage (Legacy):

Storage.local.get('yourKey');

2. Local Storage (Non-Legacy):

Storage.local.get('yourKey', false);

3. Session Storage:

Storage.session.get('yourKey');

Remove:

1. Local Storage (Legacy):

Storage.local.remove('yourKey');

2. Local Storage (Non-Legacy):

Storage.local.remove('yourKey', false);

3. Session Storage:

Storage.session.remove('yourKey');

Clear

Usually, you will only use this function at the beginning of a flow, for example on a Landing page. Be careful because this function removes everything from the local or session storage (from the domain where you're using it) so if you need to keep data for another process you should use Storage.local.remove() or Storage.session.remove() instead.

1. Local Storage:

Storage.local.clear();

2. Session Storage:

Storage.session.clear();

Contributing

To contribute, follow the instructions in the main sot_components readme at https://github.com/ltvco/sot_components.