Class: MemoryStore

Members

mechanism

Identifies the underlying mechanism used by the store.

Source:

• store/memory.js, line 243

Methods

add(key, value, success, error)

Adds a new value identified by a key to the store.

This method errors out if the store already contains the specified key.

Parameters:

Name	Type	Description
key	String	Key string.
value		Value that is going to be added to the store.
success	function	Callback for a successful add operation.
error	function	Callback for handling errors. If not specified then store.defaultError is invoked.

Source:

• store/memory.js, line 71

addOrUpdate(key, value, success, error)

Adds or updates a value identified by a key to the store.

This method will overwrite the key's current value if it already exists in the store; otherwise it simply adds the new key and value.

Parameters:

Name	Type	Argument	Description
key	String		Key string.
value			Value that is going to be added or updated to the store.
success	function		Callback for a successful add or update operation.
error	function	<optional>	Callback for handling errors. If not specified then store.defaultError is invoked.

Source:

• store/memory.js, line 91

clear(success)

Removes all the data associated with this store object.

Parameters:

Name	Type	Description
success	function	Callback for a successful clear operation.

Source:

• store/memory.js, line 118

close()

This function does nothing in MemoryStore as it does not have a connection model.

Source:

• store/memory.js, line 236

contains(key, success)

Checks whether a key exists in the store.

Parameters:

Name	Type	Description
key	String	Key string.
success	function	Callback indicating whether the store contains the key or not.

Source:

• store/memory.js, line 129

getAllKeys(success)

Gets all the keys that exist in the store.

Parameters:

Name	Type	Description
success	function	Callback for a successful get operation.

Source:

• store/memory.js, line 139

read(key, success, error)

Reads the value associated to a key in the store.

Parameters:

Name	Type	Description
key	String	Key string.
success	function	Callback for a successful reads operation.
error	function	Callback for handling errors. If not specified then store.defaultError is invoked.

Source:

• store/memory.js, line 152

remove(key, success, error)

Removes a key and its value from the store.

Parameters:

Name	Type	Argument	Description
key	String		Key string.
success	function		Callback for a successful remove operation.
error	function	<optional>	Callback for handling errors. If not specified then store.defaultError is invoked.

Source:

• store/memory.js, line 167

update(key, value, success, error)

Updates the value associated to a key in the store.

Parameters:

Name	Type	Argument	Description
key	String		Key string.
value			New value.
success	function		Callback for a successful update operation.
error	function	<optional>	Callback for handling errors. If not specified then store.defaultError is invoked. This method errors out if the specified key is not found in the store.

Source:

• store/memory.js, line 197

<inner> validateKeyInput(key, error) → {Boolean}

Validates that the specified key is not undefined, not null, and not an array

Parameters:

Name	Type	Description
key		Key value.
error	function	Error callback.

Source:

• store/memory.js, line 52

Returns:

True if the key is valid. False if the key is invalid and the error callback has been queued for execution.

Type

Boolean