@typed-storage/core

Highlights

• Schema validation
• Automatic type inference
• Use it with zod, validbot, arktype, etc.

Overview

TypedStorage gives you a type-safe way to access localStorage. Moreover, you can use zod or any other schema validation library to make sure your data is always valid.

Author

Hey, I'm Nils. In my spare time I write about things I learned or I create open source packages, that help me (and hopefully you) to build better apps.

Usage

Two steps: define your schema and use it like normal localStorage.

1. Define your schema

// schema.ts

import { defineStorage } from "@typed-storage/core"
// Feel free to use any other StandardSchema compatible library
import { z } from "zod"

const { storage } = defineStorage({
  theme: z.enum(["light", "dark"]),
})

export { storage }

2. Use the storage

// my-file.ts

import { storage } from "./schema"

storage.set("theme", "light")

const theme = storage.get("theme")

Installation

You can install this package with any package manager you like.

pnpm add @typed-storage/core

Feedback and Contributing

I highly appreceate your feedback! Please create an issue, if you've found any bugs or want to request a feature.