Basic Utilities

synced

Creates a writable store that automatically synchronizes its value with localStorage.

const myStore = synced('storage-key', 'default value');

getter

Creates a function that returns the current value of a store without subscribing to it.

const myStore = writable('value');
const getValue = getter(myStore);

withGetter

Enhances a store by adding a getter method to access its current value.

const myStore = withGetter(writable('value'));
console.log(myStore.get()); // 'value'

throttled

Creates a store that limits how often subscribers receive updates.

const throttledStore = throttled(1000, myStore); // Updates at most once per second

custom

Creates a custom store with optional throttling and custom set behavior.

const customStore = custom(
  set => {
    // Setup logic
    return () => {
      // Cleanup logic
    };
  },
  { throttle: 1000 }
);

adapter

Creates a derived store that can transform values between two types while maintaining two-way binding.

const adaptedStore = adapter({
  store: originalStore,
  forward: (source) => /* transform to target */,
  backward: (target) => /* transform back to source */
});

This is particularly useful when you need to transform data structures while maintaining the ability to update the original store.

1.4 KiB Raw Blame History