Adapter Contract

Built-in adapter factoriesCopy Anchor Link

function createLocalStorageAdapter(
  options?: StorageAdapterOptions,
): NusmAdapter;

function createSessionStorageAdapter(
  options?: StorageAdapterOptions,
): NusmAdapter;

function createIndexDbAdapter(options?: IndexDbAdapterOptions): NusmAdapter;

NusmAdapterCopy Anchor Link

AdapterEventCopy Anchor Link

type AdapterEventType = "set" | "remove" | "clear";

Provide a key for set and remove. An adapter-wide clear can omit it.

subscribe represents external adapter changes. nusm attaches it whenever the adapter provides it. Authenticated browser synchronization is configured independently through sync and does not replace adapter subscriptions. Because built-in Web Storage adapters subscribe to browser events, persisted stores also require a shape-specific sync.validator even without a browser synchronization source. The validator protects memory from adapter-originated external values as well as authenticated peer updates.

NusmPacerConfigCopy Anchor Link

type NusmPacerConfig =
  | false
  | {
      wait?: number;
      maxWait?: number;
      leading?: boolean;
      trailing?: boolean;
    };

false bypasses the debouncer. The current runtime forwards wait, leading, and trailing to the AsyncDebouncer; maxWait remains in the public type but is not forwarded yet.

StorageAdapterOptionsCopy Anchor Link

Used by createLocalStorageAdapter and createSessionStorageAdapter:

StorageLikeCopy Anchor Link

key and length enable getAllKeys; clear enables adapter clearing.

IndexDbAdapterOptionsCopy Anchor Link

See Custom Adapters for implementation guidance and invariants.