{"id":15761624,"url":"https://github.com/alrico88/storage-helper-functions","last_synced_at":"2025-03-31T09:24:30.637Z","repository":{"id":57371240,"uuid":"282912791","full_name":"alrico88/storage-helper-functions","owner":"alrico88","description":"Functions to help usage of localStorage or sessionStorage","archived":false,"fork":false,"pushed_at":"2021-01-28T09:22:49.000Z","size":21,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-24T04:34:03.540Z","etag":null,"topics":["browser","localstorage","sessionstorage"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alrico88.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-27T13:53:17.000Z","updated_at":"2021-01-28T09:22:51.000Z","dependencies_parsed_at":"2022-09-18T22:23:50.759Z","dependency_job_id":null,"html_url":"https://github.com/alrico88/storage-helper-functions","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alrico88%2Fstorage-helper-functions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alrico88%2Fstorage-helper-functions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alrico88%2Fstorage-helper-functions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alrico88%2Fstorage-helper-functions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alrico88","download_url":"https://codeload.github.com/alrico88/storage-helper-functions/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246444649,"owners_count":20778470,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["browser","localstorage","sessionstorage"],"created_at":"2024-10-04T11:03:16.086Z","updated_at":"2025-03-31T09:24:30.604Z","avatar_url":"https://github.com/alrico88.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca name=\"StorageHelper\"\u003e\u003c/a\u003e\n\n## StorageHelper\n\n**Kind**: global class\n\n- [StorageHelper](#StorageHelper)\n  - [new StorageHelper()](#new_StorageHelper_new)\n  - [.module.exports](#StorageHelper.module.exports)\n    - [new module.exports(storageProvider, [compressed])](#new_StorageHelper.module.exports_new)\n  - [.store(key, data, [format])](#StorageHelper.store) ⇒ \u003ccode\u003evoid\u003c/code\u003e\n  - [.get(key, [format])](#StorageHelper.get) ⇒ \u003ccode\u003eany\u003c/code\u003e\n\n\u003ca name=\"new_StorageHelper_new\"\u003e\u003c/a\u003e\n\n### new StorageHelper()\n\nStorageHelper class\n\n\u003ca name=\"StorageHelper.module.exports\"\u003e\u003c/a\u003e\n\n### StorageHelper.module.exports\n\n**Kind**: static class of [\u003ccode\u003eStorageHelper\u003c/code\u003e](#StorageHelper)  \n\u003ca name=\"new_StorageHelper.module.exports_new\"\u003e\u003c/a\u003e\n\n#### new module.exports(storageProvider, [compressed])\n\nCreates an instance of StorageHelper.\n\n| Param           | Type                                                     | Default            | Description                                      |\n| --------------- | -------------------------------------------------------- | ------------------ | ------------------------------------------------ |\n| storageProvider | \u003ccode\u003elocalStorage\u003c/code\u003e \\| \u003ccode\u003esessionStorage\u003c/code\u003e |                    | Storage provider, localStorage or sessionStorage |\n| [compressed]    | \u003ccode\u003eboolean\u003c/code\u003e                                     | \u003ccode\u003efalse\u003c/code\u003e | Option to use compression for strings            |\n\n\u003ca name=\"StorageHelper.store\"\u003e\u003c/a\u003e\n\n### StorageHelper.store(key, data, [format]) ⇒ \u003ccode\u003evoid\u003c/code\u003e\n\nStores data to storageProvider\n\n**Kind**: static method of [\u003ccode\u003eStorageHelper\u003c/code\u003e](#StorageHelper)\n\n| Param    | Type                                                           | Default                       | Description                     |\n| -------- | -------------------------------------------------------------- | ----------------------------- | ------------------------------- |\n| key      | \u003ccode\u003estring\u003c/code\u003e                                            |                               | Key used to identify saved item |\n| data     | \u003ccode\u003estring\u003c/code\u003e \\| \u003ccode\u003eobject\u003c/code\u003e                     |                               | Data to save                    |\n| [format] | \u003ccode\u003e\u0026#x27;text\u0026#x27;\u003c/code\u003e \\| \u003ccode\u003e\u0026#x27;json\u0026#x27;\u003c/code\u003e | \u003ccode\u003e\u0026quot;text\u0026quot;\u003c/code\u003e | Data format                     |\n\n\u003ca name=\"StorageHelper.get\"\u003e\u003c/a\u003e\n\n### StorageHelper.get(key, [format]) ⇒ \u003ccode\u003eany\u003c/code\u003e\n\nGets key from storageProvider\n\n**Kind**: static method of [\u003ccode\u003eStorageHelper\u003c/code\u003e](#StorageHelper)  \n**Returns**: \u003ccode\u003eany\u003c/code\u003e - - The value of said key\n\n| Param    | Type                                                           | Default                       | Description                  |\n| -------- | -------------------------------------------------------------- | ----------------------------- | ---------------------------- |\n| key      | \u003ccode\u003estring\u003c/code\u003e                                            |                               | Key to retrieve from storage |\n| [format] | \u003ccode\u003e\u0026#x27;text\u0026#x27;\u003c/code\u003e \\| \u003ccode\u003e\u0026#x27;json\u0026#x27;\u003c/code\u003e | \u003ccode\u003e\u0026quot;text\u0026quot;\u003c/code\u003e | Format of stored data        |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falrico88%2Fstorage-helper-functions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falrico88%2Fstorage-helper-functions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falrico88%2Fstorage-helper-functions/lists"}