AbstractStorageService

AbstractStorageService ⇐ Abstract#

Kind: global abstract class
Extends: Abstract
Service:
Properties

• AbstractStorageService ⇐ Abstract
  • new AbstractStorageService()
  • .store(key, value) ⇒ Promise.<Object.<string, string>, Error>
  • .retrieve(key, options) ⇒ Promise.<string, Error>
  • .delete(key) ⇒ Promise.<string, error>
  • .clear() ⇒ Promise
  • ._store(key, jsonString) ⇒ Promise.<Object.<string, string>, Error>
  • ._retrieve(key) ⇒ Promise.<string, Error>
  • ._delete(key) ⇒ Promise.<string, Error>
  • ._clear() ⇒ Promise
  • ._serialize(value) ⇒ Promise.<string, Error>
  • ._onValueStored(key, value) ⇒ Promise
  • ._onValueDeleted(key) ⇒ Promise
  • ._onError(e) ⇒ Promise
  • “valueStored” (key, value)
  • “valueDeleted” (key)
  • “error”

AbstractStorageService()#

A service to store/restore values in the form of key/value pairs from a persistent storage.

store(key, value) ⇒ Promise.<Object.<string, string>, Error>#

Store the given value referenced by the key

Kind: instance method of AbstractStorageService
Returns: Promise.<Object.<string, string>, Error> - A promise ({key,value}, error)

retrieve(key, options) ⇒ Promise.<string, Error>#

Retrieve a previously stored value referenced by it’s key

Kind: instance method of AbstractStorageService
Returns: Promise.<string, Error> - A promise (value, error)

delete(key) ⇒ Promise.<string, error>#

Delete a value referenced by the key

Kind: instance method of AbstractStorageService
Returns: Promise.<string, error> - A promise ({key}, error)

clear() ⇒ Promise#

Clear storage

Kind: instance method of AbstractStorageService
Returns: Promise - A promise ()

_store(key, jsonString) ⇒ Promise.<Object.<string, string>, Error>#

Vendor implementation to store the given value referenced by the key

Kind: instance abstract method of AbstractStorageService
Returns: Promise.<Object.<string, string>, Error> - A promise ({key,value}, error)
Access: protected

_retrieve(key) ⇒ Promise.<string, Error>#

Vendor implementation to retrieve a previously stored value referenced by it’s key

Kind: instance abstract method of AbstractStorageService
Returns: Promise.<string, Error> - A promise (value, error)
Access: protected

_delete(key) ⇒ Promise.<string, Error>#

Vendor implementation to delete a value referenced by the key

Kind: instance abstract method of AbstractStorageService
Returns: Promise.<string, Error> - A promise ({key}, error)
Access: protected

_clear() ⇒ Promise#

Vendor implementation to clear storage.

Kind: instance abstract method of AbstractStorageService
Returns: Promise - A promise
Access: protected

_serialize(value) ⇒ Promise.<string, Error>#

Return a JSON string

Kind: instance method of AbstractStorageService
Returns: Promise.<string, Error> - The serialized value
Access: protected

_onValueStored(key, value) ⇒ Promise#

Fired when a value has been stored

Kind: instance method of AbstractStorageService
Access: protected

_onValueDeleted(key) ⇒ Promise#

Fired when a value has been deleted from the storage

Kind: instance method of AbstractStorageService
Access: protected

_onError(e) ⇒ Promise#

Kind: instance method of AbstractStorageService
Access: protected

“valueStored” (key, value)#

Fired when a value has been stored

Kind: event emitted by AbstractStorageService

“valueDeleted” (key)#

Fired when a value has been deleted from the storage

Kind: event emitted by AbstractStorageService

“error”#

Fired when an error occured

Kind: event emitted by AbstractStorageService