Schema Validation

Validate cookie values with Standard Schema

Schema Validation

Cookies supports Standard Schema for runtime validation. This works with Zod, Valibot, ArkType, and any other Standard Schema compatible library.

Defining a Schema

Pass a schema in the options object:

import { createCookie } from "@jlnstack/cookies/next"
import { z } from "zod"

const userPrefs = createCookie("user-prefs", {
  schema: z.object({
    theme: z.enum(["light", "dark"]),
    notifications: z.boolean()
  })
})

Reading with Validation

When reading, if the cookie value doesn't match the schema, undefined is returned:

const prefs = await userPrefs.get()
// prefs: { theme: "light" | "dark"; notifications: boolean } | undefined

Writing with Validation

When writing, if the value doesn't match the schema, an error is thrown:

await userPrefs.set({ theme: "dark", notifications: true })

// This throws an error
await userPrefs.set({ theme: "invalid" })

Using with Valibot

import { createCookie } from "@jlnstack/cookies/next"
import * as v from "valibot"

const settings = createCookie("settings", {
  schema: v.object({
    fontSize: v.number(),
    compact: v.boolean()
  })
})

Using with ArkType

import { createCookie } from "@jlnstack/cookies/next"
import { type } from "arktype"

const config = createCookie("config", {
  schema: type({
    apiVersion: "string",
    debug: "boolean"
  })
})

Groups

Batch operations on related cookies

Custom Serializer

Use a custom serializer for cookie values

On this page

Schema Validation Defining a Schema Reading with Validation Writing with Validation Using with Valibot Using with ArkType