# ultrastorage

> Gives localStorage superpowers: rich values, expiration, namespaces, schema validation, and subscriptions.

## Docs

- [ultrastorage](https://ultrastorage.dev/): Gives localStorage superpowers: rich values, expiration, namespaces, validation, and subscriptions.
- [Getting started](https://ultrastorage.dev/getting-started): Install ultrastorage, create a shared instance, and choose the right entry point.
- [Development](https://ultrastorage.dev/contributing): Run checks, build the package, and maintain the Blume documentation website.

## Guides

- [Reading and writing values](https://ultrastorage.dev/guides/values): Store rich JavaScript values, add TypeScript types, and initialize or update entries.
- [Expiration](https://ultrastorage.dev/guides/expiration): Set a TTL or an absolute expiration time and understand lazy cleanup.
- [Namespaces](https://ultrastorage.dev/guides/namespaces): Isolate storage keys with prefixes and configurable separators.
- [Subscriptions](https://ultrastorage.dev/guides/subscriptions): React to key changes within a page, across instances, and in other browser tabs.
- [Schema validation](https://ultrastorage.dev/guides/validation): Validate and transform stored values with a synchronous Standard Schema.
- [Backends and serializers](https://ultrastorage.dev/guides/backends): Use localStorage, sessionStorage, memory, or a custom serializer through the core entry point.

## React

- [React](https://ultrastorage.dev/react): Consume storage and respond to changes with useStorage and createStorageHook.
- [Schemas and types](https://ultrastorage.dev/react/schemas): Infer hook values from defaults or Standard Schema output and validate persisted data.
- [Snapshots and expiration](https://ultrastorage.dev/react/snapshots): Keep React values stable and update rich objects without render-time storage mutations.
- [Server rendering and errors](https://ultrastorage.dev/react/server-rendering): Render matching server defaults, hydrate persisted values, and handle storage failures.

## Reference

- [Storage API](https://ultrastorage.dev/reference/storage): Factory options, typed reads, writes, expiration, subscriptions, and Storage-compatible methods.
- [Caveats and migration](https://ultrastorage.dev/reference/caveats): Understand storage limits, synchronization boundaries, invalid data, and migration behavior.
- [How it works](https://ultrastorage.dev/reference/how-it-works): Understand the stored envelope, serialization, namespaces, and lazy expiration.
- [Related libraries](https://ultrastorage.dev/reference/alternatives): Other JavaScript storage libraries to explore.

## Agent resources

- [llms-full.txt](https://ultrastorage.dev/llms-full.txt): The full Markdown of every page in one file.
- [Page Markdown](https://ultrastorage.dev/index.md): Append `.md` to any page URL to fetch that page as raw Markdown.
- [JSON API](https://ultrastorage.dev/api/docs/pages.json): Page index of the JSON docs API; each entry links the page's JSON and Markdown forms. Described by the OpenAPI document at https://ultrastorage.dev/openapi.json.
- [API catalog](https://ultrastorage.dev/.well-known/api-catalog): RFC 9727 linkset of the APIs documented here.
- [agent-readability.json](https://ultrastorage.dev/agent-readability.json): Manifest of every agent-facing artifact on this site.
- [Sitemap](https://ultrastorage.dev/sitemap.xml): Every indexable page URL with its last-modified date.