@jill64/svelte-storage

🗃️ Type-Safe Web Storage API Wrapper for Svelte

Installation

1npm i @jill64/svelte-storage

Simple Example

Passing the localStorage key to the storage function will retrieve the svelte-store of that value.

1<script>
2  import { storage } from '@jill64/svelte-storage'
3  import { string } from '@jill64/svelte-storage/serde'
4
5  const storage = storage(
6    { ['localStorage-key']: string },
7    {
8      // Use sessionStorage instead of localStorage
9      // sessionStorage: boolean (default: false)
10    }
11  )
12
13  // Get value
14  consol.log(storage['localStorage-key'])
15
16  // Set value
17  storage['localStorage-key'] = 'value'
18</script>

Prepared Converters

You can also use the prepared converters in @jill64/svelte-storage/serde.

1<script>
2  import { storage } from '@jill64/svelte-storage'
3  import { number } from '@jill64/svelte-storage/serde'
4
5  const storage = storage(
6    { ['localStorage-key']: number }
7    // {
8    //  Storage Option
9    // }
10  )
11</script>

Custom Converter

By passing a conversion function as the second argument, you can get the value converted to any type.

1<script>
2  import { storage } from '@jill64/svelte-storage'
3
4  const store = storage(
5    {
6      ['localStorage-key']: {
7        stringify: (value) => value.toString(),
8        parse: (str) => parseInt(str)
9      }
10    }
11    // {
12    //  Storage Option
13    // }
14  )
15</script>

License

MIT