Theo's Typesafe CultTTC
Theo's Typesafe Cult•3y ago
Lancear

Should zod schema names start with an uppercase letter or not?

What is the general guideline for naming zod schemas. In the docs there seem to be examples using capitalized names as well as lowercase names, thus I was wondering what naming convention the community decided upon.

This example uses lowecase 
userSchema
:
import { z } from "zod";

// creating a schema for strings
const mySchema = z.string();

// parsing
mySchema.parse("tuna"); // => "tuna"
mySchema.parse(12); // => throws ZodError

// "safe" parsing (doesn't throw error if validation fails)
mySchema.safeParse("tuna"); // => { success: true; data: "tuna" }
mySchema.safeParse(12); // => { success: false; error: ZodError }


Whereas this one uses uppercase 
User
:
import { z } from "zod";

const User = z.object({
  username: z.string(),
});

User.parse({ username: "Ludwig" });

// extract the inferred type
type User = z.infer<typeof User>;
// { username: string }
Was this page helpful?