Zod•8mo ago

ramblings - Is there a way to make one field re...

Is there a way to make one field readonly instead of the entire schema? After I parse a data with the schema, I don't want to allow changing the ID.

5 Replies

Scott Trinh•8mo ago

You can make an intersection with a readonly object that just contains the id and a separate object that contains all of the other properties, I think. Although, in practice, I think readonly is fine since it's rare that consumers of data mutate the data directly rather than copying, but there are certainly use cases for direct mutation.

Scott Trinh•8mo ago

https://www.typescriptlang.org/play?#code/JYWwDg9gTgLgBAbzgLzgXzgMyhEcBEyEAJvgNwBQFAxhAHYDO8ASgKZNwC8KAdBAEYArVtRgAKBBTjS4dAIYhWALl5MowOgHMxASgA0FNDso16HAJLEuvAcNESpM4MRXIeajdp18wMYPTkAG11DbyhWOWJ6QIBPXRNaRngAZWoAC1YQOWs3DRhWKAYRP3oxNiY9OEtjKmIRQLlwuESOYjkYOVc+AFcYMF6AHhgYsFYITDhUjKyAPkoAenmZZZWAPQB+Wva5HnlFa3x+VlYwcgpFmQ2tjp5nA-4ICFOFpekNoA

TS Playground - An online editor for exploring TypeScript and JavaS...

The Playground lets you write TypeScript or JavaScript online in a safe and sharable way.

Scott Trinh•8mo ago

import { z } from "zod";

const Rest = z.object({
    name: z.string(),
});

const Id = z.object({
    id: z.string().optional()
}).readonly();

const Schema = z.intersection(Rest, Id);

declare const data: z.output<typeof Schema>;
//            ^?{ name: string; } & Readonly<{ id?: string | undefind }>;

data.name = "beep";

// Error:
data.id = "boop";

import { z } from "zod";

const Rest = z.object({
    name: z.string(),
});

const Id = z.object({
    id: z.string().optional()
}).readonly();

const Schema = z.intersection(Rest, Id);

declare const data: z.output<typeof Schema>;
//            ^?{ name: string; } & Readonly<{ id?: string | undefind }>;

data.name = "beep";

// Error:
data.id = "boop";

ramblings•8mo ago

z.intersection schemas loses utilities such as Pick and Omit. I tried doing Rest.merge(Id) but merge can't take ZodReadOnly objects. Thank you for your help though, I just wanted extra type safety but I can live without it.

Scott Trinh•8mo ago

Yeah, if it was me, I'd just throw readonly on the whole object and fix any mutations-in-place with more idiomatic copies or override the defintion with a big comment justifying why i was doing it.

Gaming

Programming

ramblings - Is there a way to make one field re...