Class: LocalStorage

var LocalStorage = caph.require('storage.LocalStorage');
 var localstorage = new LocalStorage();

Methods

clearAll()

Clears all key/value pairs in the localStorage

Since:

• 2.0.0

Example

var LocalStorage = caph.require('storage.LocalStorage');
 var localstorage = new LocalStorage();
 localstorage.clearAll();

get(key) → {String|Boolean}

Gets the item, It is searched by given parameter, key

Parameters:

Name	Type	Description
key	String	The key, localstorage gets the item based on this key

Since:

• 2.0.0

Returns:

item The item is value in localstorage that is corresponding with key, If the item is not exist, return false.

Type

String | Boolean

Example

var LocalStorage = caph.require('storage.LocalStorage');
 var localstorage = new LocalStorage();
 localstorage.set('key1', value1);
 localstorage.set('key2', value2);
 localstorage.set('key3', value3);
 localstorage.get('key1');           //value1 will be returned

getPrefix() → {String}

Gets prefix of localstorage

Since:

• 2.0.0

Returns:

prefix Returns prefix of localstorage
If the prefix is set, the prefix will be returned, Or returns undefined

Type

String

Example

var LocalStorage = caph.require('storage.LocalStorage');
 var localstorage = new LocalStorage();
 localstorage.setPrefix('localstorage');
 var temp = localstorage.getPrefix();
 console.log(temp);    //'localstorage'

remove(key)

Removes an item

Parameters:

Name	Type	Description
key	String	The key, localstorage removes the item based on this key

Since:

• 2.0.0

Example

var LocalStorage = caph.require('storage.LocalStorage');
 var localstorage = new LocalStorage();
 localstorage.set('key1', value1);
 localstorage.set('key2', value2);
 localstorage.set('key3', value3);
 localstorage.remove('key1');

set(key, value)

Saves data into localstorage

Parameters:

Name	Type	Description
key	String	The key of item, it will be used for insert, remove, and so on.
value	String	the value of item, it contains contents

Since:

• 2.0.0

Example

var LocalStorage = caph.require('storage.LocalStorage');
 var localstorage = new LocalStorage();
 localstorage.set('key1', value1);
 localstorage.set('key2', value2);
 localstorage.set('key3', value3);

setPrefix(prefix)

Sets prefix of localstorage

Parameters:

Name	Type	Description
prefix	String	The prefix of cache, the prefix will be used to make key

Since:

• 2.0.0

Example

var LocalStorage = caph.require('storage.LocalStorage');
 var localstorage = new LocalStorage();
 localstorage.setPrefix('localstorage');