Local

Constructor

new Local()

Source: Local.js, line 1

Example

Local.getAll();

Methods

(static) clear() → {void}

Delete all data saved in the local storage

Source: Local.js, line 133

Returns:

Type:: void

Example

Local.clear();

(static) getAll(jsonopt) → {any}

Get all data saved in the local storage

Parameters:

Name	Type	Attributes	Default	Description
`json`	boolean	<optional>	false	if true, return the data in json format

Source: Local.js, line 52

Returns:

the data saved in the local storage

Type:: any

Example

Local.getAll();

(static) getData(key) → {any}

Get a specific data saved in the local storage

Parameters:

Name	Type	Description
`key`	string	key of the data to get

Source: Local.js, line 67

Returns:

the data saved in the local storage

Type:: any

Example

Local.getData("myKey");

(static) has(key) → {boolean}

Check if the given key is stored

Parameters:

Name	Type	Description
`key`	string	key to check

Source: Local.js, line 164

Returns:

true if the key is stored

Type:: boolean

Example

Local.has("myKey");

(static) isEmpty() → {boolean}

Check if the local storage is empty

Source: Local.js, line 177

Returns:

true if the local storage is empty

Type:: boolean

Example

Local.isEmpty();

(static) keys() → {Array.<string>}

Get keys of the stored items

Source: Local.js, line 143

Returns:

return all keys

Type:: Array.<string>

Example

Local.keys();

(static) removeData(key) → {void}

Delete a specific data by name

Parameters:

Name	Type	Description
`key`	sting	the name of the data to delete

Source: Local.js, line 118

Returns:

Type:: void

Example

Local.removeData("myKey");

(static) setData(key, value) → {void}

Save/change a specific data by key

Parameters:

Name	Type	Description
`key`	string	name of the key
`value`	any	value of the item

Source: Local.js, line 87

Returns:

Type:: void

Examples

Local.setData("myKeyString", "myString");

Local.setData("myKeyBool", true);

Local.setData("myKeyNumber", 1234567890);

Local.setData("myKeyObject", {name: "Dog", age: 3,});

Local.setData("myKeyArr", [1, 2, 3, 4, 5]);

(static) setName(name) → {void}

Change the name of data saved in the local storage

Parameters:

Name	Type	Description
`name`	string	the name to save the data in the local storage

Source: Local.js, line 33

Returns:

Type:: void

Example

Local.setName("myLocalStorage");

(static) size() → {number}

Get number of stored items

Source: Local.js, line 153

Returns:

number of stored items

Type:: number

Example

Local.size();

(static) updateAll(data) → {void}

Save/change all data

Parameters:

Name	Type	Description
`data`	any	data to save

Source: Local.js, line 104

Returns:

Type:: void

Example

Local.updateAll({ otherNewData: "Hello World" });