Possible Incomplete Records Example?

[antontolken]

i'm learning about zod, and looking at this example it feels like there may be something missing? for example what is UserStore, and / or where is zod actually used in this example?

const userStore: UserStore = {};

userStore["77d2586b-9e8e-4ecf-8b21-ea7e0530eadd"] = {
  name: "Carlotta",
}; // passes

userStore["77d2586b-9e8e-4ecf-8b21-ea7e0530eadd"] = {
  whatever: "Ice cream sundae",
}; // TypeError

related docs link: https://zod.dev/?id=records

[JacobWeisenburger]

Records

You are correct that this example is not very good. Feel free to submit a PR to improve it. Thanks.

[antontolken]

Thanks for the confirmation.

There is one small issue: since I am learning about zod, I am unsure of what the above example should be.

If I do figure it out then I'm happy to make a PR.

[JacobWeisenburger]

It probably should look something like this

const userSchema = z.object( { name: z.string() } )
const userStoreSchema = z.record( userSchema )

type UserStore = z.infer<typeof userStoreSchema>
// type UserStore = { [ x: string ]: { name: string } }

const userStore: UserStore = {}

userStore[ '77d2586b-9e8e-4ecf-8b21-ea7e0530eadd' ] = {
    name: 'Carlotta',
}
console.log( userStoreSchema.safeParse( userStore ).success ) // true

userStore[ '77d2586b-9e8e-4ecf-8b21-ea7e0530eadd' ] = {
    whatever: 'Ice cream sundae',
}
console.log( userStoreSchema.safeParse( userStore ).success ) // false

[messenjer]

Here is the PR : #2579