{"id":14962772,"url":"https://github.com/matssom/svelte-storable","last_synced_at":"2026-02-20T15:33:56.459Z","repository":{"id":56390717,"uuid":"311683735","full_name":"matssom/svelte-storable","owner":"matssom","description":":file_folder: Package that adds automatic localStorage to 'writable' from svelte.","archived":false,"fork":false,"pushed_at":"2020-11-17T14:11:57.000Z","size":73,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-08-09T16:53:46.081Z","etag":null,"topics":["localstorage","state-management","storable","store","svelte","svelte-stores","svelte3","writable"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/matssom.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-10T14:28:12.000Z","updated_at":"2024-02-01T00:15:32.000Z","dependencies_parsed_at":"2022-08-15T17:50:39.742Z","dependency_job_id":null,"html_url":"https://github.com/matssom/svelte-storable","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/matssom/svelte-storable","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matssom%2Fsvelte-storable","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matssom%2Fsvelte-storable/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matssom%2Fsvelte-storable/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matssom%2Fsvelte-storable/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matssom","download_url":"https://codeload.github.com/matssom/svelte-storable/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matssom%2Fsvelte-storable/sbom","scorecard":{"id":625306,"data":{"date":"2025-08-11","repo":{"name":"github.com/matssom/svelte-storable","commit":"23d9a52f4a06f3e44326ccb957205856ce005aa2"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/29 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 2 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"11 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm","Warn: Project is vulnerable to: GHSA-wv8q-r932-8hc7","Warn: Project is vulnerable to: GHSA-8266-84wp-wv5c","Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc","Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-21T06:14:05.915Z","repository_id":56390717,"created_at":"2025-08-21T06:14:05.915Z","updated_at":"2025-08-21T06:14:05.915Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29655326,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-20T09:27:29.698Z","status":"ssl_error","status_checked_at":"2026-02-20T09:26:12.373Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["localstorage","state-management","storable","store","svelte","svelte-stores","svelte3","writable"],"created_at":"2024-09-24T13:30:29.324Z","updated_at":"2026-02-20T15:33:51.450Z","avatar_url":"https://github.com/matssom.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Svelte Storable\r\n\r\nSvelte Storable is an extention to the `writable` store that comes with `svelte/store`. The purpose of the package is to preserve the state of the store, even after refresh. \r\n\r\nSvelte Store adds `localStorage` management to the store while, with 1 exception preserves the api.\r\n\r\n\u003cbr\u003e\r\n\r\n## Installation\r\n\r\n**Include with npm:**\r\n```\r\nnpm install svelte-storable\r\n```\r\n\r\n**Include locally:**\r\n\r\nDownload `storable.js` from [this](https://github.com/matssom/svelte-storable/) repository and include it in your project.\r\n\r\n\u003cbr\u003e\r\n\r\n## Documentation\r\n\r\nUse the [svelte writalbe](https://svelte.dev/docs#writable) doumentation as a companion to this documentation if you aren't comfortable with svelte stores.\r\n\r\n**Creating a Store**\r\n\r\nThe api for `svelte-storable` matches almost identically to the `writable` from `svelte/store`. The key difference is that you need to provide a key to the `storable`. This key will be used when storing and retrieving the persisted data.\r\n\r\n```js\r\n// store.js\r\nimport { storable } from 'svelte-storable';\r\n\r\n                                ||\r\n                                \\/\r\nexport const count = storable('count', 0);\r\n```\r\n\r\n**Using the Store**\r\n\r\nNow you can use the store with all your usual `writable` methods. Additionally, you have the `detatch()` method. This can be used to remove the data from `localStorage` so that the value will be fresh on refresh.\r\n\r\n:warning: **NB:** If you update the value after `detatch()` it will be stored again.\r\n\r\n```html\r\n\u003c!-- App.svelte --\u003e\r\n\u003cscript\u003e\r\n    import { count } from './store';\r\n\r\n    const increase  = () =\u003e count.update((value) =\u003e value + 1);\r\n    const decrease  = () =\u003e count.update((value) =\u003e value - 1);\r\n    const reset     = () =\u003e count.set(0);\r\n    const detatch   = () =\u003e count.detatch();\r\n\r\n\u003c/script\u003e\r\n\r\n\u003ch1\u003e{$count}\u003c/h1\u003e\r\n\u003cbutton on:click={count.increase}\u003eIncrease Count\u003c/button\u003e\r\n\u003cbutton on:click={count.decrease}\u003eDecrese Count\u003c/button\u003e\r\n\u003cbutton on:click={count.reset}\u003eReset\u003c/button\u003e\r\n\u003cbutton on:click={count.detatch}\u003eDetatch from Storage\u003c/button\u003e\r\n\r\n```\r\n\r\n**Subscribe**\r\n\r\nYou can use the `$` syntax like any other svelte store or do it manually with unsubscribe/subscribe.\r\n```js\r\nconst unsubscribe = count.subscribe(value =\u003e doSomething(value));\r\n```\r\n\r\n**Custom Stores**\r\n\r\nWith `writable` you can make custom stores. This functionallity also copies over to `svelte-storable`. Again, the key difference is that you need to provide a key. You can optionally take that key as a parameter to your `createStore()` function with a default value.\r\n\r\n```js\r\n// store.js\r\nimport { storable } from 'svelte-storable';\r\n\r\nconst createCountStore = (key = 'count') =\u003e {\r\n    const { subscribe, set, update, detatch } = storable(key, 0);\r\n\r\n    return {\r\n        subscribe,\r\n        increase:   () =\u003e update((value) =\u003e value + 1),\r\n\tdecrease:   () =\u003e update((value) =\u003e value - 1),\r\n\treset:      () =\u003e set(0),\r\n        detatch:    () =\u003e detatch()\r\n    }\r\n}\r\n\r\nexport const count = createCountStore('count');\r\n```\r\n\r\n:warning: **NB:** Remember to provide different keys to all the different instances of your custom store. If two or more stores have the same key, they will update each other.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatssom%2Fsvelte-storable","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatssom%2Fsvelte-storable","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatssom%2Fsvelte-storable/lists"}