## SipaState Tool class to store global states at different persistence levels. Level 1 (variable): Data will be lost after reload (SipaState.LEVEL.VARIABLE) You can even store references and functions! Level 2 (session): Data will be lost when browser is closed (SipaState.LEVEL.SESSION) You can not store references but thanks to SipaSerializer isolated functions are possible! Level 3 (storage): Data will be lost when clearing browser cache only (SipaState.LEVEL.STORAGE) You can not store references but thanks to SipaSerializer isolated functions are possible! * [SipaState](#SipaState) * [.LEVEL](#SipaState.LEVEL) : Object * [.PERSISTENCE_PREFIX](#SipaState.PERSISTENCE_PREFIX) : string * [.set(key, value, options)](#SipaState.set) * [.setVariable(key, value, options)](#SipaState.setVariable) * [.setSession(key, value, options)](#SipaState.setSession) * [.setStorage(key, value, options)](#SipaState.setStorage) * [.getLevel(key)](#SipaState.getLevel) → [LEVEL](#SipaState.LEVEL) \| null * [.hasKey(key)](#SipaState.hasKey) → boolean * [.get(key)](#SipaState.get) → any \| undefined * [.getVariables()](#SipaState.getVariables) → Object.<String, any> * [.getSession()](#SipaState.getSession) → Object.<String, any> * [.getStorage()](#SipaState.getStorage) → Object.<String, any> * [.getAll()](#SipaState.getAll) → Object.<String, any> * [.getKeys()](#SipaState.getKeys) → Array.<String> * [.remove(key)](#SipaState.remove) → boolean * [.removeAll()](#SipaState.removeAll) → boolean * [.reset()](#SipaState.reset) → boolean * [.Level](#SipaState.Level) : 'variable' \| 'session' \| 'storage' ### SipaState.LEVEL : Object Persistence levels ### SipaState.PERSISTENCE\_PREFIX : string Prefix for all keys to avoid conflicts with other data in sessionStorage or localStorage. ### SipaState.set(key, value, options) Set a value with the given persistence level, by default SipaState.LEVEL.SESSION | Param | Type | Default | Description | | --- | --- | --- | --- | | key | string | | | | value | any | | | | options | object | | | | options.level | [Level](#SipaState.Level) | 'session' | | | options.force | boolean | false | overwrite value, if it is set at another level already | **Example** ```js // Set a variable that will be lost after reload SipaState.set("my_var", {a:1, b:2}, {level: SipaState.LEVEL.VARIABLE}); // Set a session value that will be lost after closing the browser SipaState.set("my_sess", {a:1, b:2}, {level: SipaState.LEVEL.SESSION}); SipaState.set("my_sess", {a:1, b:2}); // Set a storage value that SipaState.set("my_store", {a:1, b:2}, {level: SipaState.LEVEL.STORAGE}); ``` ### SipaState.setVariable(key, value, options) Set value in persistence level 1 (variable). | Param | Type | Default | Description | | --- | --- | --- | --- | | key | string | | | | value | any | | | | options | object | | | | options.force | boolean | false | overwrite value without throwing error, if it is set at another level already | **Example** ```js // Set a variable that will be lost after reload SipaState.setVariable("my_var", {a:1, b:2}); ``` ### SipaState.setSession(key, value, options) Set value in persistence level 2 (session). | Param | Type | Default | Description | | --- | --- | --- | --- | | key | string | | | | value | any | | | | options | object | | | | options.force | boolean | false | overwrite value without throwing error, if it is set at another level already | **Example** ```js // Set a session value that will be lost after closing the browser SipaState.setSession("my_sess", {a:1, b:2}); ``` ### SipaState.setStorage(key, value, options) Set value in persistence level 3 (storage) | Param | Type | Default | Description | | --- | --- | --- | --- | | key | string | | | | value | any | | | | options | object | | | | options.force | boolean | false | overwrite value without throwing error, if it is set at another level already | **Example** ```js // Set a storage value that will be lost when clearing browser cache only SipaState.setStorage("my_store", {a:1, b:2}); ``` ### SipaState.getLevel(key) → [LEVEL](#SipaState.LEVEL) \| null Get the persistence level of the value stored at the given key. If key is not set at any level, returns null. | Param | Type | | --- | --- | | key | string | **Example** ```js SipaState.setSession("my_sess", {a:1, b:2}); SipaState.getLevel("my_sess"); // returns 'session' SipaState.setVariable("my_var", {a:1, b:2}); SipaState.getLevel("my_var"); // returns 'variable' SipaState.setStorage("my_store", {a:1, b:2}); SipaState.getLevel("my_store"); // returns 'storage' SipaState.getLevel("not_existing_key"); // returns null // If key is set at multiple levels, the highest level is returned (storage > session > variable) SipaState.setStorage("my_key", {a:1, b:2}); SipaState.setSession("my_key", {a:1, b:2}); SipaState.setVariable("my_key", {a:1, b:2}); SipaState.getLevel("my_key"); // returns 'storage' SipaState.remove("my_key"); SipaState.setSession("my_key", {a:1, b:2}); SipaState.setVariable("my_key", {a:1, b:2}); SipaState.getLevel("my_key"); // returns 'session' SipaState.set("my_key", {a:1, b:2}, {level: SipaState.LEVEL.VARIABLE, force: true}); SipaState.getLevel("my_key"); // returns 'variable' ``` ### SipaState.hasKey(key) → boolean Check if key is set already at any persistence level. | Param | Type | | --- | --- | | key | string | **Example** ```js SipaState.setSession("my_sess", {a:1, b:2}); SipaState.hasKey("my_sess"); // returns true SipaState.hasKey("not_existing_key"); // returns false SipaState.setStorage("my_store", {a:1, b:2}); SipaState.hasKey("my_store"); // returns true ``` ### SipaState.get(key) → any \| undefined Get the value of the given key. Persistence level does not matter and is implicit. The priority is storage > session > variable. **Returns**: any \| undefined - value or undefined if key does not exist | Param | Type | | --- | --- | | key | string | **Example** ```js SipaState.setSession("my_sess", {a:1, b:2}); SipaState.get("my_sess"); // returns {a:1, b:2} SipaState.get("not_existing_key"); // returns undefined ``` ### SipaState.getVariables() → Object.<String, any> Get all entries of persistence level 1 (variables). **Example** ```js SipaState.setVariable("var1", 1); SipaState.setVariable("var2", 2); SipaState.setSession("sess1", 1); SipaState.setStorage("store1", 1); SipaState.getVariables(); // returns {var1: 1, var2: 2} ``` ### SipaState.getSession() → Object.<String, any> Get all entries of persistence level 2 (session). **Example** ```js SipaState.setVariable("var1", 1); SipaState.setSession("sess1", 1); SipaState.setSession("sess2", 2); SipaState.setStorage("store1", 1); SipaState.getSession(); // returns {sess1: 1, sess2: 2} ``` ### SipaState.getStorage() → Object.<String, any> Get all entries of persistence level 3 (storage). **Example** ```js SipaState.setVariable("var1", 1); SipaState.setSession("sess1", 1); SipaState.setStorage("store1", 1); SipaState.setStorage("store2", 2); SipaState.getStorage(); // returns {store1: 1, store2: 2} ``` ### SipaState.getAll() → Object.<String, any> Get all stored entries. **Example** ```js SipaState.setVariable("var1", 1); SipaState.setSession("sess1", 1); SipaState.setStorage("store1", 1); SipaState.getAll(); // returns {var1: 1, sess1: 1, store1: 1} ``` ### SipaState.getKeys() → Array.<String> Get all keys. **Example** ```js SipaState.setVariable("var1", 1); SipaState.setSession("sess1", 1); SipaState.setStorage("store1", 1); SipaState.getKeys(); // returns ['var1', 'sess1', 'store1'] ``` ### SipaState.remove(key) → boolean Remove the stored value of the given key(s). **Returns**: boolean - true if value of any key was set and has been removed. False if no key did exist. | Param | Type | Description | | --- | --- | --- | | key | string \| Array | key or keys to remove | **Example** ```js SipaState.setVariable("var1", 1); SipaState.setSession("sess1", 1); SipaState.setStorage("store1", 1); SipaState.remove("sess1"); // returns true SipaState.getKeys(); // returns ['var1', 'store1'] SipaState.remove("not_existing"); // returns false SipaState.remove(["var1", "store1"]); // returns true ``` ### SipaState.removeAll() → boolean Delete all stored data - alias method for reset(). **Returns**: boolean - true if one or more entries have been deleted **Example** ```js SipaState.setVariable("var1", 1); SipaState.setSession("sess1", 1); SipaState.setStorage("store1", 1); SipaState.removeAll(); // returns true SipaState.getKeys(); // returns [] ``` ### SipaState.reset() → boolean Delete all stored data. **Returns**: boolean - true if one or more entries have been deleted **Example** ```js SipaState.setVariable("var1", 1); SipaState.setSession("sess1", 1); SipaState.setStorage("store1", 1); SipaState.reset(); // returns true SipaState.getKeys(); // returns [] ``` ### SipaState.Level : 'variable' \| 'session' \| 'storage' **Kind**: static typedef of [SipaState](#SipaState)