user-storage v0.0.4

user-storage

1. Description
2. Installation
3. Usage
4. Methods
5. Git repository
6. Version

1. Description

user-storage is a service that gives access to the browser's local and session storage.

2. Installation

There are two ways to "import" this service into your project: 1. Install it as a NPM module:

npm install user-storage --save-dev

2. Download and include it in your project as plain JS file:

<!-- ./dist/storage.min.js is the path to the saved JS file -->
<script type="application/javascript" src="./dist/storage.min.js"></script>

3. Usage

If the service is used as NPM module, then you have to import it in your project:

import { Storage } from 'user-storage';

After importing the Storage service into your project, your'e ready to use its static properties local and session:

// set and read a key-value pair into/from localStorage:  
Storage.local.set('testKeyName', 'testKeyValue');  
console.log(Storage.local.get('testKeyName'));  
// Result: testKeyValue  
  
// set and read a key-value pair into/from sessionStorage:  
Storage.session.set('testKeyName', 'testKeyValue');  
console.log(Storage.session.get('testKeyName'));  
// Result: testKeyValue  

4. Methods

set(key: string, value: string): void

Method save a key/value pair in the browser's storage.
Return: void.
Example:

// save value into localStorage:  
Storage.local.set('testKeyName', 'testKeyValue');  
  
// save value into sessionStorage:  
Storage.session.set('testKeyName', 'testKeyValue');  

get(key: string): string

Method retrieves the value of a key from the browser's storage.
Return: value of the key is the key exists or null in case if there is no such key.
Example:

// get the key value from localStorage:  
Storage.local.get('testKeyName');  
  
// get the key value from sessionStorage:  
Storage.session.get('testKeyName');  

remove(key: string): void

Method removes the key/value pair from the browser's storage.
Return: void
Example:

// remove the key/value from localStorage:  
Storage.local.remove('testKeyName');  
  
// remove the key/value from sessionStorage:  
Storage.session.remove('testKeyName');  

isSet(key: string): boolean

Method determines if a key is set and is not null in the browser's storage.
Return: true if the key exists and is not null. false - if there is no such key (or is null).
Example:

// check if the key exists in localStorage:  
Storage.local.isSet('testKeyName');  
  
// check if the key exists in sessionStorage:  
Storage.session.isSet('testKeyName');  

clear(): void

Method clears completely the browser's storage.
Return: void.
Example:

// clear the localStorage:  
Storage.local.clear();  
  
// clear the sessionStorage:  
Storage.session.clear();  

5. Git repository

https://github.com/tvicpe/user-storage

6. Version

0.0.4