Class: StorageService

Help4.service.StorageService()

Usage: call Help4.service.StorageService#isStorageAvailable or Help4.service.StorageService#prepareAll before using Help4.service.StorageService#get, Help4.service.StorageService#set or Help4.service.StorageService#del

Constructor

new StorageService()

Properties:
Name Type Description
_config Object
_storages Object
_storageIds Object
STORAGE_ID Object
Source:

Extends

Classes

CookieStorage
EnableNowStorage
FioriStorage
LocalStorage
SessionStorage
StorageInterface

Methods

(protected) ____defineStaticProperties()

auto define all to be cleaned properties
Overrides:
Source:
Throws:
Error

(protected) ____getClassConfig() → {Help4.jscore.Base.Params}

Overrides:
Source:
Returns:
Type
Help4.jscore.Base.Params

(protected) ____mergeDerivedParam(level0, type, value)

Parameters:
Name Type Description
level0 Help4.jscore.Base.Params
type string
value *
Overrides:
Source:
Throws:
Error

(protected) ____mergeDerivedParams(level0, level1)

Parameters:
Name Type Description
level0 Help4.jscore.Base.Params
level1 Help4.jscore.Base.Params
Overrides:
Source:
Throws:
Error

(protected) ____resolveDerivedParams(classConfig)

Parameters:
Name Type Description
classConfig Help4.jscore.Base.Params
Overrides:
Source:

(protected) _destroyControl(…keys)

destroys class properties
Parameters:
Name Type Attributes Description
keys string <repeatable>
Overrides:
Source:

(protected) _fireEvent(event) → {Help4.jscore.Base}

fires an event that can be observed from outside
Parameters:
Name Type Description
event Object the event to be fired
Overrides:
Source:
Returns:
Type
Help4.jscore.Base

(async, protected) _fireEvent2(event) → {Promise.<Array.<Help4.EmbeddedEvent.EventResponse>>}

fires an event that can be observed from outside
Parameters:
Name Type Description
event Object the event to be fired
Overrides:
Source:
Returns:
Type
Promise.<Array.<Help4.EmbeddedEvent.EventResponse>>

(protected) _fireEventSync(event) → {Array.<Help4.EmbeddedEvent.EventResponse>}

fires an event that can be observed from outside
Parameters:
Name Type Description
event Object the event to be fired
Overrides:
Source:
Returns:
Type
Array.<Help4.EmbeddedEvent.EventResponse>

addListener(eventType, listener) → {Help4.jscore.Base}

add an event listener
Parameters:
Name Type Description
eventType string | Array.<string> event type to be observed
listener Help4.EmbeddedEvent.Listener the callback function
Overrides:
Source:
Returns:
Type
Help4.jscore.Base

addListenerSync(eventType, listener) → {Help4.jscore.Base}

add an event listener
Parameters:
Name Type Description
eventType string | Array.<string> event type to be observed
listener Help4.EmbeddedEvent.Listener the callback function
Overrides:
Source:
Returns:
Type
Help4.jscore.Base

config(config)

Parameters:
Name Type Description
config Object
Source:

(async) del(key, paramsopt) → {Promise.<void>}

Parameters:
Name Type Attributes Description
key string
params Help4.service.StorageService.IterationParams <optional>
Source:
Returns:
Type
Promise.<void>

destroy()

destroy instance
Overrides:
Source:

(async) get(key, paramsopt) → {Promise.<*>}

Parameters:
Name Type Attributes Description
key string
params Help4.service.StorageService.IterationParams <optional>
Source:
Returns:
Type
Promise.<*>

(async) getStorage(storageId) → {Promise.<?Help4.service.StorageService.StorageInterface>}

Parameters:
Name Type Description
storageId string
Source:
Returns:
Type
Promise.<?Help4.service.StorageService.StorageInterface>

isDestroyed() → {boolean}

whether instance is destroyed
Overrides:
Source:
Returns:
Type
boolean

(async) isStorageAvailable(storageId) → {Promise.<boolean>}

Parameters:
Name Type Description
storageId string
Source:
Returns:
Type
Promise.<boolean>

(async) prepareAll(excludeopt) → {Promise.<void>}

Parameters:
Name Type Attributes Default Description
exclude Array.<string> <optional>
 []
Source:
Returns:
Type
Promise.<void>

removeListener(eventType, listener) → {Help4.jscore.Base}

remove an event listener
Parameters:
Name Type Description
eventType string | Array.<string>
listener Help4.EmbeddedEvent.Listener
Overrides:
Source:
Returns:
Type
Help4.jscore.Base

(async) set(key, value, paramsopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
key string
value *
params Help4.service.StorageService.IterationParams <optional>
Source:
Returns:
Type
Promise.<boolean>

Type Definitions

IterationExecutor(storage) → {Promise.<boolean>}

Parameters:
Name Type Description
storage Help4.service.StorageService.StorageInterface the current storage interface
Source:
Returns:
- true: stop execution
Type
Promise.<boolean>

IterationParams

Type:
  • Object
Properties:
Name Type Attributes Default Description
target Array.<string> | string <optional>
 null [, , ...] or
exclude Array.<string> | string <optional>
 null [, , ...] or
Source:

Params

Type:
  • Object
Source: