StorageHelper

Kind: global class

• StorageHelper
  • new StorageHelper()
  • .module.exports
    • new module.exports(storageProvider, [compressed])
  • .store(key, data, [format]) ⇒ void
  • .get(key, [format]) ⇒ any

new StorageHelper()

StorageHelper class

StorageHelper.module.exports

Kind: static class of StorageHelper

new module.exports(storageProvider, [compressed])

Creates an instance of StorageHelper.

| Param | Type | Default | Description | | --------------- | -------------------------------------------------------- | ------------------ | ------------------------------------------------ | | storageProvider | localStorage | sessionStorage | | Storage provider, localStorage or sessionStorage | | [compressed] | boolean | false | Option to use compression for strings |

StorageHelper.store(key, data, [format]) ⇒ void

Stores data to storageProvider

Kind: static method of StorageHelper

| Param | Type | Default | Description | | -------- | -------------------------------------------------------------- | ----------------------------- | ------------------------------- | | key | string | | Key used to identify saved item | | data | string | object | | Data to save | | [format] | 'text' | 'json' | "text" | Data format |

StorageHelper.get(key, [format]) ⇒ any

Gets key from storageProvider

Kind: static method of StorageHelper
Returns: any - - The value of said key

| Param | Type | Default | Description | | -------- | -------------------------------------------------------------- | ----------------------------- | ---------------------------- | | key | string | | Key to retrieve from storage | | [format] | 'text' | 'json' | "text" | Format of stored data |