npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@onsetsoftware/svelte-local-storage-store

v1.1.0

Published

Layer on top of a Svelte writable store, backing up to local storage across multiple tabs

Downloads

3

Readme

Svelte Local Storage Store

A thin wrapper on top of a Svelte writable store, backing up to local storage with built-in event handling to sync across multiple tabs.

Installation

npm install -D @onsetsoftware/svelte-local-storage-store

Usage

Basic

import { localStorageStore } from '@onsetsoftware/svelte-local-storage-store';

const countStore = localStorageStore('count', 0);

Async

import { localStorageStore } from '@onsetsoftware/svelte-local-storage-store';

const timerStore = localStorageStore('timer', 0, (set) => {
  let timer = timerStore.get();
  const interval = setInterval(() => {
    set(++timer);
  }, 1000);

  return () => clearInterval(interval);
});

API

The localStorageStore function takes three arguments:

  • key - The key to use for local storage
  • initialValue - The initial value to use if the key is not found in local storage
  • start - An optional function that will be called when the store is first subscribed to. It will be passed a set function that can be used to update the store. It should return a function that will be called when the store is unsubscribed from.

This is essentially the same API as the writable function from Svelte's svelte/store package, with the addition of the key argument.

Note Subsequent calls to localStorageStore with the same key will return the same store instance. If you want to delete the store from local storage, you can call destroyLocalStorageStore(key).

If this cache doesn't work for you, please can use the LocalStorageStore class directly to manage your own stores. It takes the same 3 arguments as the localStorageStore function.

The localStorageStore function returns a Svelte store that can be used in the same way as any other Svelte store and which implements the Writable interface.

const countStore = localStorageStore('count', 0);

countStore.set(1);

countStore.update((count) => count + 1);

countStore.subscribe((value) => {
  console.log(value);
});

It also exposes an additional get method that can be used to retrieve the current value of the store without subscribing to it.

const countStore = localStorageStore('count', 0);

countStore.get(); // => 0

Finally, it exposes a detach method that can be used to remove the key/value pair from local storage.

const countStore = localStorageStore('count', 0);
// localStorage.getItem('count') => 0

countStore.detach();
// localStorage.getItem('count') => undefined