Hi, I love this library, it's perfect for the project I'm currently working on. I come

Is it possible to add default values? about zod HOT 2 CLOSED

colinhacks commented on August 20, 2024 1

Is it possible to add default values?

from zod.

Comments (2)

colinhacks commented on August 20, 2024 1

I don't want to do this at the moment, since it would mark a subtle shift from being a "parse" tool into a "cast" tool. Casting gets messy quickly what with default values, required/non-required keys, recursive/cyclical types, primitive castings, etc. I always found yup/joi casting difficult to reason about.

I'd recommend building your own a default-setting + validation "pipeline" by combining Zod with something like lodash. You can use_.defaultsDeep() to set defaults on an unvalidated object, like so:

import * as _ from 'lodash';
import * as z from "zod";

const dogDefaults = {
  breed: "Unknown"
}

const Dog = z.object({
  breed: z.string(),
  age: z.number()
});
type Dog = z.TypeOf<typeof Dog>;

const unknownDog: any = { /* whatever */ };

const cleanAndValidate = (rawData: unknown)=>{
  return Dog.parse(_.defaultsDeep(unknownDog, dogDefaults)); 
}

const validDog = cleanAndValidate(unknownDog); 
// typeof validDog => Dog

from zod.

tuchk4 commented on August 20, 2024

I would like to push defaults feature into the zod.

zod is really nice tool, but it is hard to use it without the default values.

For example:

There is the schema:

const LibrarySchema = z.object({
  namespace: z.string().optional(),
  components: z.record(
    z.object({
      names: z.string(),
    }),
  ).optional(),
});

type ILibrarySchema = z.infer<typeof LibrarySchema>;

ILibrarySchema equals to:

type ILibrarySchema = {
    namespace?: string | undefined;
    components?: Record<string, {
        names: string;
    }> | undefined;
}

so all fields are optional, as expected.

Then I would like to fill schema with the default values

const parsed = LibrarySchema.parse(raw);
const config = withDefaults(parser);

Here is the problem. I can't correctly write the type for withDefaults function.

const withDefaults = (config:ILibrarySchema): ???  => { ... };

It is not possible to return ILibrarySchema since it has optional fields, but I would like to return config with the default values, which means, that some fields should not be optional.

I expect defaults to be:

const LibrarySchema = z.object({
  namespace: z.string().optional().default('_'),
  components: z.record(
    z.object({
      names: z.string(),
    }),
  ).optional().default({}),
});

type ILibrarySchema = z.infer<typeof LibrarySchema>;

ILibrarySchema to be:

type ILibrarySchema = {
    namespace: string
    components: Record<string, {
        names: string;
    }>;
}

cc @vriad

from zod.

Recommend Projects

Is it possible to add default values? about zod HOT 2 CLOSED

Comments (2)

Related Issues (20)

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent