joshnuss · May 2, 2024 02:38 · Jul 15, 2020 · Jul 3, 2020 · Jul 3, 2020 · Jun 1, 2020
diff --git a/localStorageStore.js b/localStorageStore.js
@@ -1,3 +1,11 @@
+/*
+  It's now a package. You can find it here:
+  
+  https://github.com/joshnuss/svelte-local-storage-store
+*/
+
+
+
 // Svelte store backed by window.localStorage
 // Persists store's data locally
 import {writable as internal, get} from 'svelte/store'

diff --git a/localStorageStore.js b/localStorageStore.js
@@ -33,9 +33,7 @@ export function writable(key, initialValue) {
 } 
 
 /*
-
-
-LICENSE
+LICENSE:
 
 Copyright 2020 Joshua Nussbaum
 
@@ -44,5 +42,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-*/
+*/
diff --git a/_localStorageStore.js b/_localStorageStore.js
@@ -1,33 +0,0 @@
-// Svelte store backed by window.localStorage
-// Persists store's data locally
-import {writable as internal, get} from 'svelte/store'
-
-// wraps a regular writable store
-export function writable(key, initialValue) {
-  // create an underlying store
-  const store = internal(initialValue)
-  const {subscribe, set} = store
-  // get the last value from localStorage
-  const json = localStorage.getItem(key)
-
-  // use the value from localStorage if it exists
-  if (json) {
-    set(JSON.parse(json))
-  }
-
-  // return an object with the same interface as svelte's writable()
-  return {
-    // capture set and write to localStorage
-    set(value) {
-      localStorage.setItem(key, JSON.stringify(value))
-      set(value)
-    },
-    // capture updates and write to localStore
-    update(cb) {
-      const value = cb(get(store))
-      this.set(value)
-    },
-    // punt subscriptions to underlying store
-    subscribe
-  }
-} 

diff --git a/__LICENSE.txt → localStorageStore.js b/__LICENSE.txt → localStorageStore.js
@@ -1,7 +1,48 @@
+// Svelte store backed by window.localStorage
+// Persists store's data locally
+import {writable as internal, get} from 'svelte/store'
+
+// wraps a regular writable store
+export function writable(key, initialValue) {
+  // create an underlying store
+  const store = internal(initialValue)
+  const {subscribe, set} = store
+  // get the last value from localStorage
+  const json = localStorage.getItem(key)
+
+  // use the value from localStorage if it exists
+  if (json) {
+    set(JSON.parse(json))
+  }
+
+  // return an object with the same interface as svelte's writable()
+  return {
+    // capture set and write to localStorage
+    set(value) {
+      localStorage.setItem(key, JSON.stringify(value))
+      set(value)
+    },
+    // capture updates and write to localStore
+    update(cb) {
+      const value = cb(get(store))
+      this.set(value)
+    },
+    // punt subscriptions to underlying store
+    subscribe
+  }
+} 
+
+/*
+
+
+LICENSE
+
 Copyright 2020 Joshua Nussbaum
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+*/
diff --git a/_usage.js → usage.js b/_usage.js → usage.js
diff --git a/LICENSE.txt → __LICENSE.txt b/LICENSE.txt → __LICENSE.txt
diff --git a/9LICENSE.txt → LICENSE.txt b/9LICENSE.txt → LICENSE.txt
diff --git a/localStorageStore.js → _localStorageStore.js b/localStorageStore.js → _localStorageStore.js
diff --git a/usage.js → _usage.js b/usage.js → _usage.js
diff --git a/_LICENSE.txt → 9LICENSE.txt b/_LICENSE.txt → 9LICENSE.txt
diff --git a/LICENSE.txt → _LICENSE.txt b/LICENSE.txt → _LICENSE.txt
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -0,0 +1,7 @@
+Copyright 2020 Joshua Nussbaum
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/localStorageStore.js b/localStorageStore.js
@@ -6,7 +6,7 @@ import {writable as internal, get} from 'svelte/store'
 export function writable(key, initialValue) {
   // create an underlying store
   const store = internal(initialValue)
-  const {subscribe, set, update} = store
+  const {subscribe, set} = store
   // get the last value from localStorage
   const json = localStorage.getItem(key)
 

diff --git a/localStorageStore.js b/localStorageStore.js
@@ -2,24 +2,32 @@
 // Persists store's data locally
 import {writable as internal, get} from 'svelte/store'
 
+// wraps a regular writable store
 export function writable(key, initialValue) {
+  // create an underlying store
   const store = internal(initialValue)
   const {subscribe, set, update} = store
+  // get the last value from localStorage
   const json = localStorage.getItem(key)
 
+  // use the value from localStorage if it exists
   if (json) {
     set(JSON.parse(json))
   }
 
+  // return an object with the same interface as svelte's writable()
   return {
+    // capture set and write to localStorage
     set(value) {
       localStorage.setItem(key, JSON.stringify(value))
       set(value)
     },
+    // capture updates and write to localStore
     update(cb) {
       const value = cb(get(store))
       this.set(value)
     },
+    // punt subscriptions to underlying store
     subscribe
   }
 } 
diff --git a/usage.js b/usage.js
@@ -1,7 +1,21 @@
+// define your stores
+import { writable } from './localStorageStore'
+
+// `preferences` will be:
+//  - Synced with localStorage
+//  - Accessible via pub/sub
+export const preferences = writable('preferences', {
+  theme: 'dark',
+  pane: '50%',
+  ...
+})
+
+// then when you want to use the store
 import { get } from 'svelte/store'
 import { preferences } from './stores'
 
 preferences.subscribe(...) // subscribe to changes
 preferences.update(...) // update value
 preferences.set(...) // set value
-get(preferences) // read value
+get(preferences) // read value
+$preferences // read value with automatic subscription
diff --git a/usage.js b/usage.js
@@ -0,0 +1,7 @@
+import { get } from 'svelte/store'
+import { preferences } from './stores'
+
+preferences.subscribe(...) // subscribe to changes
+preferences.update(...) // update value
+preferences.set(...) // set value
+get(preferences) // read value
diff --git a/localStorageStore.js b/localStorageStore.js
@@ -16,11 +16,10 @@ export function writable(key, initialValue) {
       localStorage.setItem(key, JSON.stringify(value))
       set(value)
     },
-
     update(cb) {
       const value = cb(get(store))
       this.set(value)
     },
     subscribe
   }
-}
+} 
diff --git a/localStorageStore.js b/localStorageStore.js
@@ -1,9 +1,10 @@
 // Svelte store backed by window.localStorage
 // Persists store's data locally
-import {writable as internal} from 'svelte/store'
+import {writable as internal, get} from 'svelte/store'
 
 export function writable(key, initialValue) {
-  const {subscribe, set} = internal(initialValue)
+  const store = internal(initialValue)
+  const {subscribe, set, update} = store
   const json = localStorage.getItem(key)
 
   if (json) {
@@ -15,6 +16,11 @@ export function writable(key, initialValue) {
       localStorage.setItem(key, JSON.stringify(value))
       set(value)
     },
+
+    update(cb) {
+      const value = cb(get(store))
+      this.set(value)
+    },
     subscribe
   }
 }
diff --git a/localStorageStore.js b/localStorageStore.js
@@ -2,18 +2,18 @@
 // Persists store's data locally
 import {writable as internal} from 'svelte/store'
 
-export function writable(key, value) {
-  const {subscribe, set} = internal(value)
+export function writable(key, initialValue) {
+  const {subscribe, set} = internal(initialValue)
   const json = localStorage.getItem(key)
 
   if (json) {
     set(JSON.parse(json))
   }
 
   return {
-    set(val) {
-      localStorage.setItem(key, JSON.stringify(val))
-      set(val)
+    set(value) {
+      localStorage.setItem(key, JSON.stringify(value))
+      set(value)
     },
     subscribe
   }

diff --git a/localStorageStore.js b/localStorageStore.js
@@ -4,7 +4,6 @@ import {writable as internal} from 'svelte/store'
 
 export function writable(key, value) {
   const {subscribe, set} = internal(value)
-
   const json = localStorage.getItem(key)
 
   if (json) {

diff --git a/localStorageStore.js b/localStorageStore.js
@@ -3,19 +3,19 @@
 import {writable as internal} from 'svelte/store'
 
 export function writable(key, value) {
-	const {subscribe, set} = internal(value)
-	
-	const json = localStorage.getItem(key)
-	
-	if (json) {
-		set(JSON.parse(json))
-	}
-	
-	return {
-		set(val) {
-			localStorage.setItem(key, JSON.stringify(val))
-			set(val)
-		},
-		subscribe
-	}
+  const {subscribe, set} = internal(value)
+  
+  const json = localStorage.getItem(key)
+  
+  if (json) {
+    set(JSON.parse(json))
+  }
+  
+  return {
+    set(val) {
+      localStorage.setItem(key, JSON.stringify(val))
+      set(val)
+    },
+    subscribe
+  }
 }
diff --git a/localStorageStore.js b/localStorageStore.js
@@ -0,0 +1,21 @@
+// Svelte store backed by window.localStorage
+// Persists store's data locally
+import {writable as internal} from 'svelte/store'
+
+export function writable(key, value) {
+	const {subscribe, set} = internal(value)
+
+	const json = localStorage.getItem(key)
+
+	if (json) {
+		set(JSON.parse(json))
+	}
+
+	return {
+		set(val) {
+			localStorage.setItem(key, JSON.stringify(val))
+			set(val)
+		},
+		subscribe
+	}
+}